Package com.sun.faces.facelets.tag.ui
Class DecorateHandler
- java.lang.Object
-
- jakarta.faces.view.facelets.TagHandler
-
- com.sun.faces.facelets.tag.TagHandlerImpl
-
- com.sun.faces.facelets.tag.ui.DecorateHandler
-
- All Implemented Interfaces:
TemplateClient
,FaceletHandler
public final class DecorateHandler extends TagHandlerImpl implements TemplateClient
- Author:
- Jacob Hookom
-
-
Field Summary
-
Fields inherited from class jakarta.faces.view.facelets.TagHandler
nextHandler, tag, tagId
-
-
Constructor Summary
Constructors Constructor Description DecorateHandler(TagConfig config)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
apply(FaceletContext ctxObj, UIComponent parent)
Process changes on a particular UIComponentboolean
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.faces.facelets.tag.TagHandlerImpl
findNextByType, findNextByType
-
Methods inherited from class jakarta.faces.view.facelets.TagHandler
getAttribute, getRequiredAttribute, toString
-
-
-
-
Constructor Detail
-
DecorateHandler
public DecorateHandler(TagConfig config)
- Parameters:
config
-
-
-
Method Detail
-
apply
public void apply(FaceletContext ctxObj, UIComponent parent) throws IOException
Description copied from interface:FaceletHandler
Process changes on a particular UIComponent
- Specified by:
apply
in interfaceFaceletHandler
- Parameters:
ctxObj
- the current FaceletContext instance for this executionparent
- the parent UIComponent to operate upon- Throws:
IOException
- if unable to loadrelativePath
-
apply
public boolean apply(FaceletContext ctx, 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 interfaceTemplateClient
- 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:
IOException
- when an I/O exception occurs
-
-