com.sun.facelets.tag.ui
Class InsertHandler

java.lang.Object
  com.sun.facelets.tag.TagHandler
      com.sun.facelets.tag.ui.InsertHandler

All Implemented Interfaces:

FaceletHandler, TemplateClient

public final class InsertHandler
extends TagHandler
implements TemplateClient

Version:

$Id: InsertHandler.java,v 1.6 2006/04/03 06:25:36 jhook Exp $

Author:

Jacob Hookom

Field Summary

Fields inherited from class com.sun.facelets.tag.TagHandler

nextHandler, tag, tagId

Constructor Summary

InsertHandler(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

Constructor Detail

InsertHandler

public InsertHandler(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