Package org.apache.myfaces.view.facelets
Class TemplateContext
- java.lang.Object
- 
- org.apache.myfaces.view.facelets.TemplateContext
 
- 
- Direct Known Subclasses:
- TemplateContextImpl
 
 public abstract class TemplateContext extends Object This class is used to encapsulate the information required to resolve facelets templates. Composite components require to "isolate" the inner template resolution. That means, when a ui:xx tag is used, do not take into account the outer templates defined. The methods here are only used by the current implementation and the intention is not expose it as public api.- Since:
- 2.0.1
- Version:
- $Revision$ $Date$
- Author:
- Leonardo Uribe (latest modification by $Author$)
 
- 
- 
Constructor SummaryConstructors Constructor Description TemplateContext()
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract voidaddKnownParameters(String knownParameters)abstract booleancontainsKnownParameter(String key)abstract booleancontainsParameter(String key)abstract voidextendClient(AbstractFaceletContext actx, AbstractFacelet owner, TemplateClient client)abstract TemplateManagergetCompositeComponentClient()abstract Set<String>getKnownParameters()Return a set of the parameters known associated to this template context and/or template.abstract jakarta.el.ValueExpressiongetParameter(String key)Return the param value expression associated to the key passed, preserving the precedence of each template client.abstract Map<String,jakarta.el.ValueExpression>getParameterMap()abstract booleanincludeDefinition(FaceletContext ctx, Facelet owner, UIComponent parent, String name)This method will walk through the TemplateClient stack to resolve and apply the definition for the passed name.abstract booleanisAllowCacheELExpressions()abstract booleanisKnownParametersEmpty()abstract booleanisParameterEmpty()Check if no parameters are set.abstract TemplateManagerpopClient(AbstractFaceletContext actx)Pop the last added pushed TemplateClientabstract TemplateManagerpopExtendedClient(AbstractFaceletContext actx)Pop the last added extended TemplateClientabstract voidpushClient(AbstractFaceletContext actx, AbstractFacelet owner, TemplateClient client)Push the passed TemplateClient onto the stack for Definition Resolutionabstract voidsetAllowCacheELExpressions(boolean cacheELExpressions)abstract voidsetCompositeComponentClient(TemplateManager compositeComponentClient)Set the composite component TemplateManager instance, used to resolve cc:insertChildred or cc:insertFacet usages for the current template contextabstract voidsetParameter(String key, jakarta.el.ValueExpression value)Associate the param to the latest template client.
 
- 
- 
- 
Method Detail- 
popClientpublic abstract TemplateManager popClient(AbstractFaceletContext actx) Pop the last added pushed TemplateClient- See Also:
- TemplateClient
 
 - 
pushClientpublic abstract void pushClient(AbstractFaceletContext actx, AbstractFacelet owner, TemplateClient client) Push the passed TemplateClient onto the stack for Definition Resolution- Parameters:
- client-
- See Also:
- TemplateClient
 
 - 
popExtendedClientpublic abstract TemplateManager popExtendedClient(AbstractFaceletContext actx) Pop the last added extended TemplateClient- Parameters:
- actx-
 
 - 
extendClientpublic abstract void extendClient(AbstractFaceletContext actx, AbstractFacelet owner, TemplateClient client) 
 - 
includeDefinitionpublic abstract boolean includeDefinition(FaceletContext ctx, Facelet owner, UIComponent parent, String name) throws IOException, FaceletException, FacesException, jakarta.el.ELException This method will walk through the TemplateClient stack to resolve and apply the definition for the passed name. If it's been resolved and applied, this method will return true.- Parameters:
- parent- the UIComponent to apply to
- name- name or null of the definition you want to apply
- Returns:
- true if successfully applied, otherwise false
- Throws:
- IOException
- FaceletException
- FacesException
- jakarta.el.ELException
 
 - 
getCompositeComponentClientpublic abstract TemplateManager getCompositeComponentClient() 
 - 
setCompositeComponentClientpublic abstract void setCompositeComponentClient(TemplateManager compositeComponentClient) Set the composite component TemplateManager instance, used to resolve cc:insertChildred or cc:insertFacet usages for the current template context
 - 
getParameterpublic abstract jakarta.el.ValueExpression getParameter(String key) Return the param value expression associated to the key passed, preserving the precedence of each template client.- Parameters:
- key-
- Returns:
- Since:
- 2.0.8
 
 - 
setParameterpublic abstract void setParameter(String key, jakarta.el.ValueExpression value) Associate the param to the latest template client.- Parameters:
- key-
- Since:
- 2.0.8
 
 - 
isParameterEmptypublic abstract boolean isParameterEmpty() Check if no parameters are set.- Returns:
- Since:
- 2.0.8
 
 - 
getParameterMappublic abstract Map<String,jakarta.el.ValueExpression> getParameterMap() - Returns:
- Since:
- 2.0.8
 
 - 
isAllowCacheELExpressionspublic abstract boolean isAllowCacheELExpressions() - Returns:
- Since:
- 2.0.8
 
 - 
setAllowCacheELExpressionspublic abstract void setAllowCacheELExpressions(boolean cacheELExpressions) - Since:
- 2.0.8
 
 - 
containsParameterpublic abstract boolean containsParameter(String key) - Parameters:
- key-
- Returns:
- Since:
- 2.1.12
 
 - 
getKnownParameterspublic abstract Set<String> getKnownParameters() Return a set of the parameters known associated to this template context and/or template. This logic is used to detect which EL Expressions can be cached or not.- Returns:
- Since:
- 2.1.12
 
 - 
containsKnownParameterpublic abstract boolean containsKnownParameter(String key) - Parameters:
- key-
- Returns:
- Since:
- 2.1.12
 
 - 
isKnownParametersEmptypublic abstract boolean isKnownParametersEmpty() - Returns:
- Since:
- 2.1.12
 
 - 
addKnownParameterspublic abstract void addKnownParameters(String knownParameters) - Parameters:
- knownParameters-
- Since:
- 2.1.12
 
 
- 
 
-