org.apache.tiles.request.freemarker.render
Class FreemarkerRenderer

Package class diagram package FreemarkerRenderer
java.lang.Object
  extended by org.apache.tiles.request.freemarker.render.FreemarkerRenderer
All Implemented Interfaces:
Renderer

public class FreemarkerRenderer
extends Object
implements Renderer

FreeMarker renderer for rendering FreeMarker templates as Tiles attributes. It is only usable under a Servlet environment, because it uses AttributeValueFreemarkerServlet 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().

Version:
$Rev: 1306435 $ $Date: 2012-03-28 11:39:11 -0400 (Wed, 28 Mar 2012) $

Constructor Summary
FreemarkerRenderer(AttributeValueFreemarkerServlet servlet)
          Constructor.
 
Method Summary
 boolean isRenderable(String path, Request request)
          Checks if this renderer can render a path.
 void render(String path, Request request)
          Renders a path.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FreemarkerRenderer

public FreemarkerRenderer(AttributeValueFreemarkerServlet servlet)
Constructor.

Parameters:
servlet - The servlet to use.
Method Detail

render

public void render(String path,
                   Request request)
            throws IOException
Renders a path.

Specified by:
render in interface Renderer
Parameters:
path - The path to render.
request - The Tiles request context.
Throws:
IOException - If something goes wrong during rendition.

isRenderable

public boolean isRenderable(String path,
                            Request request)
Checks if this renderer can render a path. Note that this does not mean it is the best renderer available, but checks only its capability.

Specified by:
isRenderable in interface Renderer
Parameters:
path - The path to be rendered.
request - The request context.
Returns:
true if this renderer can render the attribute.


Copyright © 2001-2012 Apache Software Foundation. All Rights Reserved.