public class ClientBehaviorBase extends BehaviorBase implements ClientBehavior
ClientBehaviorBase is a
convenience base class that implements the default concrete behavior
of all methods defined by ClientBehavior.
Subclasses should either override getRendererType() to identify
the ClientBehaviorRenderer to delegate to, or they should override
getScript() to locally generate the desired Behavior
script, and decode().
| Constructor and Description |
|---|
ClientBehaviorBase() |
| Modifier and Type | Method and Description |
|---|---|
void |
decode(FacesContext context,
UIComponent component)
Default implementation of of |
java.util.Set<ClientBehaviorHint> |
getHints()
Default implementation of
|
protected ClientBehaviorRenderer |
getRenderer(FacesContext context)
Convenience method to return the
|
java.lang.String |
getRendererType()
Returns the renderer type of the
|
java.lang.String |
getScript(ClientBehaviorContext behaviorContext)
Default implementation of of |
addBehaviorListener, broadcast, clearInitialState, initialStateMarked, isTransient, markInitialState, removeBehaviorListener, restoreState, saveState, setTransientpublic java.lang.String getScript(ClientBehaviorContext behaviorContext)
Default implementation of of ClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext). If a ClientBehaviorRenderer
is available for the specified behavior renderer type, this
method delegates to the ClientBehaviorRenderer.getScript(javax.faces.component.behavior.ClientBehaviorContext, javax.faces.component.behavior.ClientBehavior)
method. Otherwise, this method returns null.
getScript in interface ClientBehaviorbehaviorContext - the ClientBehaviorContextjava.lang.NullPointerException - if behaviorContext is
nullpublic void decode(FacesContext context, UIComponent component)
Default implementation of of ClientBehavior.decode(javax.faces.context.FacesContext, javax.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.
decode in interface ClientBehaviorcontext - FacesContext for the request we are processingcomponent - UIComponent the component associated with this ClientBehaviorjava.lang.NullPointerException - if context or
component is null.public java.lang.String getRendererType()
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
getScript(javax.faces.component.behavior.ClientBehaviorContext) and perform script rendering locally in the
ClientBehavior implementation.
public java.util.Set<ClientBehaviorHint> getHints()
Default implementation of
ClientBehavior.getHints().
By default, no hints are specified, and this method returns an empty,
umodifiable set.
getHints in interface ClientBehaviorClientBehaviorHints.protected ClientBehaviorRenderer getRenderer(FacesContext context)
Convenience method to return the
ClientBehaviorRenderer instance associated with this
ClientBehavior, if any; otherwise, return
null.
context - FacesContext for the request we are processingClientBehaviorRenderer instance from the current RenderKit or null.java.lang.NullPointerException - if context is null.