org.nuxeo.ecm.platform.rendering.fm
Class FreemarkerEngine

java.lang.Object
  org.nuxeo.ecm.platform.rendering.fm.FreemarkerEngine

All Implemented Interfaces:

RenderingEngine

public class FreemarkerEngine
extends java.lang.Object
implements RenderingEngine

Author:

Bogdan Stefanescu

Field Summary

static java.lang.String

RENDERING_ENGINE_KEY

Constructor Summary

FreemarkerEngine()

FreemarkerEngine(freemarker.template.Configuration cfg, ResourceLocator locator)

Method Summary

freemarker.template.Configuration	getConfiguration()
ResourceTemplateLoader	getLoader()
java.util.ResourceBundle	getMessageBundle()
DocumentObjectWrapper	getObjectWrapper()
ResourceLocator	getResourceLocator()
void	render(java.lang.String template, java.lang.Object input, java.io.Writer writer) Starts the rendering for the given document context.
void	setMessageBundle(java.util.ResourceBundle messages) set the resource bundle to be used with method message and lmessage.
void	setResourceLocator(ResourceLocator locator)
void	setSharedVariable(java.lang.String key, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Field Detail

RENDERING_ENGINE_KEY

public static final java.lang.String RENDERING_ENGINE_KEY

See Also:

Constant Field Values

Constructor Detail

FreemarkerEngine

public FreemarkerEngine()

FreemarkerEngine

public FreemarkerEngine(freemarker.template.Configuration cfg,
                        ResourceLocator locator)

Method Detail

setMessageBundle

public void setMessageBundle(java.util.ResourceBundle messages)

set the resource bundle to be used with method message and lmessage. If the resourcebundle is not of the type ResourceComposite, lmessage will create a default ResourceComposite.

Specified by:

setMessageBundle in interface RenderingEngine

getMessageBundle

public java.util.ResourceBundle getMessageBundle()

Specified by:

getMessageBundle in interface RenderingEngine

setResourceLocator

public void setResourceLocator(ResourceLocator locator)

Specified by:

setResourceLocator in interface RenderingEngine

getResourceLocator

public ResourceLocator getResourceLocator()

Specified by:

getResourceLocator in interface RenderingEngine

getLoader

public ResourceTemplateLoader getLoader()

setSharedVariable

public void setSharedVariable(java.lang.String key,
                              java.lang.Object value)

Specified by:

setSharedVariable in interface RenderingEngine

getObjectWrapper

public DocumentObjectWrapper getObjectWrapper()

getConfiguration

public freemarker.template.Configuration getConfiguration()

render

public void render(java.lang.String template,
                   java.lang.Object input,
                   java.io.Writer writer)
            throws RenderingException

Description copied from interface: RenderingEngine

Starts the rendering for the given document context.

Specified by:

render in interface RenderingEngine

Throws:

RenderingException