This project has retired. For details please refer to its Attic page.

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) $

Field Summary

Fields inherited from class org.apache.tiles.renderer.impl.AbstractBaseAttributeRenderer

applicationContext, attributeEvaluatorFactory, contextFactory

Constructor Summary

FreeMarkerAttributeRenderer()

Method Summary

void	commit() Commits the parameters and makes this renderer ready for the use.
boolean	isRenderable(Object value, Attribute attribute, TilesRequestContext request) Checks if this renderer can render an attribute.
void	setParameter(String key, String value) Sets a parameter for the internal servlet.
void	write(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 org.apache.tiles.renderer.impl.AbstractTypeDetectingAttributeRenderer

isRenderable

Methods inherited from class org.apache.tiles.renderer.impl.AbstractBaseAttributeRenderer

getRequestContext, isPermitted, render, setApplicationContext, setAttributeEvaluatorFactory, setRequestContextFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.tiles.renderer.AttributeRenderer

render

Constructor Detail

FreeMarkerAttributeRenderer

public FreeMarkerAttributeRenderer()

Method Detail

setParameter

public void setParameter(String key,
                         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(Object value,
                  Attribute attribute,
                  TilesRequestContext request)
           throws 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:

IOException - If something goes wrong during rendition.

isRenderable

public boolean isRenderable(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.