org.apache.tiles.jsp.context
Class JspUtil

Package class diagram package JspUtil
java.lang.Object
  extended by org.apache.tiles.jsp.context.JspUtil

public final class JspUtil
extends java.lang.Object

Utility class for working within a Jsp environment.


Method Summary
static TilesContainer getCurrentContainer(javax.servlet.jsp.PageContext context)
          Returns the current container that has been set, or the default one.
static boolean isForceInclude(javax.servlet.jsp.PageContext context)
          Returns true if forced include of the result is needed.
static void setCurrentContainer(javax.servlet.jsp.PageContext context, java.lang.String key)
          Sets the current container to use in web pages.
static void setCurrentContainer(javax.servlet.jsp.PageContext context, TilesContainer container)
          Sets the current container to use in web pages.
static void setForceInclude(javax.servlet.jsp.PageContext context, boolean forceInclude)
          Sets the option that enables the forced include of the response.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isForceInclude

public static boolean isForceInclude(javax.servlet.jsp.PageContext context)
Returns true if forced include of the result is needed.

Parameters:
context - The page context.
Returns:
If true the include operation must be forced.
Since:
2.0.6

setForceInclude

public static void setForceInclude(javax.servlet.jsp.PageContext context,
                                   boolean forceInclude)
Sets the option that enables the forced include of the response.

Parameters:
context - The page context.
forceInclude - If true the include operation must be forced.
Since:
2.0.6

setCurrentContainer

public static void setCurrentContainer(javax.servlet.jsp.PageContext context,
                                       java.lang.String key)
Sets the current container to use in web pages.

Parameters:
context - The page context to use.
key - The key under which the container is stored.
Since:
2.1.0

setCurrentContainer

public static void setCurrentContainer(javax.servlet.jsp.PageContext context,
                                       TilesContainer container)
Sets the current container to use in web pages.

Parameters:
context - The page context to use.
container - The container to use as the current container.
Since:
2.1.0

getCurrentContainer

public static TilesContainer getCurrentContainer(javax.servlet.jsp.PageContext context)
Returns the current container that has been set, or the default one.

Parameters:
context - The page context to use.
Returns:
The current Tiles container to use in web pages.
Since:
2.1.0