Package org.apache.tiles.impl
Class BasicTilesContainer
java.lang.Object
org.apache.tiles.impl.BasicTilesContainer
- All Implemented Interfaces:
AttributeEvaluatorFactoryAware
,TilesContainer
public class BasicTilesContainer
extends Object
implements TilesContainer, AttributeEvaluatorFactoryAware
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
- Since:
- 2.0
- Version:
- $Rev: 1330672 $ $Date: 2012-04-26 16:58:16 +1000 (Thu, 26 Apr 2012) $
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
endContext
(org.apache.tiles.request.Request request) Ends a context, where attribute values are stored independently from others.
It must be called after aTilesContainer.startContext(Request)
call.Evaluates the given attribute.org.apache.tiles.request.ApplicationContext
Returns the Tiles application context used by this container.getAttributeContext
(org.apache.tiles.request.Request request) Retrive the attribute context of the current request.protected AttributeContext
getContext
(org.apache.tiles.request.Request tilesContext) Get attribute context from request.protected Deque
<AttributeContext> getContextStack
(org.apache.tiles.request.Request tilesContext) Returns the context stack.getDefinition
(String definitionName, org.apache.tiles.request.Request request) Returns a definition specifying its name.Returns the definitions factory.Returns the preparer factory used by this container.boolean
isValidDefinition
(String definitionName, org.apache.tiles.request.Request request) Determine whether or not the definition exists.protected AttributeContext
popContext
(org.apache.tiles.request.Request tilesContext) Pops a context object out of the stack.void
Executes a preparer.protected void
pushContext
(AttributeContext context, org.apache.tiles.request.Request tilesContext) Pushes a context object in the stack.void
Render the given tiles request.void
Render the given Attribute.void
render
(Definition definition, org.apache.tiles.request.Request request) Renders the specified definition.protected void
render
(org.apache.tiles.request.Request request, AttributeContext attributeContext) Renders the specified attribute context.void
renderContext
(org.apache.tiles.request.Request request) Renders the current context, as it is.void
setApplicationContext
(org.apache.tiles.request.ApplicationContext context) Sets the Tiles application context to use.void
setAttributeEvaluatorFactory
(AttributeEvaluatorFactory attributeEvaluatorFactory) Sets the attribute evaluator factory.void
setDefinitionsFactory
(DefinitionsFactory definitionsFactory) Set the definitions factory.void
setPreparerFactory
(PreparerFactory preparerFactory) Set the preparerInstance factory.void
setRendererFactory
(org.apache.tiles.request.render.RendererFactory rendererFactory) Sets the renderer instance factory.startContext
(org.apache.tiles.request.Request request) Starts a new context, where attribute values are stored independently from others.
When the use of the contexts is finished, callTilesContainer.endContext(Request)
-
Constructor Details
-
BasicTilesContainer
public BasicTilesContainer()
-
-
Method Details
-
startContext
Starts a new context, where attribute values are stored independently from others.
When the use of the contexts is finished, callTilesContainer.endContext(Request)
- Specified by:
startContext
in interfaceTilesContainer
- Parameters:
request
- The request.- Returns:
- The newly created context.
-
endContext
public void endContext(org.apache.tiles.request.Request request) Ends a context, where attribute values are stored independently from others.
It must be called after aTilesContainer.startContext(Request)
call.- Specified by:
endContext
in interfaceTilesContainer
- Parameters:
request
- The request.
-
renderContext
public void renderContext(org.apache.tiles.request.Request request) Renders the current context, as it is.- Specified by:
renderContext
in interfaceTilesContainer
- Parameters:
request
- The request.
-
getApplicationContext
public org.apache.tiles.request.ApplicationContext getApplicationContext()Returns the Tiles application context used by this container.- Specified by:
getApplicationContext
in interfaceTilesContainer
- Returns:
- the application context for this container.
-
setApplicationContext
public void setApplicationContext(org.apache.tiles.request.ApplicationContext context) Sets the Tiles application context to use.- Parameters:
context
- The Tiles application context.
-
getAttributeContext
Retrive the attribute context of the current request.- Specified by:
getAttributeContext
in interfaceTilesContainer
- Parameters:
request
- The request.- Returns:
- map of the attributes in the current attribute context.
-
getDefinitionsFactory
Returns the definitions factory.- Returns:
- The definitions factory used by this container.
-
setDefinitionsFactory
Set the definitions factory. This method first ensures that the container has not yet been initialized.- Parameters:
definitionsFactory
- the definitions factory for this instance.
-
getPreparerFactory
Returns the preparer factory used by this container.- Returns:
- return the preparerInstance factory used by this container.
-
setPreparerFactory
Set the preparerInstance factory. This method first ensures that the container has not yet been initialized.- Parameters:
preparerFactory
- the preparerInstance factory for this conainer.
-
setRendererFactory
public void setRendererFactory(org.apache.tiles.request.render.RendererFactory rendererFactory) Sets the renderer instance factory.- Parameters:
rendererFactory
- the renderer instance factory for this container.- Since:
- 2.1.0
-
setAttributeEvaluatorFactory
Sets the attribute evaluator factory.- Specified by:
setAttributeEvaluatorFactory
in interfaceAttributeEvaluatorFactoryAware
- Parameters:
attributeEvaluatorFactory
- The attribute evaluator factory to use.
-
prepare
Executes a preparer.- Specified by:
prepare
in interfaceTilesContainer
- Parameters:
preparer
- The name of the preparer to execute.request
- The request.
-
render
Render the given tiles request.- Specified by:
render
in interfaceTilesContainer
- Parameters:
definitionName
- the current definition.request
- The request.
-
render
Renders the specified definition.- Specified by:
render
in interfaceTilesContainer
- Parameters:
definition
- The definition to render.request
- The request context.- Since:
- 2.1.3
-
render
Render the given Attribute.- Specified by:
render
in interfaceTilesContainer
- Parameters:
attr
- The attribute to render.request
- The request.- Throws:
IOException
- If something goes wrong during writing to the output.
-
evaluate
Evaluates the given attribute.- Specified by:
evaluate
in interfaceTilesContainer
- Parameters:
attribute
- The attribute to evaluate.request
- The request.- Returns:
- The evaluated object.
-
isValidDefinition
Determine whether or not the definition exists.- Specified by:
isValidDefinition
in interfaceTilesContainer
- Parameters:
definitionName
- the name of the definition.request
- The request.- Returns:
- true if the definition is found.
-
getDefinition
Returns a definition specifying its name.- Specified by:
getDefinition
in interfaceTilesContainer
- Parameters:
definitionName
- The name of the definition to find.request
- The request context.- Returns:
- The definition, if found.
-
getContextStack
Returns the context stack.- Parameters:
tilesContext
- The Tiles context object to use.- Returns:
- The needed stack of contexts.
- Since:
- 2.0.6
-
pushContext
Pushes a context object in the stack.- Parameters:
context
- The context to push.tilesContext
- The Tiles context object to use.- Since:
- 2.0.6
-
popContext
Pops a context object out of the stack.- Parameters:
tilesContext
- The Tiles context object to use.- Returns:
- The popped context object.
- Since:
- 2.0.6
-
getContext
Get attribute context from request.- Parameters:
tilesContext
- current Tiles application context.- Returns:
- BasicAttributeContext or null if context is not found.
- Since:
- 2.0.6
-
render
Renders the specified attribute context.- Parameters:
request
- The request context.attributeContext
- The context to render.- Throws:
InvalidTemplateException
- If the template is not valid.org.apache.tiles.request.render.CannotRenderException
- If something goes wrong during rendering.- Since:
- 2.1.3
-