Class ClientBehaviorBase
- All Implemented Interfaces:
Behavior
,ClientBehavior
,PartialStateHolder
,StateHolder
- Direct Known Subclasses:
AjaxBehavior
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()
.
- Since:
- 2.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
decode
(FacesContext context, UIComponent component) Default implementation of ofClientBehavior.decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
.getHints()
Default implementation ofClientBehavior.getHints()
.protected ClientBehaviorRenderer
getRenderer
(FacesContext context) Convenience method to return theClientBehaviorRenderer
instance associated with thisClientBehavior
, if any; otherwise, returnnull
.Returns the renderer type of theClientBehaviorRenderer
to use for the behavior.getScript
(ClientBehaviorContext behaviorContext) Default implementation of ofClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext)
.Methods inherited from class javax.faces.component.behavior.BehaviorBase
addBehaviorListener, broadcast, clearInitialState, initialStateMarked, isTransient, markInitialState, removeBehaviorListener, restoreState, saveState, setTransient
-
Constructor Details
-
ClientBehaviorBase
public ClientBehaviorBase()
-
-
Method Details
-
getScript
Default implementation of of
ClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext)
. If aClientBehaviorRenderer
is available for the specified behavior renderer type, this method delegates to theClientBehaviorRenderer.getScript(javax.faces.component.behavior.ClientBehaviorContext, javax.faces.component.behavior.ClientBehavior)
method. Otherwise, this method returns null.- Specified by:
getScript
in interfaceClientBehavior
- Parameters:
behaviorContext
- theClientBehaviorContext
- Returns:
- the script provided by the associated ClientBehaviorRenderer, or null if no ClientBehaviorRenderer is available.
- Throws:
NullPointerException
- ifbehaviorContext
isnull
- Since:
- 2.0
-
decode
Default implementation of of
ClientBehavior.decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
. If aClientBehaviorRenderer
is available for the specified behavior renderer type, this method delegates to the ClientBehaviorRenderer's decode() method. Otherwise, no decoding is performed.- Specified by:
decode
in interfaceClientBehavior
- Parameters:
context
-FacesContext
for the request we are processingcomponent
-UIComponent
the component associated with thisClientBehavior
- Throws:
NullPointerException
- ifcontext
orcomponent
is
null
.- Since:
- 2.0
-
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 ofClientBehaviorRenderer
to use, or should overridegetScript(javax.faces.component.behavior.ClientBehaviorContext)
and perform script rendering locally in theClientBehavior
implementation.- Returns:
- the default renderer type, which is null.
- Since:
- 2.0
-
getHints
Default implementation of
ClientBehavior.getHints()
. By default, no hints are specified, and this method returns an empty, umodifiable set.- Specified by:
getHints
in interfaceClientBehavior
- Returns:
- an empty, unmodifiable set of
ClientBehaviorHint
s. - Since:
- 2.0
-
getRenderer
Convenience method to return the
ClientBehaviorRenderer
instance associated with thisClientBehavior
, if any; otherwise, returnnull
.- Parameters:
context
-FacesContext
for the request we are processing- Returns:
ClientBehaviorRenderer
instance from the currentRenderKit
or null.- Throws:
NullPointerException
- ifcontext
is null.- Since:
- 2.0
-