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 String |
FACELET_CONTEXT_KEY |
Constructor and Description |
---|
FaceletContext() |
Modifier and Type | Method and Description |
---|---|
abstract String |
generateUniqueId(String base)
Generate a unique ID for the passed String |
abstract Object |
getAttribute(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,
String relativePath)
Include another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in JSP) |
abstract void |
includeFacelet(UIComponent parent,
URL absolutePath)
Include another Facelet defined at some path, absolute to this ClassLoader/OS |
abstract void |
setAttribute(String name,
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. |
getContext, getELResolver, getFunctionMapper, getLocale, getVariableMapper, isPropertyResolved, putContext, setLocale, setPropertyResolved
public static final String FACELET_CONTEXT_KEY
public abstract FacesContext getFacesContext()
The current FacesContext bound to
this "request". Must not be null
.
public abstract String generateUniqueId(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
.
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(String name, Object value)
Support method which is backed by the current VariableMapper.
name
- the name of the attributevalue
- the value of the attributepublic abstract Object getAttribute(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, String relativePath) throws IOException
Include another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in JSP)
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 markupIOException
- 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, URL absolutePath) throws 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 markupIOException
- 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
failCopyright © 2018 JBoss by Red Hat. All rights reserved.