TilesAccess (Tiles 2 2.0.7 API)

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.tiles.access
Class TilesAccess

Package class diagram package TilesAccess

java.lang.Object
  org.apache.tiles.access.TilesAccess

public final class TilesAccess
extends Object
extends Object

Provides static access to the tiles container.

Version:: $Rev: 680124 $ $Date: 2008-07-27 17:20:00 +0200 (Sun, 27 Jul 2008) $

Field Summary

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

Method Summary

static TilesApplicationContext getApplicationContext(Object context)
          Returns the Tiles application context object.

static TilesContainer getContainer(Object context)
          Finds and returns a Tiles container object, if it was previously initialized.

static void setContainer(Object context, TilesContainer container)
          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 Summary
`static String`	`CONTAINER_ATTRIBUTE` The name of the attribute to use when getting and setting the container object in a context.

Method Summary
`static TilesApplicationContext`	`getApplicationContext(Object context)` Returns the Tiles application context object.
`static TilesContainer`	`getContainer(Object context)` Finds and returns a Tiles container object, if it was previously initialized.
`static void`	`setContainer(Object context, TilesContainer container)` 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

public static TilesContainer getContainer(Object context)

Finds and returns a 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(Object context,
                                TilesContainer container)
                         throws TilesException

Configures the container to be used in the application.

Parameters:: context - The (application) context object to use.; container - The container object to set.
Throws:: TilesException - If something goes wrong during manipulation of the context.

getApplicationContext

public static TilesApplicationContext getApplicationContext(Object context)

Returns the Tiles application context object.

Parameters:: context - The (application) context to use.
Returns:: The required Tiles application context.