Class VelocityStyleTilesTool
java.lang.Object
org.apache.tiles.velocity.template.ContextHolder
org.apache.tiles.velocity.template.VelocityStyleTilesTool
Tiles Tool to be used "the classic way".
- Since:
- 2.2.0
- Version:
- $Rev: 1058140 $ $Date: 2011-01-13 00:49:44 +1100 (Thu, 13 Jan 2011) $
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreates an attribute that is a copy of the one passed as a parameter.Creates a new empty attribute.createTemplateAttribute
(String template) Creates an attribute that represents a template.protected org.apache.tiles.request.Request
createVelocityRequest
(javax.servlet.ServletContext servletContext, Writer writer) Creates a Velocity request.Ends the current attribute context.Returns an attribute.Returns the current attribute context.org.apache.velocity.runtime.Renderable
Renders an attribute.org.apache.velocity.runtime.Renderable
Renders the current attribute context.org.apache.velocity.runtime.Renderable
renderDefinition
(String definitionName) Renders a definition.setCurrentContainer
(String containerKey) Sets the current container for the current request.Starts the attribute context.toString()
Methods inherited from class org.apache.tiles.velocity.template.ContextHolder
getRequest, getResponse, getServletContext, getVelocityContext, setRequest, setResponse, setServletContext, setVelocityContext
-
Constructor Details
-
VelocityStyleTilesTool
public VelocityStyleTilesTool()
-
-
Method Details
-
get
Returns an attribute.- Parameters:
key
- The name of the attribute to get.- Returns:
- The Attribute.
- Since:
- 2.2.0
-
createAttribute
Creates a new empty attribute.- Returns:
- The created attribute.
- Since:
- 2.2.0
-
clone
Creates an attribute that is a copy of the one passed as a parameter.- Parameters:
attribute
- The attribute to copy.- Returns:
- The copied attribute.
- Since:
- 2.2.0
-
createTemplateAttribute
Creates an attribute that represents a template.- Parameters:
template
- The template.- Returns:
- The attribute.
- Since:
- 2.2.0
-
render
Renders an attribute.- Parameters:
attribute
- The attribute to render.- Returns:
- The renderable object, ready to be rendered.
- Since:
- 2.2.0
-
renderDefinition
Renders a definition. It can be used in conjunction withstartAttributeContext()
andendAttributeContext()
to customize appearance.- Parameters:
definitionName
- The name of the definition to render.- Returns:
- The renderable that renders the definition.
- Since:
- 2.2.0
-
renderAttributeContext
public org.apache.velocity.runtime.Renderable renderAttributeContext()Renders the current attribute context. It can be used in conjunction withstartAttributeContext()
andendAttributeContext()
to customize appearance.- Returns:
- The renderable that renders the current attribute context.
- Since:
- 2.2.0
-
startAttributeContext
Starts the attribute context. Remember to callendAttributeContext()
when finished!- Returns:
- The started attribute context, ready to be customized.
- Since:
- 2.2.0
-
endAttributeContext
Ends the current attribute context. To be called afterstartAttributeContext()
.- Returns:
- The tool itself.
- Since:
- 2.2.0
-
getAttributeContext
Returns the current attribute context.- Returns:
- The current attribute context.
- Since:
- 2.2.0
-
setCurrentContainer
Sets the current container for the current request.- Parameters:
containerKey
- The key of the container to set as "current" for the current request.- Returns:
- The tool itself.
- Since:
- 2.2.0
-
toString
-
createVelocityRequest
protected org.apache.tiles.request.Request createVelocityRequest(javax.servlet.ServletContext servletContext, Writer writer) Creates a Velocity request.- Parameters:
servletContext
- The servlet context.writer
- The writer.- Returns:
- The created request.
-