Package jakarta.faces.view.facelets

Class Facelet

java.lang.Object

jakarta.faces.view.facelets.Facelet

public abstract class Facelet
extends Object

The parent or root object in a FaceletHandler composition. The Facelet will take care of populating the passed UIComponent parent in relation to the create/restore lifecycle of JSF.

Constructor Summary

Constructors

Constructor	Description
Facelet()

Method Summary

Modifier and Type	Method	Description
abstract void	apply(FacesContext facesContext, UIComponent parent)	The passed UIComponent parent will be populated/restored in accordance with the Facelets chapter in the spec prose document.
void	applyMetadata(FacesContext facesContext, UIComponent parent)	The passed UIComponent parent will be populated/restored in accordance with the Facelets chapter in the spec prose document with only the meta data as per the f:metadata tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Facelet

public Facelet()

Method Detail

applyMetadata

public void applyMetadata(FacesContext facesContext,
                          UIComponent parent)
                   throws IOException

The passed UIComponent parent will be populated/restored in accordance with the Facelets chapter in the spec prose document with only the meta data as per the f:metadata tag.

Parameters:

facesContext - The current FacesContext (Should be the same as FacesContext.getInstance())

parent - The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot.

Throws:

IOException - if unable to load a file necessary to apply this Facelet

FaceletException - if unable to parse the markup loaded in applying this Facelet

FacesException - if unable to create child UIComponent instances

jakarta.el.ELException - if any of the expressions in the markup loaded during the apply fail

apply

public abstract void apply(FacesContext facesContext,
                           UIComponent parent)
                    throws IOException

The passed UIComponent parent will be populated/restored in accordance with the Facelets chapter in the spec prose document.

Parameters:

facesContext - The current FacesContext (Should be the same as FacesContext.getInstance())

parent - The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot.

Throws:

IOException - if unable to load a file necessary to apply this Facelet

FaceletException - if unable to parse the markup loaded in applying this Facelet

FacesException - if unable to create child UIComponent instances

jakarta.el.ELException - if any of the expressions in the markup loaded during the apply fail