Package org.apache.tiles.access
Class TilesAccess
- java.lang.Object
-
- org.apache.tiles.access.TilesAccess
-
public final class TilesAccess extends java.lang.Object
Provides static access to the tiles container.- Version:
- $Rev: 1044659 $ $Date: 2010-12-12 01:16:04 +1100 (Sun, 12 Dec 2010) $
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONTAINER_ATTRIBUTE
The name of the attribute to use when getting and setting the container object in a context.static java.lang.String
CURRENT_CONTAINER_ATTRIBUTE_NAME
Name of the attribute used to store the current used container.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TilesContainer
getContainer(org.apache.tiles.request.ApplicationContext context)
Returns default the container to be used in the application.static TilesContainer
getContainer(org.apache.tiles.request.ApplicationContext context, java.lang.String key)
Returns the container to be used in the application registered under a specific key.static TilesContainer
getCurrentContainer(org.apache.tiles.request.Request request)
Returns the current container that has been set, or the default one.static void
setContainer(org.apache.tiles.request.ApplicationContext context, TilesContainer container)
Configures the default container to be used in the application.static void
setContainer(org.apache.tiles.request.ApplicationContext context, TilesContainer container, java.lang.String key)
Configures the container to be used in the application.static void
setCurrentContainer(org.apache.tiles.request.Request request, java.lang.String key)
Sets the current container to use in web pages.static void
setCurrentContainer(org.apache.tiles.request.Request request, TilesContainer container)
Sets the current container to use in web pages.
-
-
-
Field Detail
-
CURRENT_CONTAINER_ATTRIBUTE_NAME
public static final java.lang.String CURRENT_CONTAINER_ATTRIBUTE_NAME
Name of the attribute used to store the current used container.- See Also:
- Constant Field Values
-
CONTAINER_ATTRIBUTE
public static final java.lang.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
-
setContainer
public static void setContainer(org.apache.tiles.request.ApplicationContext 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.- Since:
- 2.1.2
-
setContainer
public static void setContainer(org.apache.tiles.request.ApplicationContext context, TilesContainer container, java.lang.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.- Since:
- 2.1.2
-
getContainer
public static TilesContainer getContainer(org.apache.tiles.request.ApplicationContext context)
Returns default the container to be used in the application.- Parameters:
context
- The Tiles application context object to use.- Returns:
- The default container object.
- Since:
- 3.0.0
-
getContainer
public static TilesContainer getContainer(org.apache.tiles.request.ApplicationContext context, java.lang.String key)
Returns the container to be used in the application registered under a specific key.- Parameters:
context
- The Tiles application context object to use.key
- The key under which the container will be stored.- Returns:
- The container object.
- Since:
- 3.0.0
-
setCurrentContainer
public static void setCurrentContainer(org.apache.tiles.request.Request request, java.lang.String key)
Sets the current container to use in web pages.- Parameters:
request
- The request to use.key
- The key under which the container is stored.- Since:
- 2.1.0
-
setCurrentContainer
public static void setCurrentContainer(org.apache.tiles.request.Request request, TilesContainer container)
Sets the current container to use in web pages.- Parameters:
request
- The request to use.container
- The container to use as the current container.- Since:
- 2.1.0
-
getCurrentContainer
public static TilesContainer getCurrentContainer(org.apache.tiles.request.Request request)
Returns the current container that has been set, or the default one.- Parameters:
request
- The request to use.- Returns:
- The current Tiles container to use in web pages.
- Since:
- 2.1.0
-
-