Class BehaviorHandler

java.lang.Object

jakarta.faces.view.facelets.TagHandler

jakarta.faces.view.facelets.MetaTagHandler

jakarta.faces.view.facelets.DelegatingMetaTagHandler

jakarta.faces.view.facelets.FaceletsAttachedObjectHandler

jakarta.faces.view.facelets.BehaviorHandler

All Implemented Interfaces:

AttachedObjectHandler, BehaviorHolderAttachedObjectHandler, FaceletHandler

public class BehaviorHandler
extends FaceletsAttachedObjectHandler
implements BehaviorHolderAttachedObjectHandler

The FaceletHandler that corresponds to attached objects that represent an instance of ClientBehavior that must be added to the parent component, which must implement ClientBehaviorHolder, with a call to ClientBehaviorHolder.addClientBehavior(String, ClientBehavior). The current specification defines one Facelet element for this sort of attached object, <f:ajax>.

Field Summary

Fields inherited from class DelegatingMetaTagHandler

delegateFactory

Modifier and Type	Field	Description
protected TagHandlerDelegateFactory	delegateFactory	Class that defines methods relating to helping tag handler instances.

Fields inherited from class TagHandler

nextHandler, tag, tagId

Modifier and Type	Field	Description
protected final FaceletHandler	nextHandler	A reference to the FaceletHandler that represents the first nested child of this TagHandler instance.
protected final Tag	tag	A reference to the Tag instance corresponding to this TagHandler instance.
protected final String	tagId	See TagConfig.getTagId().

Constructor Summary

Constructors

Constructor	Description
BehaviorHandler(BehaviorConfig config)	Constructs the handler using the Id from the config.

Method Summary

Modifier and Type	Method	Description
String	getBehaviorId()	Returns the behavior Id obtained from the passed-in config.
TagAttribute	getEvent()	Returns the event that is set as the "event" attribute on the behavior tag.
String	getEventName()	Return the client event name to which this behavior applies.
protected TagHandlerDelegate	getTagHandlerDelegate()	Get the tag handler delegate.

Methods inherited from class FaceletsAttachedObjectHandler

applyAttachedObject, getAttachedObjectHandlerHelper, getFor

Modifier and Type	Method	Description
final void	applyAttachedObject(FacesContext ctx, UIComponent parent)	Take the necessary actions to apply the attached object represented by the tag for the concrete subclass of this class to the argument parent.
protected final AttachedObjectHandler	getAttachedObjectHandlerHelper()	Return the underlying handler for this tag handler instance.
final String	getFor()	Return the value of the "for" attribute.

Methods inherited from class DelegatingMetaTagHandler

apply, applyNextHandler, createMetaRuleset, getBinding, getTag, getTagAttribute, getTagId, isDisabled, setAttributes

Modifier and Type	Method	Description
void	apply(FaceletContext ctx, UIComponent parent)	The default implementation simply calls through to TagHandlerDelegate.apply(FaceletContext, UIComponent).
void	applyNextHandler(FaceletContext ctx, UIComponent c)	Invoke the apply() method on this instance's TagHandler.nextHandler.
protected MetaRuleset	createMetaRuleset(Class type)	The default implementation simply calls through to TagHandlerDelegate.createMetaRuleset(Class) and returns the result.
TagAttribute	getBinding()	Return the "binding" attribute.
Tag	getTag()	Return a reference to the Tag instance corresponding to this TagHandler instance.
TagAttribute	getTagAttribute(String localName)	Return the named attribute from the tag attributes.
String	getTagId()	Return the tag id from the TagConfig used to instantiate this handler.
boolean	isDisabled(FaceletContext ctx)	Returns the value of the "disabled" attribute.
void	setAttributes(FaceletContext ctx, Object instance)	Invoking/extending this method will cause the results of the created MetaRuleset to auto-wire state to the passed instance.

Methods inherited from class TagHandler

getAttribute, getRequiredAttribute, toString

Modifier and Type	Method	Description
protected final TagAttribute	getAttribute(String localName)	Utility method for fetching the appropriate TagAttribute
protected final TagAttribute	getRequiredAttribute(String localName)	Utility method for fetching a required TagAttribute
String	toString()

Methods inherited from class Object

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

Constructor Details

BehaviorHandler

public BehaviorHandler(BehaviorConfig config)

Constructs the handler using the Id from the config.

Parameters:

config - config instance to get the behavior Id from.

Method Details

getEventName

public String getEventName()

Description copied from interface: BehaviorHolderAttachedObjectHandler

Return the client event name to which this behavior applies.

Specified by:

getEventName in interface BehaviorHolderAttachedObjectHandler

Returns:

the client event name for this behavior

getTagHandlerDelegate

protected TagHandlerDelegate getTagHandlerDelegate()

Description copied from class: DelegatingMetaTagHandler

Get the tag handler delegate.

Code that extends from DelegatingMetaTagHandler (directly or indirectly, as through extending ComponentHandler) must take care to decorate, not replace, the TagHandlerDelegate instance returned by this method. Failure to do so may produce unexpected results.

Specified by:

getTagHandlerDelegate in class DelegatingMetaTagHandler

Returns:

the tag handler delegate.

getBehaviorId

public String getBehaviorId()

Returns the behavior Id obtained from the passed-in config.

Returns:

the behavior Id

getEvent

public TagAttribute getEvent()

Returns the event that is set as the "event" attribute on the behavior tag.

Returns:

the event tag attribute