org.apache.myfaces.view.facelets
Class TemplateContext

java.lang.Object
  extended by 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: 1187700 $ $Date: 2011-10-22 07:19:37 -0500 (Sat, 22 Oct 2011) $
Author:
Leonardo Uribe (latest modification by $Author: bommel $)

Constructor Summary
TemplateContext()
           
 
Method Summary
abstract  void extendClient(AbstractFaceletContext actx, AbstractFacelet owner, TemplateClient client)
           
abstract  TemplateManager getCompositeComponentClient()
           
abstract  javax.el.ValueExpression getParameter(String key)
          Return the param value expression associated to the key passed, preserving the precedence of each template client.
abstract  Map<String,javax.el.ValueExpression> getParameterMap()
           
abstract  boolean includeDefinition(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  boolean isAllowCacheELExpressions()
           
abstract  boolean isParameterEmpty()
          Check if no parameters are set.
abstract  TemplateManager popClient(AbstractFaceletContext actx)
          Pop the last added pushed TemplateClient
abstract  TemplateManager popExtendedClient(AbstractFaceletContext actx)
          Pop the last added extended TemplateClient
abstract  void pushClient(AbstractFaceletContext actx, AbstractFacelet owner, TemplateClient client)
          Push the passed TemplateClient onto the stack for Definition Resolution
abstract  void setAllowCacheELExpressions(boolean cacheELExpressions)
           
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
abstract  void setParameter(String key, javax.el.ValueExpression value)
          Associate the param to the latest template client.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TemplateContext

public TemplateContext()
Method Detail

popClient

public abstract TemplateManager popClient(AbstractFaceletContext actx)
Pop the last added pushed TemplateClient

See Also:
TemplateClient

pushClient

public abstract void pushClient(AbstractFaceletContext actx,
                                AbstractFacelet owner,
                                TemplateClient client)
Push the passed TemplateClient onto the stack for Definition Resolution

Parameters:
client -
See Also:
TemplateClient

popExtendedClient

public abstract TemplateManager popExtendedClient(AbstractFaceletContext actx)
Pop the last added extended TemplateClient

Parameters:
client -

extendClient

public abstract void extendClient(AbstractFaceletContext actx,
                                  AbstractFacelet owner,
                                  TemplateClient client)

includeDefinition

public abstract boolean includeDefinition(FaceletContext ctx,
                                          Facelet owner,
                                          UIComponent parent,
                                          String name)
                                   throws IOException,
                                          FaceletException,
                                          FacesException,
                                          javax.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
javax.el.ELException

getCompositeComponentClient

public abstract TemplateManager getCompositeComponentClient()

setCompositeComponentClient

public 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


getParameter

public abstract javax.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

setParameter

public abstract void setParameter(String key,
                                  javax.el.ValueExpression value)
Associate the param to the latest template client.

Parameters:
key -
Since:
2.0.8

isParameterEmpty

public abstract boolean isParameterEmpty()
Check if no parameters are set.

Parameters:
key -
Returns:
Since:
2.0.8

getParameterMap

public abstract Map<String,javax.el.ValueExpression> getParameterMap()
Parameters:
key -
Returns:
Since:
2.0.8

isAllowCacheELExpressions

public abstract boolean isAllowCacheELExpressions()
Returns:
Since:
2.0.8

setAllowCacheELExpressions

public abstract void setAllowCacheELExpressions(boolean cacheELExpressions)
Since:
2.0.8


Copyright © 2014 The Apache Software Foundation. All Rights Reserved.