com.sun.faces.facelets.tag.jsf.core

Class AjaxHandler

java.lang.Object

jakarta.faces.view.facelets.TagHandler

com.sun.faces.facelets.tag.TagHandlerImpl

com.sun.faces.facelets.tag.jsf.core.AjaxHandler

All Implemented Interfaces:

jakarta.faces.view.AttachedObjectHandler, jakarta.faces.view.BehaviorHolderAttachedObjectHandler, jakarta.faces.view.facelets.FaceletHandler

public final class AjaxHandler
extends TagHandlerImpl
implements jakarta.faces.view.BehaviorHolderAttachedObjectHandler

Enable one or more components in the view to perform Ajax operations. This tag handler must create an instance of AjaxBehavior using the tag attribute values.

The events attribute for this tag that can be a ValueExpression must be evaluated at tag execution time since the event name is used in the process of Behavior creation.

If this tag is nested within a single ClientBehaviorHolder component:

• If the events attribute value is not specified, obtain the default event name by calling ClientBehaviorHolder.getDefaultEventName(). If that returns null throw an exception.
• If the events attribute value is specified, ensure it that it exists in the Collection returned from a call to ClientBehaviorHolder.getEventNames() and throw an exception if it doesn't exist.
• Add the AjaxBehavior instance to the ClientBehaviorHolder component by calling ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior) passing event and the AjaxBehavior instance.

Check for the existence of the Ajax resource by calling UIViewRoot.getComponentResources(). If the Ajax resource does not exist, create a UIOutput component instance and set the renderer type to jakarta.faces.resource.Script. Set the the following attributes in the component's attribute Map: library with the value and name with the value . Install the component resource using UIViewRoot.addComponentResource() and specifying head as the target argument.

If this tag has component children, add the AjaxBehavior to AjaxBehaviors by calling AjaxBehaviors.pushBehavior(jakarta.faces.context.FacesContext, jakarta.faces.component.behavior.AjaxBehavior, java.lang.String). As subsequent child components that implement the ClientBehaviorHolder interface are evaluated this AjaxBehavior instance must be added as a behavior to the component.

Version:

$Id: AjaxHandler.java 5369 2008-09-08 19:53:45Z rogerk $

Field Summary

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

nextHandler, tag, tagId

Constructor Summary

Constructors

Constructor and Description
AjaxHandler(jakarta.faces.view.facelets.TagConfig config)

Method Summary

Modifier and Type	Method and Description
void	apply(jakarta.faces.view.facelets.FaceletContext ctx, jakarta.faces.component.UIComponent parent) Process changes on a particular UIComponent
void	applyAttachedObject(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent parent) Take the argument parent and apply this attached object to it.
String	getEventName() Return the client event name to which this behavior applies.
String	getFor() Return the value of the "for" attribute specified by the page author on the tag for this AttachedObjectHandler.

Methods inherited from class com.sun.faces.facelets.tag.TagHandlerImpl

findNextByType, findNextByType

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

Constructor Detail

AjaxHandler

public AjaxHandler(jakarta.faces.view.facelets.TagConfig config)

Parameters:

config -

Method Detail

apply

public void apply(jakarta.faces.view.facelets.FaceletContext ctx,
                  jakarta.faces.component.UIComponent parent)
           throws IOException

Description copied from interface: jakarta.faces.view.facelets.FaceletHandler

Process changes on a particular UIComponent

Specified by:

apply in interface jakarta.faces.view.facelets.FaceletHandler

Parameters:

ctx - the current FaceletContext instance for this execution

parent - the parent UIComponent to operate upon

Throws:

IOException - if unable to load relativePath

applyAttachedObject

public void applyAttachedObject(jakarta.faces.context.FacesContext context,
                                jakarta.faces.component.UIComponent parent)

Description copied from interface: jakarta.faces.view.AttachedObjectHandler

Take the argument parent and apply this attached object to it. The action taken varies with class that implements one of the subinterfaces of this interface.

Specified by:

applyAttachedObject in interface jakarta.faces.view.AttachedObjectHandler

Parameters:

context - The FacesContext for this request

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

getFor

public String getFor()

Description copied from interface: jakarta.faces.view.AttachedObjectHandler

Return the value of the "for" attribute specified by the page author on the tag for this AttachedObjectHandler.

Specified by:

getFor in interface jakarta.faces.view.AttachedObjectHandler

Returns:

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

getEventName

public String getEventName()

Description copied from interface: jakarta.faces.view.BehaviorHolderAttachedObjectHandler

Return the client event name to which this behavior applies.

Specified by:

getEventName in interface jakarta.faces.view.BehaviorHolderAttachedObjectHandler

Returns:

the client event name for this behavior