org.apache.tiles.freemarker.renderer
Class FreeMarkerAttributeRenderer
java.lang.Object
org.apache.tiles.renderer.impl.AbstractBaseAttributeRenderer
org.apache.tiles.renderer.impl.AbstractTypeDetectingAttributeRenderer
org.apache.tiles.freemarker.renderer.FreeMarkerAttributeRenderer
- All Implemented Interfaces:
- TilesApplicationContextAware, TilesRequestContextFactoryAware, AttributeEvaluatorFactoryAware, AttributeRenderer, TypeDetectingAttributeRenderer
public class FreeMarkerAttributeRenderer
- extends AbstractTypeDetectingAttributeRenderer
FreeMarker renderer for rendering FreeMarker templates as Tiles attributes.
It is only usable under a Servlet environment, because it uses
TilesFreemarkerServlet
internally to forward the request.
To initialize it correctly, call setParameter(String, String)
for all the
parameters that you want to set, and then call commit()
.
- Since:
- 2.2.0
- Version:
- $Rev: 821299 $ $Date: 2009-10-03 14:15:05 +0200 (sab, 03 ott 2009) $
Method Summary |
void |
commit()
Commits the parameters and makes this renderer ready for the use. |
boolean |
isRenderable(java.lang.Object value,
Attribute attribute,
TilesRequestContext request)
Checks if this renderer can render an attribute. |
void |
setParameter(java.lang.String key,
java.lang.String value)
Sets a parameter for the internal servlet. |
void |
write(java.lang.Object value,
Attribute attribute,
TilesRequestContext request)
Implement this method knowing that the attribute won't be null and it
will be authorized. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FreeMarkerAttributeRenderer
public FreeMarkerAttributeRenderer()
setParameter
public void setParameter(java.lang.String key,
java.lang.String value)
- Sets a parameter for the internal servlet.
- Parameters:
key
- The name of the parameter.value
- The value of the parameter.- Since:
- 2.2.0
commit
public void commit()
- Commits the parameters and makes this renderer ready for the use.
- Since:
- 2.2.0
write
public void write(java.lang.Object value,
Attribute attribute,
TilesRequestContext request)
throws java.io.IOException
- Implement this method knowing that the attribute won't be null and it
will be authorized.
- Specified by:
write
in class AbstractBaseAttributeRenderer
- Parameters:
value
- The value of the attribute to be rendered.attribute
- The attribute to render.request
- The Tiles request object.
- Throws:
java.io.IOException
- If something goes wrong during rendition.
isRenderable
public boolean isRenderable(java.lang.Object value,
Attribute attribute,
TilesRequestContext request)
- Checks if this renderer can render an attribute. Note that this does not mean
it is the best renderer available, but checks only its capability.
- Parameters:
value
- The attribute value, already evaluated.attribute
- The attribute to be renderer.request
- The Tiles request context.
- Returns:
true
if this renderer can render the attribute.