Class InsertHandler
java.lang.Object
jakarta.faces.view.facelets.TagHandler
org.apache.myfaces.view.facelets.tag.ui.InsertHandler
- All Implemented Interfaces:
FaceletHandler
,ComponentContainerHandler
,TemplateClient
@JSFFaceletTag(name="ui:insert")
public final class InsertHandler
extends TagHandler
implements TemplateClient, ComponentContainerHandler
The insert tag is used within your templates to declare spots of replicable data.
- Version:
- $Id$
- Author:
- Jacob Hookom
-
Field Summary
Fields inherited from class jakarta.faces.view.facelets.TagHandler
nextHandler, tag, tagId
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
apply
(FaceletContext ctx, UIComponent parent) 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 jakarta.faces.view.facelets.TagHandler
getAttribute, getRequiredAttribute, toString
-
Constructor Details
-
InsertHandler
-
-
Method Details
-
apply
public void apply(FaceletContext ctx, UIComponent parent) throws IOException, FacesException, FaceletException, jakarta.el.ELException - Specified by:
apply
in interfaceFaceletHandler
- Throws:
IOException
FacesException
FaceletException
jakarta.el.ELException
-
apply
public boolean apply(FaceletContext ctx, UIComponent parent, String name) throws IOException, FacesException, FaceletException, jakarta.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 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
FacesException
FaceletException
jakarta.el.ELException
-