public abstract class FaceletContext extends ELContext
Context representative of a single request from a Facelet. This instance is passed to nearly every method call in this API.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FACELET_CONTEXT_KEY |
Constructor and Description |
---|
FaceletContext() |
Modifier and Type | Method and Description |
---|---|
abstract java.lang.String |
generateUniqueId(java.lang.String base)
Generate a unique ID for the passed String |
abstract java.lang.Object |
getAttribute(java.lang.String name)
Return an attribute set by a previous call to |
abstract ExpressionFactory |
getExpressionFactory()
The ExpressionFactory to use within the Facelet this context is executing upon. |
abstract FacesContext |
getFacesContext()
The current FacesContext bound to this "request". |
abstract void |
includeFacelet(UIComponent parent,
java.lang.String relativePath)
Include another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in Jakarta Server Pages) |
abstract void |
includeFacelet(UIComponent parent,
java.net.URL absolutePath)
Include another Facelet defined at some path, absolute to this ClassLoader/OS |
abstract void |
setAttribute(java.lang.String name,
java.lang.Object value)
Support method which is backed by the current VariableMapper. |
abstract void |
setFunctionMapper(FunctionMapper fnMapper)
Set the FunctionMapper to use in EL evaluation/creation. |
abstract void |
setVariableMapper(VariableMapper varMapper)
Set the VariableMapper to use in EL evaluation/creation. |
addEvaluationListener, convertToType, enterLambdaScope, exitLambdaScope, getContext, getELResolver, getEvaluationListeners, getFunctionMapper, getImportHandler, getLambdaArgument, getLocale, getVariableMapper, isLambdaArgument, isPropertyResolved, notifyAfterEvaluation, notifyBeforeEvaluation, notifyPropertyResolved, putContext, setLocale, setPropertyResolved, setPropertyResolved
public abstract FacesContext getFacesContext()
The current FacesContext bound to this "request". Must not be null
.
public abstract java.lang.String generateUniqueId(java.lang.String base)
Generate a unique ID for the passed String
base
- the string from which to generate the ID.public abstract ExpressionFactory getExpressionFactory()
The ExpressionFactory to use within the Facelet this context is executing upon. Must not be null
.
ExpressionFactory
for this Facelet.public abstract void setVariableMapper(VariableMapper varMapper)
Set the VariableMapper to use in EL evaluation/creation.
varMapper
- the new VariableMapper
public abstract void setFunctionMapper(FunctionMapper fnMapper)
Set the FunctionMapper to use in EL evaluation/creation.
fnMapper
- the new FunctionMapper
public abstract void setAttribute(java.lang.String name, java.lang.Object value)
Support method which is backed by the current VariableMapper.
name
- the name of the attributevalue
- the value of the attributepublic abstract java.lang.Object getAttribute(java.lang.String name)
Return an attribute set by a previous call to setAttribute(java.lang.String, java.lang.Object)
. Support method which is backed by the current
VariableMapper
name
- the name of the attribute to return.public abstract void includeFacelet(UIComponent parent, java.lang.String relativePath) throws java.io.IOException
Include another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in Jakarta Server Pages)
parent
- the UIComponent
that will be the parent of any components in the included facelet.relativePath
- the path of the resource containing the facelet markup, relative to the current markupjava.io.IOException
- if unable to load relativePath
FaceletException
- if unable to parse the markup loaded from relativePath
FacesException
- if unable to create child UIComponent
instancesELException
- if any of the expressions in the markup loaded from relativePath
failpublic abstract void includeFacelet(UIComponent parent, java.net.URL absolutePath) throws java.io.IOException
Include another Facelet defined at some path, absolute to this ClassLoader/OS
parent
- the UIComponent
that will be the parent of any components in the included facelet.absolutePath
- the absolute path to the resource containing the facelet markupjava.io.IOException
- if unable to load relativePath
FaceletException
- if unable to parse the markup loaded from relativePath
FacesException
- if unable to create child UIComponent
instancesELException
- if any of the expressions in the markup loaded from relativePath
fail