|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tiles.impl.BasicTilesContainer
public class BasicTilesContainer
Basic implementation of the tiles container interface. In most cases, this container will be customized by injecting customized services, not necessarily by override the container
Field Summary | |
---|---|
static java.lang.String |
DEFINITIONS_CONFIG
Constant representing the configuration parameter used to define the tiles definition resources. |
Constructor Summary | |
---|---|
BasicTilesContainer()
|
Method Summary | |
---|---|
protected void |
checkInit()
Determine whether or not the container has been initialized. |
void |
endContext(java.lang.Object... requestItems)
|
org.apache.tiles.TilesApplicationContext |
getApplicationContext()
Returns the Tiles application context used by this container. |
org.apache.tiles.AttributeContext |
getAttributeContext(java.lang.Object... requestItems)
|
TilesContextFactory |
getContextFactory()
Returns the context factory. |
protected org.apache.tiles.Definition |
getDefinition(java.lang.String definitionName,
TilesRequestContext request)
Returns a definition specifying its name. |
DefinitionsFactory |
getDefinitionsFactory()
Returns the definitions factory. |
PreparerFactory |
getPreparerFactory()
Returns the preparer factory used by this container. |
protected java.util.List<java.lang.String> |
getResourceNames(java.lang.String resourceString)
Parse the resourceString into a list of resource paths which can be loaded by the application context. |
protected java.lang.String |
getResourceString()
Derive the resource string from the initialization parameters. |
protected java.lang.String |
getResourceString(java.util.Map<java.lang.String,java.lang.String> parms)
Derive the resource string from the initialization parameters. |
void |
init(java.util.Map<java.lang.String,java.lang.String> initParameters)
Initialize the Container with the given configuration. |
protected void |
initializeDefinitionsFactory(DefinitionsFactory definitionsFactory,
java.lang.String resourceString,
java.util.Map<java.lang.String,java.lang.String> initParameters)
Initializes a definitions factory. |
boolean |
isValidDefinition(java.lang.String definitionName,
java.lang.Object... requestItems)
|
void |
prepare(java.lang.String preparer,
java.lang.Object... requestItems)
|
void |
render(org.apache.tiles.Attribute attr,
java.io.Writer writer,
java.lang.Object... requestItems)
|
void |
render(java.lang.String definitionName,
java.lang.Object... requestItems)
|
void |
setApplicationContext(org.apache.tiles.TilesApplicationContext context)
Sets the Tiles application context to use. |
void |
setContextFactory(TilesContextFactory contextFactory)
Sets the context factory. |
void |
setDefinitionsFactory(DefinitionsFactory definitionsFactory)
Set the definitions factory. |
void |
setPreparerFactory(PreparerFactory preparerFactory)
Set the preparerInstance factory. |
org.apache.tiles.AttributeContext |
startContext(java.lang.Object... requestItems)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFINITIONS_CONFIG
Constructor Detail |
---|
public BasicTilesContainer()
Method Detail |
---|
public void init(java.util.Map<java.lang.String,java.lang.String> initParameters) throws org.apache.tiles.TilesException
init
in interface org.apache.tiles.TilesContainer
initParameters
- application context for this container
org.apache.tiles.TilesException
- If something goes wrong during initialization.public org.apache.tiles.AttributeContext startContext(java.lang.Object... requestItems)
startContext
in interface org.apache.tiles.TilesContainer
public void endContext(java.lang.Object... requestItems)
endContext
in interface org.apache.tiles.TilesContainer
protected void checkInit()
java.lang.IllegalStateException
- if the container has already been initialized.protected void initializeDefinitionsFactory(DefinitionsFactory definitionsFactory, java.lang.String resourceString, java.util.Map<java.lang.String,java.lang.String> initParameters) throws org.apache.tiles.TilesException
definitionsFactory
- The factory to initialize.resourceString
- The string containing a comma-separated-list of
resources.initParameters
- A map containing the initialization parameters.
org.apache.tiles.TilesException
- If something goes wrong.public org.apache.tiles.TilesApplicationContext getApplicationContext()
getApplicationContext
in interface org.apache.tiles.TilesContainer
public void setApplicationContext(org.apache.tiles.TilesApplicationContext context)
context
- The Tiles application context.public org.apache.tiles.AttributeContext getAttributeContext(java.lang.Object... requestItems)
getAttributeContext
in interface org.apache.tiles.TilesContainer
public TilesContextFactory getContextFactory()
public void setContextFactory(TilesContextFactory contextFactory)
contextFactory
- The context factory.public DefinitionsFactory getDefinitionsFactory()
public void setDefinitionsFactory(DefinitionsFactory definitionsFactory)
definitionsFactory
- the definitions factory for this instance.public PreparerFactory getPreparerFactory()
public void setPreparerFactory(PreparerFactory preparerFactory)
preparerFactory
- the preparerInstance factory for this conainer.public void prepare(java.lang.String preparer, java.lang.Object... requestItems) throws org.apache.tiles.TilesException
prepare
in interface org.apache.tiles.TilesContainer
org.apache.tiles.TilesException
public void render(java.lang.String definitionName, java.lang.Object... requestItems) throws org.apache.tiles.TilesException
render
in interface org.apache.tiles.TilesContainer
org.apache.tiles.TilesException
public void render(org.apache.tiles.Attribute attr, java.io.Writer writer, java.lang.Object... requestItems) throws org.apache.tiles.TilesException, java.io.IOException
render
in interface org.apache.tiles.TilesContainer
org.apache.tiles.TilesException
java.io.IOException
protected org.apache.tiles.Definition getDefinition(java.lang.String definitionName, TilesRequestContext request) throws DefinitionsFactoryException
definitionName
- The name of the definition to find.request
- The request context.
DefinitionsFactoryException
- If the definitions factory throws an
exception.protected java.lang.String getResourceString()
DEFINITIONS_CONFIG
is available, attempts
to retrieve LEGACY_DEFINITIONS_CONFIG
. If niether are
available, returns "/WEB-INF/tiles.xml".
protected java.lang.String getResourceString(java.util.Map<java.lang.String,java.lang.String> parms)
DEFINITIONS_CONFIG
is available, attempts
to retrieve LEGACY_DEFINITIONS_CONFIG
. If niether are
available, returns "/WEB-INF/tiles.xml".
parms
- The initialization parameters.
protected java.util.List<java.lang.String> getResourceNames(java.lang.String resourceString)
resourceString
- comma seperated resources
public boolean isValidDefinition(java.lang.String definitionName, java.lang.Object... requestItems)
isValidDefinition
in interface org.apache.tiles.TilesContainer
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |