javax.faces.component.behavior

Class ClientBehaviorContext.ClientBehaviorContextImpl

java.lang.Object

javax.faces.component.behavior.ClientBehaviorContext

javax.faces.component.behavior.ClientBehaviorContext.ClientBehaviorContextImpl

Enclosing class:

ClientBehaviorContext

private static final class ClientBehaviorContext.ClientBehaviorContextImpl
extends ClientBehaviorContext

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.behavior.ClientBehaviorContext

ClientBehaviorContext.Parameter

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class javax.faces.component.behavior.ClientBehaviorContext

createClientBehaviorContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

context

private FacesContext context

component

private UIComponent component

eventName

private java.lang.String eventName

sourceId

private java.lang.String sourceId

parameters

private java.util.Collection<ClientBehaviorContext.Parameter> parameters

Constructor Detail

ClientBehaviorContextImpl

private ClientBehaviorContextImpl(FacesContext context,
                                  UIComponent component,
                                  java.lang.String eventName,
                                  java.lang.String sourceId,
                                  java.util.Collection<ClientBehaviorContext.Parameter> parameters)

Method Detail

getFacesContext

public FacesContext getFacesContext()

Description copied from class: ClientBehaviorContext

Returns the FacesContext for the current request.

Specified by:

getFacesContext in class ClientBehaviorContext

getComponent

public UIComponent getComponent()

Description copied from class: ClientBehaviorContext

Returns the UIComponent that is requesting the ClientBehavior script.

Specified by:

getComponent in class ClientBehaviorContext

getEventName

public java.lang.String getEventName()

Description copied from class: ClientBehaviorContext

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

Specified by:

getEventName in class ClientBehaviorContext

getSourceId

public java.lang.String getSourceId()

Description copied from class: ClientBehaviorContext

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 javax.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. The ClientBehaviorContext.getSourceId() method allows the component to pass this information into the ClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext) implementation.

Specified by:

getSourceId in class ClientBehaviorContext

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.

getParameters

public java.util.Collection<ClientBehaviorContext.Parameter> getParameters()

Description copied from class: ClientBehaviorContext

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.

Specified by:

getParameters in class ClientBehaviorContext