com.sun.facelets.tag.ui
Class CompositionHandler

java.lang.Object
  extended by com.sun.facelets.tag.TagHandler
      extended by com.sun.facelets.tag.ui.CompositionHandler
All Implemented Interfaces:
FaceletHandler, TemplateClient

public final class CompositionHandler
extends TagHandler
implements TemplateClient

Version:
$Id: CompositionHandler.java,v 1.12 2007/08/09 16:54:44 rlubke Exp $
Author:
Jacob Hookom

Field Summary
protected  Map handlers
           
static String Name
           
protected  ParamHandler[] params
           
protected  TagAttribute template
           
 
Fields inherited from class com.sun.facelets.tag.TagHandler
nextHandler, tag, tagId
 
Constructor Summary
CompositionHandler(TagConfig config)
           
 
Method Summary
 void apply(FaceletContext ctx, UIComponent parent)
          Process changes on a particular UIComponent
 boolean apply(FaceletContext ctx, 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.facelets.tag.TagHandler
findNextByType, 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 TagAttribute template

handlers

protected final Map handlers

params

protected final ParamHandler[] params
Constructor Detail

CompositionHandler

public CompositionHandler(TagConfig config)
Parameters:
config -
Method Detail

apply

public void apply(FaceletContext ctx,
                  UIComponent parent)
           throws IOException,
                  FacesException,
                  FaceletException,
                  javax.el.ELException
Description copied from interface: FaceletHandler
Process changes on a particular UIComponent

Specified by:
apply in interface FaceletHandler
Parameters:
ctx - the current FaceletContext instance for this execution
parent - the parent UIComponent to operate upon
Throws:
IOException
FacesException
FaceletException
javax.el.ELException

apply

public boolean apply(FaceletContext ctx,
                     UIComponent parent,
                     String name)
              throws IOException,
                     FacesException,
                     FaceletException,
                     javax.el.ELException
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
FacesException
FaceletException
javax.el.ELException


Copyright © 2005 All Rights Reserved.