public Class RetargetedAjaxBehavior

Overrides jakarta.faces.component.behavior.AjaxBehavior.addAjaxBehaviorListener.

Doc from jakarta.faces.component.behavior.AjaxBehavior.addAjaxBehaviorListener.

Add the specified AjaxBehaviorListener to the set of listeners registered to receive event notifications from this AjaxBehavior.

Parameters

listener:AjaxBehaviorListener

The AjaxBehaviorListener to be registered

Annotations

@Override

Overrides jakarta.faces.component.behavior.BehaviorBase.broadcast.

Implements jakarta.faces.component.behavior.Behavior.broadcast.

Doc from jakarta.faces.component.behavior.Behavior.broadcast.

Broadcast the specified BehaviorEvent to all registered event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were added.

Parameters

event:BehaviorEvent

The BehaviorEvent to be broadcast

Annotations

@Override

Exceptions

AbortProcessingException:

Signal the Jakarta Faces implementation that no further processing on the current event should be performed

Overrides jakarta.faces.component.behavior.BehaviorBase.clearInitialState.

Implements jakarta.faces.component.PartialStateHolder.clearInitialState.

Doc from jakarta.faces.component.behavior.BehaviorBase.clearInitialState.

Clears the initial state flag, causing the behavior to revert from partial to full state saving.

Annotations

@Override

Overrides jakarta.faces.component.behavior.ClientBehaviorBase.decode.

Implements jakarta.faces.component.behavior.ClientBehavior.decode.

Doc from jakarta.faces.component.behavior.ClientBehaviorBase.decode.

Default implementation of of ClientBehavior#decode. If a ClientBehaviorRenderer is available for the specified behavior renderer type, this method delegates to the ClientBehaviorRenderer's decode() method. Otherwise, no decoding is performed.

Parameters

context:FacesContext

FacesContext for the request we are processing

component:UIComponent

UIComponent the component associated with this ClientBehavior

Annotations

@Override

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getDelay.

Doc from jakarta.faces.component.behavior.AjaxBehavior.getDelay.

Returns the delay value, or null if no value was set.

Returns:String

the delay value.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getExecute.

Doc from jakarta.faces.component.behavior.AjaxBehavior.getExecute.

Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

Note that the returned collection may be unmodifiable. Modifications should be performed by calling setExecute.

Returns:Collection<String>

the JavaScript function name of EXECUTE.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getHints.

Implements jakarta.faces.component.behavior.ClientBehavior.getHints.

Doc from jakarta.faces.component.behavior.AjaxBehavior.getHints.

This method returns an unmodifiable Set containing the ClientBehaviorHint SUBMITTING.

Returns:Set<ClientBehaviorHint>

unmodifiable set containing the hint ClientBehaviorHint SUBMITTING.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getOnerror.

Doc from jakarta.faces.component.behavior.AjaxBehavior.getOnerror.

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.

Returns:String

the JavaScript function name of ONERROR.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getOnevent.

Doc from jakarta.faces.component.behavior.AjaxBehavior.getOnevent.

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.

Returns:String

the JavaScript function name of ONEVENT.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getRender.

Doc from jakarta.faces.component.behavior.AjaxBehavior.getRender.

Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

Note that the returned collection may be unmodifiable. Modifications should be performed by calling setRender.

Returns:Collection<String>

the ids of components to render.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getRendererType.

Doc from jakarta.faces.component.behavior.ClientBehaviorBase.getRendererType.

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 of ClientBehaviorRenderer to use, or should override getScript and perform script rendering locally in the ClientBehavior implementation.

Returns:String

the default renderer type, which is null.

Annotations

@Override

Overrides jakarta.faces.component.behavior.ClientBehaviorBase.getScript.

Implements jakarta.faces.component.behavior.ClientBehavior.getScript.

Doc from jakarta.faces.component.behavior.ClientBehaviorBase.getScript.

Default implementation of of ClientBehavior#getScript. If a ClientBehaviorRenderer is available for the specified behavior renderer type, this method delegates to the ClientBehaviorRenderer#getScript method. Otherwise, this method returns null.

Parameters

behaviorContext:ClientBehaviorContext

the ClientBehaviorContext

Returns:String

the script provided by the associated ClientBehaviorRenderer, or null if no ClientBehaviorRenderer is available.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.getValueExpression.

Doc from jakarta.faces.component.behavior.AjaxBehavior.getValueExpression.

Returns the ValueExpression used to calculate the value for the specified property name, if any.

Parameters

name:String

Name of the property for which to retrieve a ValueExpression

Returns:ValueExpression

the ValueExpression.

Annotations

@Override

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Overrides jakarta.faces.component.behavior.BehaviorBase.initialStateMarked.

Implements jakarta.faces.component.PartialStateHolder.initialStateMarked.

Doc from jakarta.faces.component.behavior.BehaviorBase.initialStateMarked.

Implementation of jakarta.faces.component.PartialStateHolder#initialStateMarked.

Returns:boolean

Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked.

true if the initial state is marked, false otherwise.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.isDisabled.

Doc from jakarta.faces.component.behavior.AjaxBehavior.isDisabled.

Return the disabled status of this behavior.

Returns:boolean

the disabled status of this behavior.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.isImmediate.

Doc from jakarta.faces.component.behavior.AjaxBehavior.isImmediate.

Return the immediate status of this behavior.

Returns:boolean

the immediate status.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.isImmediateSet.

Doc from jakarta.faces.component.behavior.AjaxBehavior.isImmediateSet.

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.

Returns:boolean

the flag whether the immediate attribute is specified.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.isResetValues.

Doc from jakarta.faces.component.behavior.AjaxBehavior.isResetValues.

Return the resetValues status of this behavior.

Returns:boolean

the resetValues status.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.isResetValuesSet.

Doc from jakarta.faces.component.behavior.AjaxBehavior.isResetValuesSet.

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.

Returns:boolean

the flag whether the resetValues attribute is specified.

Annotations

@Override

Overrides jakarta.faces.component.behavior.BehaviorBase.isTransient.

Implements jakarta.faces.component.StateHolder.isTransient.

Doc from jakarta.faces.component.behavior.BehaviorBase.isTransient.

Implementation of jakarta.faces.component.StateHolder#isTransient.

Returns:boolean

Doc from jakarta.faces.component.StateHolder.isTransient.

true if transient, false otherwise.

Annotations

@Override

Overrides jakarta.faces.component.behavior.BehaviorBase.markInitialState.

Implements jakarta.faces.component.PartialStateHolder.markInitialState.

Doc from jakarta.faces.component.behavior.BehaviorBase.markInitialState.

Implementation of jakarta.faces.component.PartialStateHolder#markInitialState.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.removeAjaxBehaviorListener.

Doc from jakarta.faces.component.behavior.AjaxBehavior.removeAjaxBehaviorListener.

Remove the specified AjaxBehaviorListener from the set of listeners registered to receive event notifications from this AjaxBehavior.

Parameters

listener:AjaxBehaviorListener

The AjaxBehaviorListener to be removed

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.restoreState.

Implements jakarta.faces.component.StateHolder.restoreState.

Doc from jakarta.faces.component.behavior.BehaviorBase.restoreState.

Implementation of jakarta.faces.component.StateHolder#restoreState.

Parameters

context:FacesContext

Doc from jakarta.faces.component.StateHolder.restoreState.

the Faces context.

state:Object

Doc from jakarta.faces.component.StateHolder.restoreState.

the state.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.saveState.

Implements jakarta.faces.component.StateHolder.saveState.

Doc from jakarta.faces.component.behavior.BehaviorBase.saveState.

Implementation of jakarta.faces.component.StateHolder#saveState.

Parameters

context:FacesContext

Doc from jakarta.faces.component.StateHolder.saveState.

the Faces context.

Returns:Object

Doc from jakarta.faces.component.StateHolder.saveState.

the saved state.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setDelay.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setDelay.

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.

Parameters

delay:String

the ajax delay value

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setDisabled.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setDisabled.

Sets the disabled status of this behavior.

Parameters

disabled:boolean

the flag to be set.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setExecute.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setExecute.

Sets the component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

Parameters

execute:Collection<String>

the ids of components to execute

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setImmediate.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setImmediate.

Sets the immediate status of this behavior.

Parameters

immediate:boolean

the flag to be set.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setOnerror.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setOnerror.

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.

Parameters

onerror:String

the error handling function name

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setOnevent.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setOnevent.

Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.

Parameters

onevent:String

the event handling function name

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setRender.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setRender.

Sets the component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

Parameters

render:Collection<String>

the ids of components to render

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setResetValues.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setResetValues.

Set the resetValues status of this behavior.

Parameters

resetValues:boolean

the resetValues status.

Annotations

@Override

Overrides jakarta.faces.component.behavior.BehaviorBase.setTransient.

Implements jakarta.faces.component.StateHolder.setTransient.

Doc from jakarta.faces.component.behavior.BehaviorBase.setTransient.

Implementation of jakarta.faces.component.StateHolder#setTransient.

Parameters

transientFlag:boolean

Doc from jakarta.faces.component.StateHolder.setTransient.

boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

Annotations

@Override

Overrides jakarta.faces.component.behavior.AjaxBehavior.setValueExpression.

Doc from jakarta.faces.component.behavior.AjaxBehavior.setValueExpression.

Sets the ValueExpression used to calculate the value for the specified property name.

Parameters

name:String

Name of the property for which to set a ValueExpression

binding:ValueExpression

The ValueExpression to set, or null to remove any currently set ValueExpression

Annotations

@Override

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override