com.sun.faces.facelets.tag.ui

Class CompositionHandler

java.lang.Object

javax.faces.view.facelets.TagHandler

com.sun.faces.facelets.tag.TagHandlerImpl

com.sun.faces.facelets.tag.ui.CompositionHandler

All Implemented Interfaces:

TemplateClient, javax.faces.view.facelets.FaceletHandler

public final class CompositionHandler
extends TagHandlerImpl
implements TemplateClient

Author:

Jacob Hookom

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	handlers
static String	Name
protected ParamHandler[]	params
protected javax.faces.view.facelets.TagAttribute	template

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

nextHandler, tag, tagId

Constructor Summary

Constructors

Constructor and Description
CompositionHandler(javax.faces.view.facelets.TagConfig config)

Method Summary

Modifier and Type	Method and Description
void	apply(javax.faces.view.facelets.FaceletContext ctxObj, javax.faces.component.UIComponent parent) Process changes on a particular UIComponent
boolean	apply(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, String name) This contract is much like the normal FaceletHandler.apply method, but it takes in an optional String name which tells this instance what fragment/definition it's looking for.

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

findNextByType, findNextByType

Methods inherited from class javax.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

Name

public static final String Name

See Also:

Constant Field Values

template

protected final javax.faces.view.facelets.TagAttribute template

handlers

protected final Map handlers

params

protected final ParamHandler[] params

Constructor Detail

CompositionHandler

public CompositionHandler(javax.faces.view.facelets.TagConfig config)

Parameters:

config -

Method Detail

apply

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

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

Process changes on a particular UIComponent

Specified by:

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

Parameters:

ctxObj - the current FaceletContext instance for this execution

parent - the parent UIComponent to operate upon

Throws:

IOException - if unable to load relativePath

apply

public boolean apply(javax.faces.view.facelets.FaceletContext ctx,
                     javax.faces.component.UIComponent parent,
                     String name)
              throws IOException

Description copied from interface: TemplateClient

This contract is much like the normal FaceletHandler.apply method, but it takes in an optional String name which tells this instance what fragment/definition it's looking for. If you are a match, apply your logic to the passed UIComponent and return true, otherwise do nothing and return false.

Specified by:

apply in interface TemplateClient

Parameters:

ctx - the FaceletContext of your instance, not the templates'

parent - current UIComponent instance to be applied

name - the String name or null if the whole body should be included

Returns:

true if this client matched/applied the definition for the passed name

Throws:

IOException