Top Description Fields Constructors Methods
jakarta.faces.view.facelets

public Class BehaviorHandler

extends FaceletsAttachedObjectHandler
implements BehaviorHolderAttachedObjectHandler
Class Inheritance
All Implemented Interfaces
jakarta.faces.view.BehaviorHolderAttachedObjectHandler, jakarta.faces.view.AttachedObjectHandler
Imports
jakarta.faces.view.BehaviorHolderAttachedObjectHandler

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

Field Summary

Modifier and TypeField and Description
private String
behaviorId

private final TagAttribute
event

private TagHandlerDelegate
helper

Constructor Summary

AccessConstructor and Description
public
BehaviorHandler(BehaviorConfig
config instance to get the behavior Id from.
config)

Constructs the handler using the Id from the config.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the behavior Id
getBehaviorId()

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

public TagAttribute

Returns:

the event tag attribute
getEvent()

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

public String
getEventName()

Implements jakarta.faces.view.BehaviorHolderAttachedObjectHandler.getEventName.

Return the client event name to which this behavior applies.

protected TagHandlerDelegate
getTagHandlerDelegate()

Implements abstract jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTagHandlerDelegate.

Get the tag handler delegate.

Inherited from jakarta.faces.view.facelets.FaceletsAttachedObjectHandler:
applyAttachedObjectgetAttachedObjectHandlerHelpergetFor

Field Detail

behaviorIdback to summary
private String behaviorId
eventback to summary
private final TagAttribute event
helperback to summary
private TagHandlerDelegate helper

Constructor Detail

BehaviorHandlerback to summary
public BehaviorHandler(BehaviorConfig config)

Constructs the handler using the Id from the config.

Parameters
config:BehaviorConfig

config instance to get the behavior Id from.

Method Detail

getBehaviorIdback to summary
public String getBehaviorId()

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

Returns:String

the behavior Id

getEventback to summary
public TagAttribute getEvent()

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

Returns:TagAttribute

the event tag attribute

getEventNameback to summary
public String getEventName()

Implements jakarta.faces.view.BehaviorHolderAttachedObjectHandler.getEventName.

Doc from jakarta.faces.view.BehaviorHolderAttachedObjectHandler.getEventName.

Return the client event name to which this behavior applies.

Returns:String

the client event name for this behavior

Annotations
@Override
getTagHandlerDelegateback to summary
protected TagHandlerDelegate getTagHandlerDelegate()

Implements abstract jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTagHandlerDelegate.

Doc from jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTagHandlerDelegate.

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.

Returns:TagHandlerDelegate

the tag handler delegate.

Annotations
@Override