Top Fields Constructors Methods
com.sun.faces.facelets.tag.ui

public final Class InsertHandler

extends TagHandlerImpl
implements TemplateClient
Class Inheritance
All Implemented Interfaces
com.sun.faces.facelets.TemplateClient
Imports
java.io.IOException, com.sun.faces.facelets.FaceletContextImplBase, .TemplateClient, com.sun.faces.facelets.tag.TagHandlerImpl, jakarta.faces.component.UIComponent, jakarta.faces.context.FacesContext, jakarta.faces.view.facelets.FaceletContext, .TagAttribute, .TagConfig

Author
Jacob Hookom

Field Summary

Modifier and TypeField and Description
private final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
apply(FaceletContext
the current FaceletContext instance for this execution
ctxObj
,
UIComponent
the parent UIComponent to operate upon
parent
)

Implements jakarta.faces.view.facelets.FaceletHandler.apply.

Process changes on a particular UIComponent

public boolean
apply(FaceletContext
the FaceletContext of your instance, not the templates'
ctx
,
UIComponent
current UIComponent instance to be applied
parent
,
String
the String name or null if the whole body should be included
name
)

Implements com.sun.faces.facelets.TemplateClient.apply.

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.

Inherited from com.sun.faces.facelets.tag.TagHandlerImpl:
findNextByTypefindNextByType

Field Detail

nameback to summary
private final String name

Constructor Detail

InsertHandlerback to summary
public InsertHandler(TagConfig config)

Method Detail

applyback to summary
public void apply(FaceletContext ctxObj, UIComponent parent) throws IOException

Implements jakarta.faces.view.facelets.FaceletHandler.apply.

Doc from jakarta.faces.view.facelets.FaceletHandler.apply.

Process changes on a particular UIComponent

Parameters
ctxObj:FaceletContext

the current FaceletContext instance for this execution

parent:UIComponent

the parent UIComponent to operate upon

Annotations
@Override
Exceptions
IOException:
if unable to load relativePath
applyback to summary
public boolean apply(FaceletContext ctx, UIComponent parent, String name) throws IOException

Implements com.sun.faces.facelets.TemplateClient.apply.

Doc from com.sun.faces.facelets.TemplateClient.apply.

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:FaceletContext

the FaceletContext of your instance, not the templates'

parent:UIComponent

current UIComponent instance to be applied

name:String

the String name or null if the whole body should be included

Returns:boolean

true if this client matched/applied the definition for the passed name

Annotations
@Override
Exceptions
IOException:
when an I/O exception occurs