org.apache.tiles.jsp.context
Class JspUtil

java.lang.Object
  org.apache.tiles.jsp.context.JspUtil

public final class JspUtil
extends Object

Utility class for working within a Jsp environment.

Version:

$Rev: 734996 $ $Date: 2009-01-16 14:27:28 +0100 (ven, 16 gen 2009) $

Method Summary

static TilesContainer	getContainer(PageContext context) Returns the default Tiles container.
static TilesContainer	getContainer(PageContext context, String key) Returns a specific Tiles container.
static TilesContainer	getCurrentContainer(PageContext context) Returns the current container that has been set, or the default one.
static boolean	isForceInclude(PageContext context) Returns true if forced include of the result is needed.
static void	setContainer(PageContext context, TilesContainer container) Configures the default container to be used in the application.
static void	setContainer(PageContext context, TilesContainer container, String key) Configures the container to be used in the application.
static void	setCurrentContainer(PageContext context, String key) Sets the current container to use in web pages.
static void	setCurrentContainer(PageContext context, TilesContainer container) Sets the current container to use in web pages.
static void	setForceInclude(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(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(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

getContainer

public static TilesContainer getContainer(PageContext context)

Returns the default Tiles container.

Parameters:

context - The page context to use.

Returns:

The default Tiles container.

Since:

2.1.2

getContainer

public static TilesContainer getContainer(PageContext context,
                                          String key)

Returns a specific Tiles container.

Parameters:

context - The page context to use.

key - The key under which the container is stored. If null, the default container will be returned.

Returns:

The requested Tiles container.

Since:

2.1.2

setContainer

public static void setContainer(PageContext context,
                                TilesContainer container)

Configures the default container to be used in the application.

Parameters:

context - The page context object to use.

container - The container object to set.

Since:

2.1.2

setContainer

public static void setContainer(PageContext context,
                                TilesContainer container,
                                String key)

Configures the container to be used in the application.

Parameters:

context - The page context object to use.

container - The container object to set.

key - The key under which the container will be stored.

Since:

2.1.2

setCurrentContainer

public static void setCurrentContainer(PageContext context,
                                       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(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(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