Module jakarta.faces

Package com.sun.faces.facelets.tag.composite

Class RetargetedAjaxBehavior

java.lang.Object

jakarta.faces.component.behavior.BehaviorBase

jakarta.faces.component.behavior.ClientBehaviorBase

jakarta.faces.component.behavior.AjaxBehavior

com.sun.faces.facelets.tag.composite.RetargetedAjaxBehavior

All Implemented Interfaces:

Behavior, ClientBehavior, PartialStateHolder, StateHolder

public class RetargetedAjaxBehavior
extends AjaxBehavior

Basically represents <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

Constructors

Constructor	Description
RetargetedAjaxBehavior(AjaxBehavior retargeted)

Method Summary

Modifier and Type	Method	Description
void	addAjaxBehaviorListener(AjaxBehaviorListener listener)	Add the specified AjaxBehaviorListener to the set of listeners registered to receive event notifications from this AjaxBehavior.
void	broadcast(BehaviorEvent event)	Default implementation of Behavior.broadcast(jakarta.faces.event.BehaviorEvent).
void	clearInitialState()	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 of ClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
boolean	equals(Object obj)
String	getDelay()	Returns the delay value, or null if no value was set.
Collection<String>	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.
Set<ClientBehaviorHint>	getHints()	This method returns an unmodifiable Set containing the ClientBehaviorHint SUBMITTING.
String	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.
String	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.
Collection<String>	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.
String	getRendererType()	Returns the renderer type of the ClientBehaviorRenderer to use for the behavior.
String	getScript(ClientBehaviorContext behaviorContext)	Default implementation of of ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext).
ValueExpression	getValueExpression(String name)	Returns the ValueExpression used to calculate the value for the specified property name, if any.
int	hashCode()
boolean	initialStateMarked()	Implementation of PartialStateHolder.initialStateMarked().
boolean	isDisabled()	Return the disabled status of this behavior.
boolean	isImmediate()	Return the immediate status of this behavior.
boolean	isImmediateSet()	Tests whether the immediate attribute is specified.
boolean	isResetValues()	Return the resetValues status of this behavior.
boolean	isResetValuesSet()	Tests whether the resetValues attribute is specified.
boolean	isTransient()	Implementation of StateHolder.isTransient().
void	markInitialState()	Implementation of PartialStateHolder.markInitialState().
void	removeAjaxBehaviorListener(AjaxBehaviorListener listener)	Remove the specified AjaxBehaviorListener from the set of listeners registered to receive event notifications from this AjaxBehavior.
void	restoreState(FacesContext context, Object state)	Implementation of StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object).
Object	saveState(FacesContext context)	Implementation of StateHolder.saveState(jakarta.faces.context.FacesContext).
void	setDelay(String delay)	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 the execute 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 the render phase of the request processing lifecycle.
void	setResetValues(boolean resetValues)	Set the resetValues status of this behavior.
void	setTransient(boolean transientFlag)	Implementation of StateHolder.setTransient(boolean).
void	setValueExpression(String name, ValueExpression binding)	Sets the ValueExpression used to calculate the value for the specified property name.
String	toString()

Methods inherited from class jakarta.faces.component.behavior.ClientBehaviorBase

getRenderer

Methods inherited from class jakarta.faces.component.behavior.BehaviorBase

addBehaviorListener, removeBehaviorListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetargetedAjaxBehavior

public RetargetedAjaxBehavior(AjaxBehavior retargeted)

Method Details

getScript

public String getScript(ClientBehaviorContext behaviorContext)

Description copied from class: ClientBehaviorBase

Default implementation of of ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext). If a ClientBehaviorRenderer is available for the specified behavior renderer type, this method delegates to the ClientBehaviorRenderer.getScript(jakarta.faces.component.behavior.ClientBehaviorContext, jakarta.faces.component.behavior.ClientBehavior) method. Otherwise, this method returns null.

Specified by:

getScript in interface ClientBehavior

Overrides:

getScript in class ClientBehaviorBase

Parameters:

behaviorContext - the ClientBehaviorContext

Returns:

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

broadcast

public void broadcast(BehaviorEvent event)
               throws AbortProcessingException

Description copied from class: BehaviorBase

Default implementation of Behavior.broadcast(jakarta.faces.event.BehaviorEvent). Delivers the specified BehaviorEvent to all registered BehaviorListener 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 interface Behavior

Overrides:

broadcast in class BehaviorBase

Parameters:

event - The BehaviorEvent to be broadcast

Throws:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRendererType

public String 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 of ClientBehaviorRenderer to use, or should override ClientBehaviorBase.getScript(jakarta.faces.component.behavior.ClientBehaviorContext) and perform script rendering locally in the ClientBehavior implementation.

Overrides:

getRendererType in class AjaxBehavior

Returns:

the default renderer type, which is null.

decode

public void decode(FacesContext context,
 UIComponent component)

Description copied from class: ClientBehaviorBase

Default implementation of of ClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent). 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.

Specified by:

decode in interface ClientBehavior

Overrides:

decode in class ClientBehaviorBase

Parameters:

context - FacesContext for the request we are processing

component - UIComponent the component associated with this ClientBehavior

isTransient

public boolean isTransient()

Description copied from class: BehaviorBase

Implementation of StateHolder.isTransient().

Specified by:

isTransient in interface StateHolder

Overrides:

isTransient in class BehaviorBase

Returns:

true if transient, false otherwise.

getHints

public Set<ClientBehaviorHint> getHints()

Description copied from class: AjaxBehavior

This method returns an unmodifiable Set containing the ClientBehaviorHint SUBMITTING.

Specified by:

getHints in interface ClientBehavior

Overrides:

getHints in class AjaxBehavior

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 interface StateHolder

Overrides:

setTransient in class BehaviorBase

Parameters:

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

getOnerror

public String 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 class AjaxBehavior

Returns:

the JavaScript function name of ONERROR.

setOnerror

public void setOnerror(String onerror)

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 class AjaxBehavior

Parameters:

onerror - the error handling function name

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getOnevent

public String 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 class AjaxBehavior

Returns:

the JavaScript function name of ONEVENT.

setOnevent

public void setOnevent(String onevent)

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 class AjaxBehavior

Parameters:

onevent - the event handling function name

markInitialState

public void markInitialState()

Description copied from class: BehaviorBase

Implementation of PartialStateHolder.markInitialState().

Specified by:

markInitialState in interface PartialStateHolder

Overrides:

markInitialState in class BehaviorBase

initialStateMarked

public boolean initialStateMarked()

Description copied from class: BehaviorBase

Implementation of PartialStateHolder.initialStateMarked().

Specified by:

initialStateMarked in interface PartialStateHolder

Overrides:

initialStateMarked in class BehaviorBase

Returns:

true if the initial state is marked, false otherwise.

getExecute

public Collection<String> 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 the execute 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 class AjaxBehavior

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 interface PartialStateHolder

Overrides:

clearInitialState in class BehaviorBase

setExecute

public void setExecute(Collection<String> execute)

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 class AjaxBehavior

Parameters:

execute - the ids of components to execute

getDelay

public String getDelay()

Description copied from class: AjaxBehavior

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

Overrides:

getDelay in class AjaxBehavior

Returns:

the delay value.

setDelay

public void setDelay(String delay)

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 class AjaxBehavior

Parameters:

delay - the ajax delay value

getRender

public Collection<String> 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 the render 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 class AjaxBehavior

Returns:

the ids of components to render.

setRender

public void setRender(Collection<String> render)

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 class AjaxBehavior

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 class AjaxBehavior

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 class AjaxBehavior

Parameters:

resetValues - the resetValues status.

isDisabled

public boolean isDisabled()

Description copied from class: AjaxBehavior

Return the disabled status of this behavior.

Overrides:

isDisabled in class AjaxBehavior

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 class AjaxBehavior

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 class AjaxBehavior

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 class AjaxBehavior

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 class AjaxBehavior

Returns:

the flag whether the immediate attribute is specified.

toString

public String toString()

Overrides:

toString in class Object

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 class AjaxBehavior

Returns:

the flag whether the resetValues attribute is specified.

getValueExpression

public ValueExpression getValueExpression(String name)

Description copied from class: AjaxBehavior

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

Overrides:

getValueExpression in class AjaxBehavior

Parameters:

name - Name of the property for which to retrieve a ValueExpression

Returns:

the ValueExpression.

setValueExpression

public void setValueExpression(String name,
 ValueExpression binding)

Description copied from class: AjaxBehavior

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

Overrides:

setValueExpression in class AjaxBehavior

Parameters:

name - Name of the property for which to set a ValueExpression

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

addAjaxBehaviorListener

public void addAjaxBehaviorListener(AjaxBehaviorListener listener)

Description copied from class: AjaxBehavior

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

Overrides:

addAjaxBehaviorListener in class AjaxBehavior

Parameters:

listener - The AjaxBehaviorListener to be registered

removeAjaxBehaviorListener

public void removeAjaxBehaviorListener(AjaxBehaviorListener listener)

Description copied from class: AjaxBehavior

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

Overrides:

removeAjaxBehaviorListener in class AjaxBehavior

Parameters:

listener - The AjaxBehaviorListener to be removed

saveState

public Object saveState(FacesContext context)

Description copied from class: BehaviorBase

Implementation of StateHolder.saveState(jakarta.faces.context.FacesContext).

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class AjaxBehavior

Parameters:

context - the Faces context.

Returns:

the saved state.

restoreState

public void restoreState(FacesContext context,
 Object state)

Description copied from class: BehaviorBase

Implementation of StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object).

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class AjaxBehavior

Parameters:

context - the Faces context.

state - the state.