|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
void |
endContext(java.lang.Object... requestItems)
Ends a context, where attribute values are stored independently from others. It must be called after a startContext(Object...) call. |
TilesApplicationContext |
getApplicationContext()
Retrieve the containers context. |
AttributeContext |
getAttributeContext(java.lang.Object... requestItems)
Retrive the attribute context of the current request. |
void |
init(java.util.Map<java.lang.String,java.lang.String> initParameters)
Initialize the container with the given configuration. |
boolean |
isValidDefinition(java.lang.String definition,
java.lang.Object... requestItems)
Determine whether or not the definition exists. |
void |
prepare(java.lang.String definition,
java.lang.Object... requestItems)
|
void |
render(Attribute attribute,
java.io.Writer writer,
java.lang.Object... requestItems)
Render the given Attribute. |
void |
render(java.lang.String definition,
java.lang.Object... requestItems)
Render the given tiles request. |
AttributeContext |
startContext(java.lang.Object... requestItems)
Starts a new context, where attribute values are stored independently from others. When the use of the contexts is finished, call endContext(Object...) |
Method Detail |
---|
void init(java.util.Map<java.lang.String,java.lang.String> initParameters) throws TilesException
initParameters
- application context
TilesException
- when an initialization error occursTilesApplicationContext getApplicationContext()
AttributeContext getAttributeContext(java.lang.Object... requestItems)
requestItems
- the current request objects.
AttributeContext startContext(java.lang.Object... requestItems)
endContext(Object...)
requestItems
- the current request objects.
void endContext(java.lang.Object... requestItems)
startContext(Object...)
call.
requestItems
- the current request objects.void prepare(java.lang.String definition, java.lang.Object... requestItems) throws TilesException
definition
- the requested definitionrequestItems
- the current request objects.
TilesException
- is processing fails.void render(java.lang.String definition, java.lang.Object... requestItems) throws TilesException
definition
- the current definition.requestItems
- the current request objects.
TilesException
- is processing fails.void render(Attribute attribute, java.io.Writer writer, java.lang.Object... requestItems) throws TilesException, java.io.IOException
attribute
- The attribute to render.writer
- The writer to use when rendering an attribute of "string"
type.requestItems
- the current request objects.
TilesException
- If something goes wrong during accessing Tiles
elements.
java.io.IOException
- If something goes wrong during writing to the output.boolean isValidDefinition(java.lang.String definition, java.lang.Object... requestItems)
definition
- the name of the definition.requestItems
- the current request objects.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |