org.alfresco.web.forms
Class FreeMarkerRenderingEngine

java.lang.Object
  extended by org.alfresco.web.forms.FreeMarkerRenderingEngine
All Implemented Interfaces:
java.io.Serializable, RenderingEngine

public class FreeMarkerRenderingEngine
extends java.lang.Object
implements RenderingEngine

Implementation of a form data renderer for processing xml instance data using a freemarker template.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.alfresco.web.forms.RenderingEngine
RenderingEngine.RenderingException, RenderingEngine.TemplateNotFoundException, RenderingEngine.TemplateProcessorMethod, RenderingEngine.TemplateResourceResolver
 
Field Summary
 
Fields inherited from interface org.alfresco.web.forms.RenderingEngine
ROOT_NAMESPACE
 
Constructor Summary
FreeMarkerRenderingEngine()
           
 
Method Summary
 java.lang.String getDefaultTemplateFileExtension()
          Returns the default file extension for rendering engine templates for this rendering engine.
 java.lang.String getName()
          Returns the rendering engines name.
 void render(java.util.Map model, RenderingEngineTemplate ret, java.io.OutputStream out)
          Renders the rendition using the configured freemarker template.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FreeMarkerRenderingEngine

public FreeMarkerRenderingEngine()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: RenderingEngine
Returns the rendering engines name.

Specified by:
getName in interface RenderingEngine
Returns:
the name of the rendering engine.

getDefaultTemplateFileExtension

public java.lang.String getDefaultTemplateFileExtension()
Description copied from interface: RenderingEngine
Returns the default file extension for rendering engine templates for this rendering engine.

Specified by:
getDefaultTemplateFileExtension in interface RenderingEngine
Returns:
the default file extension for rendering engine templates for this rendering engine.

render

public void render(java.util.Map model,
                   RenderingEngineTemplate ret,
                   java.io.OutputStream out)
            throws java.io.IOException,
                   RenderingEngine.RenderingException,
                   org.xml.sax.SAXException
Renders the rendition using the configured freemarker template. This provides a root map to the freemarker template which places the xml document, and a variable named alfresco at the root. the alfresco variable contains a hash of all parameters and all extension functions.

Specified by:
render in interface RenderingEngine
Parameters:
model - The model
ret - the rendering engine template
out - The output stream to write to
Throws:
java.io.IOException
RenderingEngine.RenderingException
org.xml.sax.SAXException


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.