Top Description Constructors Methods
jakarta.faces.view.facelets

public abstract Class Facelet

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.faces.facelets.impl.DefaultFacelet
Imports
java.io.IOException, jakarta.faces.component.UIComponent, jakarta.faces.context.FacesContext

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 Jakarta Server Faces.

Constructor Summary

AccessConstructor and Description
public
Facelet()

Method Summary

Modifier and TypeMethod and Description
public abstract void
apply(FacesContext
The current FacesContext (Should be the same as FacesContext.getInstance())
facesContext, UIComponent
The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot.
parent)

The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document.

public void
applyMetadata(FacesContext
The current FacesContext (Should be the same as FacesContext.getInstance())
facesContext, UIComponent
The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot.
parent)

The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document with only the meta data as per the f:metadata tag.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Faceletback to summary
public Facelet()

Method Detail

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

The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document.

Parameters
facesContext:FacesContext

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

parent:UIComponent

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

Exceptions
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
ELException:
if any of the expressions in the markup loaded during the apply fail
applyMetadataback to summary
public void applyMetadata(FacesContext facesContext, UIComponent parent) throws IOException

The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document with only the meta data as per the f:metadata tag.

Parameters
facesContext:FacesContext

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

parent:UIComponent

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

Exceptions
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
ELException:
if any of the expressions in the markup loaded during the apply fail