org.apache.myfaces.view.facelets
Interface TemplateClient
- All Known Implementing Classes:
- CompositionHandler, DecorateHandler, InsertHandler
public interface TemplateClient
FaceletHandlers can implement this contract and push themselves into the FaceletContext for participating in
templating. Templates will attempt to resolve content for a specified name until one of the TemplatClients return
'true'.
- Version:
- $Id: TemplateClient.java,v 1.3 2008/07/13 19:01:39 rlubke Exp $
- Author:
- Jacob Hookom
Method Summary |
boolean |
apply(FaceletContext ctx,
UIComponent parent,
java.lang.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. |
apply
boolean apply(FaceletContext ctx,
UIComponent parent,
java.lang.String name)
throws java.io.IOException,
FacesException,
FaceletException,
javax.el.ELException
- 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.
- Parameters:
ctx
- the FaceletContext of your instance, not the templates'parent
- current UIComponent instance to be appliedname
- 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:
java.io.IOException
FacesException
FaceletException
javax.el.ELException
Copyright © 2010 The Apache Software Foundation. All Rights Reserved.