Package javax.faces.view.facelets

Class FaceletContext

  • public abstract class FaceletContext
extends javax.el.ELContext
    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 JSF.
    Since:
    2.0

    • Constructor Summary

      Constructors 
      Constructor Description
      FaceletContext()  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract String generateUniqueId​(String base)
      Generate a unique ID for the passed String
      abstract Object getAttribute​(String name)
      Support method which is backed by the current VariableMapper
      abstract javax.el.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​(javax.el.FunctionMapper fnMapper)
      Set the FunctionMapper to use in EL evaluation/creation
      abstract void setVariableMapper​(javax.el.VariableMapper varMapper)
      Set the VariableMapper to use in EL evaluation/creation

      • Methods inherited from class javax.el.ELContext

        addEvaluationListener, convertToType, enterLambdaScope, exitLambdaScope, getContext, getELResolver, getEvaluationListeners, getFunctionMapper, getImportHandler, getLambdaArgument, getLocale, getVariableMapper, isLambdaArgument, isPropertyResolved, notifyAfterEvaluation, notifyBeforeEvaluation, notifyPropertyResolved, putContext, setLocale, setPropertyResolved, setPropertyResolved

    • Field Detail

      • FACELET_CONTEXT_KEY

        public static final String FACELET_CONTEXT_KEY

    • Constructor Detail

      • FaceletContext

        public FaceletContext()

    • Method Detail

      • generateUniqueId

        public abstract String generateUniqueId​(String base)
        Generate a unique ID for the passed String
        Parameters:
        base -
        Returns:
        a unique ID given the passed base

      • getAttribute

        public abstract Object getAttribute​(String name)
        Support method which is backed by the current VariableMapper
        Parameters:
        name -
        Returns:
        an Object specified for that name

      • getExpressionFactory

        public abstract javax.el.ExpressionFactory getExpressionFactory()
        The ExpressionFactory to use within the Facelet this context is executing upon.
        Returns:
        cannot be null

      • getFacesContext

        public abstract FacesContext getFacesContext()
        The current FacesContext bound to this "request"
        Returns:
        cannot be null

      • includeFacelet

        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)
        Parameters:
        parent -
        relativePath -
        Throws:
        IOException
        FaceletException
        FacesException
        ELException

      • includeFacelet

        public abstract void includeFacelet​(UIComponent parent,
                                    URL absolutePath)
                             throws IOException
        Include another Facelet defined at some path, absolute to this ClassLoader/OS
        Parameters:
        parent -
        absolutePath -
        Throws:
        IOException
        FaceletException
        FacesException
        ELException

      • setAttribute

        public abstract void setAttribute​(String name,
                                  Object value)
        Support method which is backed by the current VariableMapper
        Parameters:
        name -
        value -

      • setFunctionMapper

        public abstract void setFunctionMapper​(javax.el.FunctionMapper fnMapper)
        Set the FunctionMapper to use in EL evaluation/creation
        Parameters:
        fnMapper -

      • setVariableMapper

        public abstract void setVariableMapper​(javax.el.VariableMapper varMapper)
        Set the VariableMapper to use in EL evaluation/creation
        Parameters:
        varMapper -