Class ClientBehaviorContext
ClientBehaviorContext
provides context information that may be useful to
ClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext)
implementations.
- Since:
- 2.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Parameter instances represent name/value pairs that "submitting" ClientBehavior implementations should include when posting back into the Faces lifecycle. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ClientBehaviorContext
createClientBehaviorContext
(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters) Creates a ClientBehaviorContext instance.abstract UIComponent
Returns theUIComponent
that is requesting theClientBehavior
script.abstract String
Returns the name of the behavior event for which the ClientBehavior script is being requested.abstract FacesContext
Returns theFacesContext
for the current request.abstract Collection<ClientBehaviorContext.Parameter>
Returns parameters that "submitting"ClientBehavior
implementations should include when posting back data into the Faces lifecycle.abstract String
Returns an id for use as theClientBehavior
source.
-
Constructor Details
-
ClientBehaviorContext
public ClientBehaviorContext()
-
-
Method Details
-
createClientBehaviorContext
public static ClientBehaviorContext createClientBehaviorContext(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters) Creates a ClientBehaviorContext instance.
- Parameters:
context
- theFacesContext
for the current request.component
- the component instance to which theClientBehavior
is attached.eventName
- the name of the behavior event to which theClientBehavior
is attached.sourceId
- the id to use as the ClientBehavior's "source".parameters
- the collection of parameters for submitting ClientBehaviors to include in the request.- Returns:
- a
ClientBehaviorContext
instance configured with the provided values. - Throws:
NullPointerException
- ifcontext
,component
oreventName
isnull
- Since:
- 2.0
-
getFacesContext
Returns the
FacesContext
for the current request.- Since:
- 2.0
-
getComponent
Returns the
UIComponent
that is requesting theClientBehavior
script.- Since:
- 2.0
-
getEventName
Returns the name of the behavior event for which the ClientBehavior script is being requested.
- Since:
- 2.0
-
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 thejavax.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 javax.faces.source value. ThegetSourceId()
method allows the component to pass this information into theClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext)
implementation.- 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.
- Since:
- 2.0
-
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.- Since:
- 2.0
-