Package org.apache.myfaces.view.facelets
Class AbstractFacelet
- java.lang.Object
-
- jakarta.faces.view.facelets.Facelet
-
- org.apache.myfaces.view.facelets.AbstractFacelet
-
public abstract class AbstractFacelet extends Facelet
- Since:
- 2.0.1
- Version:
- $Revision$ $Date$
- Author:
- Leonardo Uribe (latest modification by $Author$)
-
-
Constructor Summary
Constructors Constructor Description AbstractFacelet()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidapplyCompositeComponent(AbstractFaceletContext ctx, UIComponent parent, Resource resource)abstract voidapplyDynamicComponentHandler(FacesContext facesContext, UIComponent parent, String baseKey)abstract StringgetAlias()Return the alias name for error messages and loggingabstract DoctypegetDoctype()abstract jakarta.el.ExpressionFactorygetExpressionFactory()Return this Facelet's ExpressionFactory instanceStringgetFaceletId()Return an identifier used to derive an unique id per facelet instance.abstract voidinclude(AbstractFaceletContext ctx, UIComponent parent, String path)Used for delegation by the DefaultFaceletContext.abstract voidinclude(AbstractFaceletContext ctx, UIComponent parent, URL url)Grabs a DefaultFacelet from referenced DefaultFaceletFacotryabstract booleanisBuildingCompositeComponentMetadata()-
Methods inherited from class jakarta.faces.view.facelets.Facelet
apply, applyMetadata
-
-
-
-
Method Detail
-
getExpressionFactory
public abstract jakarta.el.ExpressionFactory getExpressionFactory()
Return this Facelet's ExpressionFactory instance- Returns:
- internal ExpressionFactory instance
-
include
public abstract void include(AbstractFaceletContext ctx, UIComponent parent, String path) throws IOException, FacesException, FaceletException, jakarta.el.ELException
Used for delegation by the DefaultFaceletContext.- Parameters:
ctx- FaceletContext to pass to the included Faceletparent- UIComponent to apply changes topath- relative path to the desired Facelet from the FaceletContext- Throws:
IOExceptionFacesExceptionFaceletExceptionjakarta.el.ELException- See Also:
FaceletContext.includeFacelet(UIComponent, String)
-
include
public abstract void include(AbstractFaceletContext ctx, UIComponent parent, URL url) throws IOException, FacesException, FaceletException, jakarta.el.ELException
Grabs a DefaultFacelet from referenced DefaultFaceletFacotry- Parameters:
ctx- FaceletContext to pass to the included Faceletparent- UIComponent to apply changes tourl- URL source to include Facelet from- Throws:
IOExceptionFacesExceptionFaceletExceptionjakarta.el.ELException- See Also:
DefaultFaceletFactory.getFacelet(URL)
-
getAlias
public abstract String getAlias()
Return the alias name for error messages and logging- Returns:
- alias name
-
applyCompositeComponent
public abstract void applyCompositeComponent(AbstractFaceletContext ctx, UIComponent parent, Resource resource) throws IOException, FacesException, FaceletException, jakarta.el.ELException
- Throws:
IOExceptionFacesExceptionFaceletExceptionjakarta.el.ELException
-
applyDynamicComponentHandler
public abstract void applyDynamicComponentHandler(FacesContext facesContext, UIComponent parent, String baseKey) throws IOException, FacesException, FaceletException, jakarta.el.ELException
- Throws:
IOExceptionFacesExceptionFaceletExceptionjakarta.el.ELException
-
isBuildingCompositeComponentMetadata
public abstract boolean isBuildingCompositeComponentMetadata()
-
getFaceletId
public String getFaceletId()
Return an identifier used to derive an unique id per facelet instance. This value should be the same for viewMetadata and normal facelet instances.- Returns:
-
getDoctype
public abstract Doctype getDoctype()
-
-