Top Description Fields Constructors Methods
com.sun.faces.facelets.tag.composite

public Class BehaviorHolderWrapper

extends UIComponent
implements ClientBehaviorHolder
Class Inheritance
All Implemented Interfaces
javax.faces.component.behavior.ClientBehaviorHolder
Imports
javax.el.ValueExpression, javax.faces.FacesException, javax.faces.component.ContextCallback, .UIComponent, javax.faces.component.behavior.ClientBehavior, .ClientBehaviorHolder, javax.faces.component.visit.VisitCallback, .VisitContext, javax.faces.context.FacesContext, javax.faces.el.ValueBinding, javax.faces.event.*, javax.faces.render.Renderer, java.io.IOException, java.util.*

Field Summary

Modifier and TypeField and Description
private final String
private final UIComponent
private final String
Inherited from javax.faces.component.UIComponent:
ATTRS_WITH_DECLARED_DEFAULT_VALUESBEANINFO_KEYbindingsCOMPOSITE_COMPONENT_TYPE_KEYCOMPOSITE_FACET_NAMECURRENT_COMPONENTCURRENT_COMPOSITE_COMPONENTFACETS_KEYHONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAMEVIEW_LOCATION_KEY

Constructor Summary

AccessConstructor and Description
public
BehaviorHolderWrapper(UIComponent parent, String virtualEvent, String event)

Method Summary

Modifier and TypeMethod and Description
public void
addClientBehavior(String
the logical name of the client-side event to attach the behavior to.
eventName
,
ClientBehavior
the ClientBehavior instance to attach for the specified event name.
behavior
)

Implements javax.faces.component.behavior.ClientBehaviorHolder.addClientBehavior.

Attaches a ClientBehavior to the component implementing this interface for the specified event.

protected void
addFacesListener(FacesListener
The FacesListener to be registered
listener
)

Implements abstract javax.faces.component.UIComponent.addFacesListener.

Add the specified FacesListener to the set of listeners registered to receive event notifications from this UIComponent.

public void
broadcast(FacesEvent
The FacesEvent to be broadcast
event
)

Implements abstract javax.faces.component.UIComponent.broadcast.

Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type.

public void
decode(FacesContext
FacesContext for the request we are processing
context
)

Implements abstract javax.faces.component.UIComponent.decode.

Decode any new state of this UIComponent from the request contained in the specified FacesContext, and store this state as needed.

public void
encodeBegin(FacesContext
FacesContext for the response we are creating
context
)

Implements abstract javax.faces.component.UIComponent.encodeBegin.

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext.

public void
encodeChildren(FacesContext
FacesContext for the response we are creating
context
)

Implements abstract javax.faces.component.UIComponent.encodeChildren.

If our rendered property is true, render the child UIComponents of this UIComponent.

public void
encodeEnd(FacesContext
FacesContext for the response we are creating
context
)

Implements abstract javax.faces.component.UIComponent.encodeEnd.

If our rendered property is true, render the ending of the current state of this UIComponent.

public UIComponent
findComponent(String
Search expression identifying the UIComponent to be returned
expr
)

Implements abstract javax.faces.component.UIComponent.findComponent.

Search for and return the UIComponent with an id that matches the specified search expression (if any), according to the algorithm described below.

public Map<String, Object>
getAttributes()

Implements abstract javax.faces.component.UIComponent.getAttributes.

Return a mutable Map representing the attributes (and properties, see below) associated wth this UIComponent, keyed by attribute name (which must be a String).

public int
getChildCount()

Implements abstract javax.faces.component.UIComponent.getChildCount.

Return the number of child UIComponents that are associated with this UIComponent.

public List<UIComponent>
getChildren()

Implements abstract javax.faces.component.UIComponent.getChildren.

Return a mutable List representing the child UIComponents associated with this component.

public Map<String, List<ClientBehavior>>
getClientBehaviors()

Implements javax.faces.component.behavior.ClientBehaviorHolder.getClientBehaviors.

Returns a non-null, unmodifiable Map that contains the the ClientBehaviors that have been attached to the component implementing this interface.

public String
getClientId(FacesContext
The FacesContext for the current request
context
)

Implements abstract javax.faces.component.UIComponent.getClientId.

Return a client-side identifier for this component, generating one if necessary.

public String
getDefaultEventName()

Implements javax.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation.

public Collection<String>
getEventNames()

Implements javax.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

protected FacesContext
getFacesContext()

Implements abstract javax.faces.component.UIComponent.getFacesContext.

Convenience method to return the FacesContext instance for the current request.

protected FacesListener[]
getFacesListeners(Class<T>
Class that must be implemented by a FacesListener for it to be returned
clazz
)

Implements abstract javax.faces.component.UIComponent.getFacesListeners.

Return an array of registered FacesListeners that are instances of the specified class.

public UIComponent
getFacet(String
Name of the desired facet
name
)

Implements abstract javax.faces.component.UIComponent.getFacet.

Convenience method to return the named facet, if it exists, or null otherwise.

public Map<String, UIComponent>
getFacets()

Implements abstract javax.faces.component.UIComponent.getFacets.

Return a mutable Map representing the facet UIComponents associated with this UIComponent, keyed by facet name (which must be a String).

public Iterator<UIComponent>
getFacetsAndChildren()

Implements abstract javax.faces.component.UIComponent.getFacetsAndChildren.

Return an Iterator over the facet followed by child UIComponents of this UIComponent.

public String
getFamily()

Implements abstract javax.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs.

public String
getId()

Implements abstract javax.faces.component.UIComponent.getId.

Return the component identifier of this UIComponent.

public UIComponent
getParent()

Implements abstract javax.faces.component.UIComponent.getParent.

Return the parent UIComponent of this UIComponent, if any.

public Map<String, Object>
getPassThroughAttributes(boolean
if true, a new Map instance will be created if it does not exist already. If false, and there is no existing Map instance, one will not be created and null will be returned.
create
)

Overrides javax.faces.component.UIComponent.getPassThroughAttributes.

This method has the same specification as getPassThroughAttributes() except that it is allowed to return null if and only if the argument create is false and no pass through attribute data structure exists for this instance.

protected Renderer
getRenderer(FacesContext
FacesContext for the current request
context
)

Implements abstract javax.faces.component.UIComponent.getRenderer.

Convenience method to return the Renderer instance associated with this component, if any; otherwise, return null.

public String
getRendererType()

Implements abstract javax.faces.component.UIComponent.getRendererType.

Return the Renderer type for this UIComponent (if any).

public boolean
getRendersChildren()

Implements abstract javax.faces.component.UIComponent.getRendersChildren.

Return a flag indicating whether this component is responsible for rendering its child components.

public ValueBinding
getValueBinding(String
Name of the attribute or property for which to retrieve a ValueBinding
name
)

Implements abstract javax.faces.component.UIComponent.getValueBinding.

Deprecated

Call through to getValueExpression and examine the result.

public ValueExpression
getValueExpression(String
Name of the attribute or property for which to retrieve a ValueExpression
name
)

Overrides javax.faces.component.UIComponent.getValueExpression.

Return the ValueExpression used to calculate the value for the specified attribute or property name, if any.

public boolean
invokeOnComponent(FacesContext
the FacesContext for the current request
context
,
String
the client identifier of the component to be passed to the argument callback.
clientId
,
ContextCallback
an implementation of the Callback interface.
callback
)

Overrides javax.faces.component.UIComponent.invokeOnComponent.

Starting at this component in the View hierarchy, search for a component with a clientId equal to the argument clientId and, if found, call the ContextCallback#invokeContextCallback method on the argument callback, passing the current FacesContext and the found component as arguments.

public boolean
isInView()

Overrides javax.faces.component.UIComponent.isInView.

Return true if this component is within the view hierarchy otherwise false

public boolean
isRendered()

Implements abstract javax.faces.component.UIComponent.isRendered.

Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle.

public boolean
isTransient()

Implements javax.faces.component.StateHolder.isTransient.

If true, the Object implementing this interface must not participate in state saving or restoring.

public void
processDecodes(FacesContext
FacesContext for the request we are processing
context
)

Implements abstract javax.faces.component.UIComponent.processDecodes.

Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

public void
processEvent(ComponentSystemEvent
the ComponentSystemEvent instance that is being processed.
event
)

Overrides javax.faces.component.UIComponent.processEvent.

Implements javax.faces.event.ComponentSystemEventListener.processEvent.

The default implementation performs the following action.

public void
processRestoreState(FacesContext
FacesContext for the request we are processing
context
,
Object
the state.
state
)

Implements abstract javax.faces.component.UIComponent.processRestoreState.

Perform the component tree processing required by the Restore View phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

public Object
processSaveState(FacesContext
FacesContext for the request we are processing
context
)

Implements abstract javax.faces.component.UIComponent.processSaveState.

Perform the component tree processing required by the state saving portion of the Render Response phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

public void
processUpdates(FacesContext
FacesContext for the request we are processing
context
)

Implements abstract javax.faces.component.UIComponent.processUpdates.

Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

public void
processValidators(FacesContext
FacesContext for the request we are processing
context
)

Implements abstract javax.faces.component.UIComponent.processValidators.

Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.

public void
queueEvent(FacesEvent
FacesEvent to be queued
event
)

Implements abstract javax.faces.component.UIComponent.queueEvent.

Queue an event for broadcast at the end of the current request processing lifecycle phase.

protected void
removeFacesListener(FacesListener
The FacesListener to be deregistered
listener
)

Implements abstract javax.faces.component.UIComponent.removeFacesListener.

Remove the specified FacesListener from the set of listeners registered to receive event notifications from this UIComponent.

public void
restoreState(FacesContext
the Faces context.
context
,
Object
the state.
state
)

Implements javax.faces.component.StateHolder.restoreState.

Perform any processing required to restore the state from the entries in the state Object.

public Object
saveState(FacesContext
the Faces context.
context
)

Implements javax.faces.component.StateHolder.saveState.

Gets the state of the instance as a Serializable Object.

public void
setId(String
The new component identifier, or null to indicate that this UIComponent does not have a component identifier
id
)

Implements abstract javax.faces.component.UIComponent.setId.

Set the component identifier of this UIComponent (if any).

public void
setParent(UIComponent
The new parent, or null for the root node of a component tree
parent
)

Implements abstract javax.faces.component.UIComponent.setParent.

Set the parent UIComponent of this UIComponent.

public void
setRendered(boolean
If true render this component; otherwise, do not render this component
rendered
)

Implements abstract javax.faces.component.UIComponent.setRendered.

Set the rendered property of this UIComponent.

public void
setRendererType(String
Logical identifier of the type of Renderer to use, or null for components that render themselves
rendererType
)

Implements abstract javax.faces.component.UIComponent.setRendererType.

Set the Renderer type for this UIComponent, or null for components that render themselves.

public void
setTransient(boolean
boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.
newTransientValue
)

Implements javax.faces.component.StateHolder.setTransient.

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

public void
setValueBinding(String
Name of the attribute or property for which to set a ValueBinding
name
,
ValueBinding
The ValueBinding to set, or null to remove any currently set ValueBinding
binding
)

Implements abstract javax.faces.component.UIComponent.setValueBinding.

Deprecated

Wrap the argument binding in an implementation of ValueExpression and call through to setValueExpression.

public void
setValueExpression(String
Name of the attribute or property for which to set a ValueExpression
name
,
ValueExpression
The ValueExpression to set, or null to remove any currently set ValueExpression
binding
)

Overrides javax.faces.component.UIComponent.setValueExpression.

Set the ValueExpression used to calculate the value for the specified attribute or property name, if any.

public void
subscribeToEvent(Class<? extends SystemEvent>
the event class.
eventClass
,
ComponentSystemEventListener
the listener.
componentListener
)

Overrides javax.faces.component.UIComponent.subscribeToEvent.

This implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class.

public void
unsubscribeFromEvent(Class<? extends SystemEvent>
the event class.
eventClass
,
ComponentSystemEventListener
the component listener.
componentListener
)

Overrides javax.faces.component.UIComponent.unsubscribeFromEvent.

This implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class.

public boolean
visitTree(VisitContext
the VisitContext for this visit
context
,
VisitCallback
the VisitCallback instance whose visit method will be called for each node visited.
callback
)

Overrides javax.faces.component.UIComponent.visitTree.

Perform a tree visit starting at this node in the tree.

Inherited from javax.faces.component.UIComponent:
clearInitialStateencodeAllgetClientIdgetCompositeComponentParentgetContainerClientIdgetCurrentComponentgetCurrentCompositeComponentgetFacetCountgetListenersForEventClassgetNamingContainergetPassThroughAttributesgetResourceBundleMapgetStateHelpergetStateHelpergetTransientStateHelpergetTransientStateHelperinitialStateMarkedisCompositeComponentisVisitablemarkInitialStatepopComponentFromELpushComponentToELrestoreTransientStatesaveTransientStatesetInView