Modifier and Type	Class and Description
private static class	ClientBehaviorContext.ClientBehaviorContextImpl
public static class	ClientBehaviorContext.Parameter Parameter instances represent name/value pairs that "submitting" ClientBehavior implementations should include when posting back into the Faces lifecycle.

Modifier and Type	Field and Description
public static final String	BEHAVIOR_EVENT_PARAM_NAME The request parameter name whose request parameter value identifies the type of behavior event.
public static final String	BEHAVIOR_SOURCE_PARAM_NAME The request parameter name whose request parameter value identifies the source component of behavior event.

Access	Constructor and Description
public	ClientBehaviorContext()

Method Summary

Modifier and Type	Method and Description
public static ClientBehaviorContext	Returns: a `ClientBehaviorContext` instance configured with the provided values. createClientBehaviorContext(FacesContext the `FacesContext` for the current request. context, UIComponent the component instance to which the `ClientBehavior` is attached. component, String the name of the behavior event to which the `ClientBehavior` is attached. eventName, String the id to use as the ClientBehavior's "source". sourceId, Collection<ClientBehaviorContext.Parameter> the collection of parameters for submitting ClientBehaviors to include in the request. parameters) Creates a ClientBehaviorContext instance.
public abstract UIComponent	Returns: the component. getComponent() Returns the `UIComponent` that is requesting the `ClientBehavior` script.
public abstract String	Returns: the event name. getEventName() Returns the name of the behavior event for which the ClientBehavior script is being requested.
public abstract FacesContext	Returns: the `FacesContext`. getFacesContext() Returns the `FacesContext` for the current request.
public abstract Collection<ClientBehaviorContext.Parameter>	Returns: the parameters. getParameters() Returns parameters that "submitting" `ClientBehavior` implementations should include when posting back data into the Faces lifecycle.
public abstract String	Returns: the id for the behavior's script to use as the "source", or null if the Behavior's script can identify the source from the DOM. getSourceId() Returns an id for use as the `ClientBehavior` source.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

BEHAVIOR_EVENT_PARAM_NAME	back to summary
public static final String BEHAVIOR_EVENT_PARAM_NAME The request parameter name whose request parameter value identifies the type of behavior event. Since 2.3

BEHAVIOR_SOURCE_PARAM_NAME	back to summary
public static final String BEHAVIOR_SOURCE_PARAM_NAME The request parameter name whose request parameter value identifies the source component of behavior event. Since 2.3

ClientBehaviorContext	back to summary
public ClientBehaviorContext()

Method Detail

createClientBehaviorContext back to summary

createClientBehaviorContext	back to summary
public static ClientBehaviorContext createClientBehaviorContext(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters) Creates a ClientBehaviorContext instance. Parameters context:FacesContext the `FacesContext` for the current request. component:UIComponent the component instance to which the `ClientBehavior` is attached. eventName:String the name of the behavior event to which the `ClientBehavior` is attached. sourceId:String the id to use as the ClientBehavior's "source". parameters:Collection<ClientBehaviorContext.Parameter> the collection of parameters for submitting ClientBehaviors to include in the request. Returns:ClientBehaviorContext a `ClientBehaviorContext` instance configured with the provided values. Exceptions NullPointerException: if `context`, `component` or `eventName` is `null` Since 2.0

public static ClientBehaviorContext createClientBehaviorContext(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters)

Creates a ClientBehaviorContext instance.

Parameters

context:FacesContext: the FacesContext for the current request.
component:UIComponent: the component instance to which the ClientBehavior is attached.
eventName:String: the name of the behavior event to which the ClientBehavior is attached.
sourceId:String: the id to use as the ClientBehavior's "source".
parameters:Collection<ClientBehaviorContext.Parameter>: the collection of parameters for submitting ClientBehaviors to include in the request.

Returns:ClientBehaviorContext

a ClientBehaviorContext instance configured with the provided values.

Exceptions

NullPointerException:: if context, component or eventName is null

Since

2.0

getComponent back to summary

getComponent	back to summary
public abstract UIComponent getComponent() Returns the `UIComponent` that is requesting the `ClientBehavior` script. Returns:UIComponent the component. Since 2.0

public abstract UIComponent getComponent()

Returns the UIComponent that is requesting the ClientBehavior script.

Returns:UIComponent: the component.
Since: 2.0

getEventName	back to summary
public abstract String getEventName() Returns the name of the behavior event for which the ClientBehavior script is being requested. Returns:String the event name. Since 2.0

getEventName

back to summary

public abstract String getEventName()

Returns the name of the behavior event for which the ClientBehavior script is being requested.

Returns:String: the event name.
Since: 2.0

getFacesContext back to summary

getFacesContext	back to summary
public abstract FacesContext getFacesContext() Returns the `FacesContext` for the current request. Returns:FacesContext the `FacesContext`. Since 2.0

public abstract FacesContext getFacesContext()

Returns the FacesContext for the current request.

Returns:FacesContext: the FacesContext.
Since: 2.0

getParameters back to summary

getParameters	back to summary
public abstract Collection<ClientBehaviorContext.Parameter> getParameters() Returns parameters that "submitting" `ClientBehavior` implementations should include when posting back data into the Faces lifecycle. If no parameters are specified, this method returns an empty (non-null) collection. Returns:Collection<ClientBehaviorContext.Parameter> the parameters. Since 2.0

public abstract Collection<ClientBehaviorContext.Parameter> getParameters()

Returns parameters that "submitting" ClientBehavior implementations should include when posting back data into the Faces lifecycle. If no parameters are specified, this method returns an empty (non-null) collection.

Returns:Collection<ClientBehaviorContext.Parameter>: the parameters.
Since: 2.0

getSourceId back to summary

getSourceId	back to summary
public abstract String getSourceId() Returns an id for use as the `ClientBehavior` source. ClientBehavior implementations that submit back to the Faces lifecycle are required to identify which component triggered the ClientBehavior-initiated request via the `jakarta.faces.source` request parameter. In most cases, th source id can be trivially derived from the element to which the behavior's client-side script is attached - ie. the source id is typically the id of this element. However, in components which produce more complex content, the behavior script may not be able to determine the correct id to use for the jakarta.faces.source value. The `ClientBehaviorContext#getSourceId` method allows the component to pass this information into the `ClientBehavior#getScript` implementation. Returns:String the id for the behavior's script to use as the "source", or null if the Behavior's script can identify the source from the DOM. Since 2.0

public abstract String getSourceId()

Returns an id for use as the ClientBehavior source. ClientBehavior implementations that submit back to the Faces lifecycle are required to identify which component triggered the ClientBehavior-initiated request via the jakarta.faces.source request parameter. In most cases, th source id can be trivially derived from the element to which the behavior's client-side script is attached - ie. the source id is typically the id of this element. However, in components which produce more complex content, the behavior script may not be able to determine the correct id to use for the jakarta.faces.source value. The ClientBehaviorContext#getSourceId method allows the component to pass this information into the ClientBehavior#getScript implementation.

Returns:String: the id for the behavior's script to use as the "source", or null if the Behavior's script can identify the source from the DOM.
Since: 2.0

jakarta.faces.component.behavior back to summary

private final Class ClientBehaviorContext.ClientBehaviorContextImpl

Class Inheritance

extends ClientBehaviorContext

java.lang.Object
jakarta.faces.component.behavior.ClientBehaviorContext
jakarta.faces.component.behavior.ClientBehaviorContext.ClientBehaviorContextImpl

Field Summary

Modifier and Type	Field and Description
private UIComponent	component
private FacesContext	context
private String	eventName
private Collection<ClientBehaviorContext.Parameter>	parameters
private String	sourceId

Inherited from jakarta.faces.component.behavior.ClientBehaviorContext:: BEHAVIOR_EVENT_PARAM_NAME BEHAVIOR_SOURCE_PARAM_NAME

Constructor Summary

Access	Constructor and Description
private	ClientBehaviorContextImpl(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters)

Method Summary

Modifier and Type	Method and Description
public UIComponent	getComponent() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getComponent. Returns the `UIComponent` that is requesting the `ClientBehavior` script.
public String	getEventName() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getEventName. Returns the name of the behavior event for which the ClientBehavior script is being requested.
public FacesContext	getFacesContext() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getFacesContext. Returns the `FacesContext` for the current request.
public Collection<ClientBehaviorContext.Parameter>	getParameters() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getParameters. Returns parameters that "submitting" `ClientBehavior` implementations should include when posting back data into the Faces lifecycle.
public String	getSourceId() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getSourceId. Returns an id for use as the `ClientBehavior` source.

Inherited from jakarta.faces.component.behavior.ClientBehaviorContext:: createClientBehaviorContext

Field Detail

component	back to summary
private UIComponent component

context	back to summary
private FacesContext context

eventName	back to summary
private String eventName

parameters	back to summary
private Collection<ClientBehaviorContext.Parameter> parameters

sourceId	back to summary
private String sourceId

Constructor Detail

ClientBehaviorContextImpl	back to summary
private ClientBehaviorContextImpl(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters)

Method Detail

getComponent back to summary

getComponent	back to summary
public UIComponent getComponent() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getComponent. Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getComponent. Returns the `UIComponent` that is requesting the `ClientBehavior` script. Returns:UIComponent the component. Annotations @Override

public UIComponent getComponent()

Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getComponent.

Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getComponent.

Returns the UIComponent that is requesting the ClientBehavior script.

Returns:UIComponent

the component.

Annotations

@Override

getEventName	back to summary
public String getEventName() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getEventName. Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getEventName. Returns the name of the behavior event for which the ClientBehavior script is being requested. Returns:String the event name. Annotations @Override

getEventName

back to summary

public String getEventName()

Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getEventName.

Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getEventName.

Returns the name of the behavior event for which the ClientBehavior script is being requested.

Returns:String

the event name.

Annotations

@Override

getFacesContext back to summary

getFacesContext	back to summary
public FacesContext getFacesContext() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getFacesContext. Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getFacesContext. Returns the `FacesContext` for the current request. Returns:FacesContext the `FacesContext`. Annotations @Override

public FacesContext getFacesContext()

Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getFacesContext.

Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getFacesContext.

Returns the FacesContext for the current request.

Returns:FacesContext

the FacesContext.

Annotations

@Override

getParameters back to summary

getParameters	back to summary
public Collection<ClientBehaviorContext.Parameter> getParameters() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getParameters. Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getParameters. Returns parameters that "submitting" `ClientBehavior` implementations should include when posting back data into the Faces lifecycle. If no parameters are specified, this method returns an empty (non-null) collection. Returns:Collection<ClientBehaviorContext.Parameter> the parameters. Annotations @Override

public Collection<ClientBehaviorContext.Parameter> getParameters()

Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getParameters.

Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getParameters.

Returns:Collection<ClientBehaviorContext.Parameter>

the parameters.

Annotations

@Override

getSourceId back to summary

getSourceId	back to summary
public String getSourceId() Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getSourceId. Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getSourceId. Returns an id for use as the `ClientBehavior` source. ClientBehavior implementations that submit back to the Faces lifecycle are required to identify which component triggered the ClientBehavior-initiated request via the `jakarta.faces.source` request parameter. In most cases, th source id can be trivially derived from the element to which the behavior's client-side script is attached - ie. the source id is typically the id of this element. However, in components which produce more complex content, the behavior script may not be able to determine the correct id to use for the jakarta.faces.source value. The `ClientBehaviorContext#getSourceId` method allows the component to pass this information into the `ClientBehavior#getScript` implementation. Returns:String the id for the behavior's script to use as the "source", or null if the Behavior's script can identify the source from the DOM. Annotations @Override

public String getSourceId()

Implements abstract jakarta.faces.component.behavior.ClientBehaviorContext.getSourceId.

Doc from jakarta.faces.component.behavior.ClientBehaviorContext.getSourceId.

Returns:String

the id for the behavior's script to use as the "source", or null if the Behavior's script can identify the source from the DOM.

Annotations

@Override

jakarta.faces.component.behavior back to summary

public Class ClientBehaviorContext.Parameter

Class Inheritance

extends Object

java.lang.Object
jakarta.faces.component.behavior.ClientBehaviorContext.Parameter

Parameter instances represent name/value pairs that "submitting" ClientBehavior implementations should include when posting back into the Faces lifecycle. ClientBehavior implementations can determine which Parameters to include by calling ClientBehaviorContext.getParameters().

Since: 2.0

Field Summary

Modifier and Type	Field and Description
private String	name
private Object	value

Constructor Summary

Access	Constructor and Description
public	Parameter(String the name of the parameter name, Object the value of the parameter value) Creates a Parameter instance.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the parameter's name. getName() Returns the Parameter's name.
public Object	Returns: the parameter's value. getValue() Returns the Parameter's value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

name	back to summary
private String name

value	back to summary
private Object value

Constructor Detail

Parameter back to summary

Parameter	back to summary
public Parameter(String name, Object value) Creates a Parameter instance. Parameters name:String the name of the parameter value:Object the value of the parameter Exceptions NullPointerException: if `name` is null. Since 2.0

public Parameter(String name, Object value)

Creates a Parameter instance.

Parameters

name:String: the name of the parameter
value:Object: the value of the parameter

Exceptions

NullPointerException:: if name is null.

Since

2.0

Method Detail

getName	back to summary
public String getName() Returns the Parameter's name. Returns:String the parameter's name. Since 2.0

getName

back to summary

public String getName()

Returns the Parameter's name.

Returns:String: the parameter's name.
Since: 2.0

getValue	back to summary
public Object getValue() Returns the Parameter's value. Returns:Object the parameter's value. Since 2.0

getValue

back to summary

public Object getValue()

Returns the Parameter's value.

Returns:Object: the parameter's value.
Since: 2.0

public abstract Class ClientBehaviorContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ClientBehaviorContext.ClientBehaviorContextImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClientBehaviorContext.Parameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail