- All Implemented Interfaces:
Behavior
,ClientBehavior
,PartialStateHolder
,StateHolder
<f:ajax>
which is retargeted by <cc:clientBehavior>
in AjaxHandler
and checked in AjaxBehaviorRenderer
.
We should probably introduce AjaxBehaviorWrapper
in Faces.next to reduce boilerplate like this.
- https://github.com/jakartaee/faces/issues/1567
- https://github.com/eclipse-ee4j/mojarra/issues/5032-
Field Summary
Fields inherited from class jakarta.faces.component.behavior.AjaxBehavior
BEHAVIOR_ID
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAjaxBehaviorListener
(AjaxBehaviorListener listener) Add the specifiedAjaxBehaviorListener
to the set of listeners registered to receive event notifications from thisAjaxBehavior
.void
broadcast
(BehaviorEvent event) Default implementation ofBehavior.broadcast(jakarta.faces.event.BehaviorEvent)
.void
Clears the initial state flag, causing the behavior to revert from partial to full state saving.void
decode
(FacesContext context, UIComponent component) Default implementation of ofClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
.boolean
getDelay()
Returns the delay value, ornull
if no value was set.Return a non-emptyCollection<String>
of component identifiers that will be used to identify components that should be processed during theexecute
phase of the request processing lifecycle.getHints()
Return theString
of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.Return theString
of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event.Return a non-emptyCollection<String>
of component identifiers that will be used to identify components that should be processed during therender
phase of the request processing lifecycle.Returns the renderer type of theClientBehaviorRenderer
to use for the behavior.getScript
(ClientBehaviorContext behaviorContext) Default implementation of ofClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext)
.getValueExpression
(String name) Returns theValueExpression
used to calculate the value for the specified property name, if any.int
hashCode()
boolean
Implementation ofPartialStateHolder.initialStateMarked()
.boolean
Return the disabled status of this behavior.boolean
Return the immediate status of this behavior.boolean
Tests whether the immediate attribute is specified.boolean
Return the resetValues status of this behavior.boolean
Tests whether the resetValues attribute is specified.boolean
Implementation ofStateHolder.isTransient()
.void
Implementation ofPartialStateHolder.markInitialState()
.void
Remove the specifiedAjaxBehaviorListener
from the set of listeners registered to receive event notifications from thisAjaxBehavior
.void
restoreState
(FacesContext context, Object state) saveState
(FacesContext context) Implementation ofStateHolder.saveState(jakarta.faces.context.FacesContext)
.void
If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded.void
setDisabled
(boolean disabled) Sets the disabled status of this behavior.void
setExecute
(Collection<String> execute) Sets the component identifiers that will be used to identify components that should be processed during theexecute
phase of the request processing lifecycle.void
setImmediate
(boolean immediate) Sets the immediate status of this behavior.void
setOnerror
(String onerror) Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.void
setOnevent
(String onevent) Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.void
setRender
(Collection<String> render) Sets the component identifiers that will be used to identify components that should be processed during therender
phase of the request processing lifecycle.void
setResetValues
(boolean resetValues) Set the resetValues status of this behavior.void
setTransient
(boolean transientFlag) Implementation ofStateHolder.setTransient(boolean)
.void
setValueExpression
(String name, ValueExpression binding) Sets theValueExpression
used to calculate the value for the specified property name.toString()
Methods inherited from class jakarta.faces.component.behavior.ClientBehaviorBase
getRenderer
Methods inherited from class jakarta.faces.component.behavior.BehaviorBase
addBehaviorListener, removeBehaviorListener
-
Constructor Details
-
RetargetedAjaxBehavior
-
-
Method Details
-
getScript
Description copied from class:ClientBehaviorBase
Default implementation of of
ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext)
. If aClientBehaviorRenderer
is available for the specified behavior renderer type, this method delegates to theClientBehaviorRenderer.getScript(jakarta.faces.component.behavior.ClientBehaviorContext, jakarta.faces.component.behavior.ClientBehavior)
method. Otherwise, this method returns null.- Specified by:
getScript
in interfaceClientBehavior
- Overrides:
getScript
in classClientBehaviorBase
- Parameters:
behaviorContext
- theClientBehaviorContext
- Returns:
- the script provided by the associated ClientBehaviorRenderer, or null if no ClientBehaviorRenderer is available.
-
broadcast
Description copied from class:BehaviorBase
Default implementation of
Behavior.broadcast(jakarta.faces.event.BehaviorEvent)
. Delivers the specifiedBehaviorEvent
to all registeredBehaviorListener
event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were registered (added).- Specified by:
broadcast
in interfaceBehavior
- Overrides:
broadcast
in classBehaviorBase
- Parameters:
event
- TheBehaviorEvent
to be broadcast- Throws:
AbortProcessingException
- Signal the Jakarta Faces implementation that no further processing on the current event should be performed
-
hashCode
-
getRendererType
Description copied from class:ClientBehaviorBase
Returns the renderer type of the
ClientBehaviorRenderer
to use for the behavior. The default implementation returns null. Subclasses should either override this method to return a string that identifies the type ofClientBehaviorRenderer
to use, or should overrideClientBehaviorBase.getScript(jakarta.faces.component.behavior.ClientBehaviorContext)
and perform script rendering locally in theClientBehavior
implementation.- Overrides:
getRendererType
in classAjaxBehavior
- Returns:
- the default renderer type, which is null.
-
decode
Description copied from class:ClientBehaviorBase
Default implementation of of
ClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
. If aClientBehaviorRenderer
is available for the specified behavior renderer type, this method delegates to the ClientBehaviorRenderer's decode() method. Otherwise, no decoding is performed.- Specified by:
decode
in interfaceClientBehavior
- Overrides:
decode
in classClientBehaviorBase
- Parameters:
context
-FacesContext
for the request we are processingcomponent
-UIComponent
the component associated with thisClientBehavior
-
isTransient
public boolean isTransient()Description copied from class:BehaviorBase
Implementation of
StateHolder.isTransient()
.- Specified by:
isTransient
in interfaceStateHolder
- Overrides:
isTransient
in classBehaviorBase
- Returns:
true
if transient,false
otherwise.
-
getHints
Description copied from class:AjaxBehavior
This method returns an unmodifiable
Set
containing theClientBehaviorHint
SUBMITTING
.- Specified by:
getHints
in interfaceClientBehavior
- Overrides:
getHints
in classAjaxBehavior
- Returns:
- unmodifiable set containing the hint
ClientBehaviorHint
SUBMITTING
.
-
setTransient
public void setTransient(boolean transientFlag) Description copied from class:BehaviorBase
Implementation of
StateHolder.setTransient(boolean)
.- Specified by:
setTransient
in interfaceStateHolder
- Overrides:
setTransient
in classBehaviorBase
- Parameters:
transientFlag
- boolean passtrue
if this Object will not participate in state saving or restoring, otherwise passfalse
.
-
getOnerror
Description copied from class:AjaxBehavior
Return the
String
of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.- Overrides:
getOnerror
in classAjaxBehavior
- Returns:
- the JavaScript function name of
ONERROR
.
-
setOnerror
Description copied from class:AjaxBehavior
Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.
- Overrides:
setOnerror
in classAjaxBehavior
- Parameters:
onerror
- the error handling function name
-
equals
-
getOnevent
Description copied from class:AjaxBehavior
Return the
String
of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event.- Overrides:
getOnevent
in classAjaxBehavior
- Returns:
- the JavaScript function name of
ONEVENT
.
-
setOnevent
Description copied from class:AjaxBehavior
Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.
- Overrides:
setOnevent
in classAjaxBehavior
- Parameters:
onevent
- the event handling function name
-
markInitialState
public void markInitialState()Description copied from class:BehaviorBase
Implementation of
PartialStateHolder.markInitialState()
.- Specified by:
markInitialState
in interfacePartialStateHolder
- Overrides:
markInitialState
in classBehaviorBase
-
initialStateMarked
public boolean initialStateMarked()Description copied from class:BehaviorBase
Implementation of
PartialStateHolder.initialStateMarked()
.- Specified by:
initialStateMarked
in interfacePartialStateHolder
- Overrides:
initialStateMarked
in classBehaviorBase
- Returns:
true
if the initial state is marked,false
otherwise.
-
getExecute
Description copied from class:AjaxBehavior
Return a non-empty
Collection<String>
of component identifiers that will be used to identify components that should be processed during theexecute
phase of the request processing lifecycle.Note that the returned collection may be unmodifiable. Modifications should be performed by calling
AjaxBehavior.setExecute(java.util.Collection<java.lang.String>)
.- Overrides:
getExecute
in classAjaxBehavior
- Returns:
- the JavaScript function name of
EXECUTE
.
-
clearInitialState
public void clearInitialState()Description copied from class:BehaviorBase
Clears the initial state flag, causing the behavior to revert from partial to full state saving.
- Specified by:
clearInitialState
in interfacePartialStateHolder
- Overrides:
clearInitialState
in classBehaviorBase
-
setExecute
Description copied from class:AjaxBehavior
Sets the component identifiers that will be used to identify components that should be processed during the
execute
phase of the request processing lifecycle.- Overrides:
setExecute
in classAjaxBehavior
- Parameters:
execute
- the ids of components to execute
-
getDelay
Description copied from class:AjaxBehavior
Returns the delay value, or
null
if no value was set.- Overrides:
getDelay
in classAjaxBehavior
- Returns:
- the delay value.
-
setDelay
Description copied from class:AjaxBehavior
If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. The default value of this option is 300. If the value of delay is the literal string
'none'
without the quotes, no delay is used.- Overrides:
setDelay
in classAjaxBehavior
- Parameters:
delay
- the ajax delay value
-
getRender
Description copied from class:AjaxBehavior
Return a non-empty
Collection<String>
of component identifiers that will be used to identify components that should be processed during therender
phase of the request processing lifecycle.Note that the returned collection may be unmodifiable. Modifications should be performed by calling
AjaxBehavior.setRender(java.util.Collection<java.lang.String>)
.- Overrides:
getRender
in classAjaxBehavior
- Returns:
- the ids of components to render.
-
setRender
Description copied from class:AjaxBehavior
Sets the component identifiers that will be used to identify components that should be processed during the
render
phase of the request processing lifecycle.- Overrides:
setRender
in classAjaxBehavior
- Parameters:
render
- the ids of components to render
-
isResetValues
public boolean isResetValues()Description copied from class:AjaxBehavior
Return the resetValues status of this behavior.
- Overrides:
isResetValues
in classAjaxBehavior
- Returns:
- the resetValues status.
-
setResetValues
public void setResetValues(boolean resetValues) Description copied from class:AjaxBehavior
Set the resetValues status of this behavior.
- Overrides:
setResetValues
in classAjaxBehavior
- Parameters:
resetValues
- the resetValues status.
-
isDisabled
public boolean isDisabled()Description copied from class:AjaxBehavior
Return the disabled status of this behavior.
- Overrides:
isDisabled
in classAjaxBehavior
- Returns:
- the disabled status of this behavior.
-
setDisabled
public void setDisabled(boolean disabled) Description copied from class:AjaxBehavior
Sets the disabled status of this behavior.
- Overrides:
setDisabled
in classAjaxBehavior
- Parameters:
disabled
- the flag to be set.
-
isImmediate
public boolean isImmediate()Description copied from class:AjaxBehavior
Return the immediate status of this behavior.
- Overrides:
isImmediate
in classAjaxBehavior
- Returns:
- the immediate status.
-
setImmediate
public void setImmediate(boolean immediate) Description copied from class:AjaxBehavior
Sets the immediate status of this behavior.
- Overrides:
setImmediate
in classAjaxBehavior
- Parameters:
immediate
- the flag to be set.
-
isImmediateSet
public boolean isImmediateSet()Description copied from class:AjaxBehavior
Tests whether the immediate attribute is specified. Returns true if the immediate attribute is specified, either as a locally set property or as a value expression. This information allows an associated client behavior renderer to fall back on the parent component's immediate status when immediate is not explicitly specified on the
AjaxBehavior
.- Overrides:
isImmediateSet
in classAjaxBehavior
- Returns:
- the flag whether the immediate attribute is specified.
-
toString
-
isResetValuesSet
public boolean isResetValuesSet()Description copied from class:AjaxBehavior
Tests whether the resetValues attribute is specified. Returns true if the resetValues attribute is specified, either as a locally set property or as a value expression.
- Overrides:
isResetValuesSet
in classAjaxBehavior
- Returns:
- the flag whether the resetValues attribute is specified.
-
getValueExpression
Description copied from class:AjaxBehavior
Returns the
ValueExpression
used to calculate the value for the specified property name, if any.- Overrides:
getValueExpression
in classAjaxBehavior
- Parameters:
name
- Name of the property for which to retrieve aValueExpression
- Returns:
- the
ValueExpression
.
-
setValueExpression
Description copied from class:AjaxBehavior
Sets the
ValueExpression
used to calculate the value for the specified property name.- Overrides:
setValueExpression
in classAjaxBehavior
- Parameters:
name
- Name of the property for which to set aValueExpression
binding
- TheValueExpression
to set, ornull
to remove any currently setValueExpression
-
addAjaxBehaviorListener
Description copied from class:AjaxBehavior
Add the specified
AjaxBehaviorListener
to the set of listeners registered to receive event notifications from thisAjaxBehavior
.- Overrides:
addAjaxBehaviorListener
in classAjaxBehavior
- Parameters:
listener
- TheAjaxBehaviorListener
to be registered
-
removeAjaxBehaviorListener
Description copied from class:AjaxBehavior
Remove the specified
AjaxBehaviorListener
from the set of listeners registered to receive event notifications from thisAjaxBehavior
.- Overrides:
removeAjaxBehaviorListener
in classAjaxBehavior
- Parameters:
listener
- TheAjaxBehaviorListener
to be removed
-
saveState
Description copied from class:BehaviorBase
Implementation of
StateHolder.saveState(jakarta.faces.context.FacesContext)
.- Specified by:
saveState
in interfaceStateHolder
- Overrides:
saveState
in classAjaxBehavior
- Parameters:
context
- the Faces context.- Returns:
- the saved state.
-
restoreState
Description copied from class:BehaviorBase
- Specified by:
restoreState
in interfaceStateHolder
- Overrides:
restoreState
in classAjaxBehavior
- Parameters:
context
- the Faces context.state
- the state.
-