Class FaceletsAttachedObjectHandler

java.lang.Object

jakarta.faces.view.facelets.TagHandler

jakarta.faces.view.facelets.MetaTagHandler

jakarta.faces.view.facelets.DelegatingMetaTagHandler

jakarta.faces.view.facelets.FaceletsAttachedObjectHandler

All Implemented Interfaces:

AttachedObjectHandler, FaceletHandler

Direct Known Subclasses:

BehaviorHandler, ConverterHandler, ValidatorHandler

public abstract class FaceletsAttachedObjectHandler
extends DelegatingMetaTagHandler
implements AttachedObjectHandler

Root class for all tag handlers that represent attached objetcts in a Facelets page.

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
FaceletsAttachedObjectHandler(TagConfig config)	Call through to super

Method Summary

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, getTagHandlerDelegate, 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.
protected abstract TagHandlerDelegate	getTagHandlerDelegate()	Get the tag handler delegate.
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

FaceletsAttachedObjectHandler

public FaceletsAttachedObjectHandler(TagConfig config)

Call through to super

Parameters:

config - configure this handler instance

Method Details

getAttachedObjectHandlerHelper

protected final AttachedObjectHandler getAttachedObjectHandlerHelper()

Return the underlying handler for this tag handler instance.

Returns:

the handler instance

applyAttachedObject

public 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.

Specified by:

applyAttachedObject in interface AttachedObjectHandler

Parameters:

ctx - the FacesContext for this request

parent - The UIComponent to which this attached object must be applied.

getFor

public final String getFor()

Return the value of the "for" attribute. This enables the runtime to know to which inner component this attached object should be retargeted.

Specified by:

getFor in interface AttachedObjectHandler

Returns:

the value of the "for" attribute for this attached object