Package org.apache.tiles.api
Interface TilesContainer
- All Known Subinterfaces:
MutableTilesContainer
- All Known Implementing Classes:
BasicTilesContainer
,CachingTilesContainer
,TilesContainerWrapper
public interface TilesContainer
An encapsulation of the Tiles framework. This interface is
used to expose tiles features to frameworks which leverage
it as a plugin. It can alternately be used by web applications
which would like a programmatic interface.
- Since:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptionvoid
endContext
(Request request) Ends a context, where attribute values are stored independently of others.
It must be called after astartContext(Request)
call.Evaluates the given attribute.Retrieve the container's context.getAttributeContext
(Request request) Retrieve the attribute context of the current request.getDefinition
(String definitionName, Request request) Returns a definition specifying its name.boolean
isValidDefinition
(String definition, Request request) Determine whether the definition exists.void
Executes a preparer.void
Render the given tiles request.void
Render the given Attribute.void
render
(Definition definition, Request request) Renders the specified definition.void
renderContext
(Request request) Renders the current context, as it is.startContext
(Request request) Starts a new context, where attribute values are stored independently of others.
When the use of the contexts is finished, callendContext(Request)
-
Method Details
-
getApplicationContext
ApplicationContext getApplicationContext()Retrieve the container's context.- Returns:
- current application context
-
getAttributeContext
Retrieve the attribute context of the current request.- Parameters:
request
- The request.- Returns:
- map of the attributes in the current attribute context.
-
startContext
Starts a new context, where attribute values are stored independently of others.
When the use of the contexts is finished, callendContext(Request)
- Parameters:
request
- The request.- Returns:
- The newly created context.
-
endContext
Ends a context, where attribute values are stored independently of others.
It must be called after astartContext(Request)
call.- Parameters:
request
- The request.
-
renderContext
Renders the current context, as it is.- Parameters:
request
- The request.- Since:
- 2.1.0
-
prepare
Executes a preparer.- Parameters:
preparer
- The name of the preparer to execute.request
- The request.
-
render
Render the given tiles request.- Parameters:
definition
- the current definition.request
- The request.
-
render
Renders the specified definition.- Parameters:
definition
- The definition to render.request
- The request context.
-
render
Render the given Attribute.- Parameters:
attribute
- The attribute to render.request
- The request.- Throws:
IOException
- If something goes wrong during writing to the output.- Since:
- 2.1.2
-
evaluate
Evaluates the given attribute.- Parameters:
attribute
- The attribute to evaluate.request
- The request.- Returns:
- The evaluated object.
- Since:
- 2.1.0
-
getDefinition
Returns a definition specifying its name.- Parameters:
definitionName
- The name of the definition to find.request
- The request context.- Returns:
- The definition, if found.
-
isValidDefinition
Determine whether the definition exists.- Parameters:
definition
- the name of the definition.request
- The request.- Returns:
- true if the definition is found.
-