Package org.apache.myfaces.view.facelets.tag.composite

Class ClientBehaviorHandler

java.lang.Object

jakarta.faces.view.facelets.TagHandler

org.apache.myfaces.view.facelets.tag.composite.ClientBehaviorHandler

All Implemented Interfaces:

FaceletHandler

@JSFFaceletTag(name="composite:clientBehavior")
public class ClientBehaviorHandler
extends TagHandler

Version:

$Revision$ $Date$

Author:

Leonardo Uribe (latest modification by $Author$)

Field Summary

Fields

Modifier and Type	Field	Description
protected TagAttribute	_default	Indicate this clientBehavior description is the one that has to be taken by default.
protected TagAttribute	_event	This attribute is used as the target event name, so client behaviors pointing to "name" will be attached on the related components identified by "targets" attribute and on the event name this attribute holds.
protected TagAttribute	_name	This attribute represents the source event name that is used when instances of the composite component are used.
protected TagAttribute	_targets	Contains a list of clientIds separated by spaces that identify the component(s) that will be used to attach client behaviors from the composite component.

Fields inherited from class jakarta.faces.view.facelets.TagHandler

nextHandler, tag, tagId

Constructor Summary

Constructors

Constructor	Description
ClientBehaviorHandler(TagConfig config)

Method Summary

Modifier and Type	Method	Description
void	apply(FaceletContext ctx, UIComponent parent)
protected ClientBehaviorAttachedObjectTargetImpl	createAttachedObjectTarget(FaceletContext ctx)	Create a new AttachedObjectTarget instance to be added on the target list.
boolean	isCacheable()
void	setCacheable(boolean cacheable)

Methods inherited from class jakarta.faces.view.facelets.TagHandler

getAttribute, getRequiredAttribute, toString

Methods inherited from class java.lang.Object

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

Field Detail

_event

@JSFFaceletAttribute(name="event",
                     className="jakarta.el.ValueExpression",
                     deferredValueType="java.lang.String",
                     required=true)
protected final TagAttribute _event

This attribute is used as the target event name, so client behaviors pointing to "name" will be attached on the related components identified by "targets" attribute and on the event name this attribute holds. In other words, this is the "real" event name.

_name

@JSFFaceletAttribute(name="name",
                     className="jakarta.el.ValueExpression",
                     deferredValueType="java.lang.String",
                     required=true)
protected final TagAttribute _name

This attribute represents the source event name that is used when instances of the composite component are used. In other words, this is the "logical" event name.

_default

@JSFFaceletAttribute(name="default",
                     className="jakarta.el.ValueExpression",
                     deferredValueType="boolean")
protected final TagAttribute _default

Indicate this clientBehavior description is the one that has to be taken by default. There should be only one clientBehavior with this property set to true in a composite component interface description.

_targets

@JSFFaceletAttribute(name="targets",
                     className="jakarta.el.ValueExpression",
                     deferredValueType="java.lang.String")
protected final TagAttribute _targets

Contains a list of clientIds separated by spaces that identify the component(s) that will be used to attach client behaviors from the composite component.

Constructor Detail

ClientBehaviorHandler

public ClientBehaviorHandler(TagConfig config)

Method Detail

apply

public void apply(FaceletContext ctx,
                  UIComponent parent)
           throws IOException

Specified by:

apply in interface FaceletHandler

Throws:

IOException

isCacheable

public boolean isCacheable()

setCacheable

public void setCacheable(boolean cacheable)

createAttachedObjectTarget

protected ClientBehaviorAttachedObjectTargetImpl createAttachedObjectTarget(FaceletContext ctx)

Create a new AttachedObjectTarget instance to be added on the target list.

Returns: