org.apache.tiles.access

Class TilesAccess

java.lang.Object

org.apache.tiles.access.TilesAccess

public final class TilesAccess
extends Object

Provides static access to the tiles container.

Version:

$Rev: 797628 $ $Date: 2009-07-24 21:38:14 +0200 (ven, 24 lug 2009) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTAINER_ATTRIBUTE The name of the attribute to use when getting and setting the container object in a context.

Method Summary

Modifier and Type	Method and Description
static TilesApplicationContext	getApplicationContext(Object context) Deprecated. Use one of the environment-specific Utilities (e.g. ServletUtil).
static TilesContainer	getContainer(Object context) Deprecated. Use one of the environment-specific Utilities (e.g. ServletUtil).
static void	setContainer(Object context, TilesContainer container) Deprecated. Use setContainer(TilesApplicationContext, TilesContainer).
static void	setContainer(TilesApplicationContext context, TilesContainer container) Configures the default container to be used in the application.
static void	setContainer(TilesApplicationContext context, TilesContainer container, String key) Configures the container to be used in the application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTAINER_ATTRIBUTE

public static final String CONTAINER_ATTRIBUTE

The name of the attribute to use when getting and setting the container object in a context.

See Also:

Constant Field Values

Method Detail

getContainer

@Deprecated
public static TilesContainer getContainer(Object context)

Deprecated. Use one of the environment-specific Utilities (e.g. ServletUtil).

Finds and returns the default Tiles container object, if it was previously initialized.

Parameters:

context - The (application) context object to use.

Returns:

The container if it has been configured previously, otherwise null.

See Also:

setContainer(Object, TilesContainer)

setContainer

public static void setContainer(TilesApplicationContext context,
                                TilesContainer container)

Configures the default container to be used in the application.

Parameters:

context - The Tiles application context object to use.

container - The container object to set.

Throws:

TilesAccessException - If something goes wrong during manipulation of the context.

Since:

2.1.2

setContainer

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

Configures the container to be used in the application.

Parameters:

context - The Tiles application context object to use.

container - The container object to set.

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

Throws:

TilesAccessException - If something goes wrong during manipulation of the context.

Since:

2.1.2

setContainer

@Deprecated
public static void setContainer(Object context,
                                            TilesContainer container)

Deprecated. Use setContainer(TilesApplicationContext, TilesContainer).

Configures the default container to be used in the application.

Parameters:

context - The (application) context object to use.

container - The container object to set.

Throws:

TilesAccessException - If something goes wrong during manipulation of the context.

getApplicationContext

@Deprecated
public static TilesApplicationContext getApplicationContext(Object context)

Deprecated. Use one of the environment-specific Utilities (e.g. ServletUtil).

Returns the Tiles application context object.

Parameters:

context - The (application) context to use.

Returns:

The required Tiles application context.