info.magnolia.freemarker

Class FreemarkerHelper

java.lang.Object

info.magnolia.freemarker.FreemarkerHelper

@Singleton
public class FreemarkerHelper
extends Object

A generic helper to render Content instances with Freemarker templates. TODO : expose Configuration#clearTemplateCache()

Constructor Summary

Constructors

Constructor and Description
FreemarkerHelper(FreemarkerConfig freemarkerConfig) Deprecated. since 5.4.4. Use FreemarkerHelper(FreemarkerConfig, TranslationService, MagnoliaConfigurationProperties) instead.
FreemarkerHelper(FreemarkerConfig freemarkerConfig, info.magnolia.i18nsystem.TranslationService transactionService) Deprecated. since 5.4.8. Please use FreemarkerHelper(FreemarkerConfig, TranslationService, MagnoliaConfigurationProperties) instead.
FreemarkerHelper(FreemarkerConfig freemarkerConfig, info.magnolia.i18nsystem.TranslationService translationService, info.magnolia.init.MagnoliaConfigurationProperties properties)

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultData(Map<String,Object> data, Locale locale, String i18nBasename)
protected void	addTaglibSupportData(Map<String,Object> data, info.magnolia.context.WebContext webCtx)
protected Locale	checkLocale(Locale locale) Returns the passed Locale if non-null, otherwise attempts to get the Locale from the current context.
protected freemarker.ext.servlet.ServletContextHashModel	checkServletContextModel(javax.servlet.ServletContext servletContext)
protected freemarker.ext.jsp.TaglibFactory	checkTaglibFactory(javax.servlet.ServletContext servletContext)
protected freemarker.template.Configuration	getConfiguration()
static FreemarkerHelper	getInstance() Deprecated. since 4.5, use IoC !
boolean	isEscapeHtml()
protected void	prepareRendering(Locale checkedLocale, String i18nBasename, Object root) Call checkLocale() before calling this method, to ensure it is not null.
protected void	render(Reader template, Locale locale, String i18nBasename, Object root, Writer out)
void	render(Reader template, Object root, Writer out) Renders the template read by the given Reader instance.
void	render(String templatePath, Locale locale, String i18nBasename, Object root, Writer out) Renders the given template, using the given root object (can be a map, or any other type of object handled by MagnoliaContentWrapper) to the given Writer.
void	render(String templatePath, Object root, Writer out)
void	setEscapeHtml(boolean escapeHtml)

Methods inherited from class java.lang.Object

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

Constructor Detail

FreemarkerHelper

@Inject
public FreemarkerHelper(FreemarkerConfig freemarkerConfig,
                                info.magnolia.i18nsystem.TranslationService translationService,
                                info.magnolia.init.MagnoliaConfigurationProperties properties)

FreemarkerHelper

@Deprecated
public FreemarkerHelper(FreemarkerConfig freemarkerConfig,
                                    info.magnolia.i18nsystem.TranslationService transactionService)

Deprecated. since 5.4.8. Please use FreemarkerHelper(FreemarkerConfig, TranslationService, MagnoliaConfigurationProperties) instead.

FreemarkerHelper

@Deprecated
public FreemarkerHelper(FreemarkerConfig freemarkerConfig)

Deprecated. since 5.4.4. Use FreemarkerHelper(FreemarkerConfig, TranslationService, MagnoliaConfigurationProperties) instead.

Method Detail

getInstance

@Deprecated
public static FreemarkerHelper getInstance()

Deprecated. since 4.5, use IoC !

render

public void render(String templatePath,
                   Object root,
                   Writer out)
            throws freemarker.template.TemplateException,
                   IOException

Throws:

freemarker.template.TemplateException

IOException

See Also:

render(String, Locale, String, Object, java.io.Writer)

render

public void render(String templatePath,
                   Locale locale,
                   String i18nBasename,
                   Object root,
                   Writer out)
            throws freemarker.template.TemplateException,
                   IOException

Renders the given template, using the given root object (can be a map, or any other type of object handled by MagnoliaContentWrapper) to the given Writer. If the root is an instance of a Map, the following elements are added to it: - ctx, the current Context instance retrieved from MgnlContext - contextPath, if we have an available WebContext (@deprecated) - defaultBaseUrl, as per Server.getDefaultBaseUrl()

Throws:

freemarker.template.TemplateException

IOException

See Also:

ServerConfiguration.getDefaultBaseUrl()

render

public void render(Reader template,
                   Object root,
                   Writer out)
            throws freemarker.template.TemplateException,
                   IOException

Renders the template read by the given Reader instance. It should be noted that this method completely bypasses Freemarker's caching mechanism. The template will be parsed everytime, which might have a performance impact.

Throws:

freemarker.template.TemplateException

IOException

See Also:

render(Reader, Locale, String, Object, Writer)

render

protected void render(Reader template,
                      Locale locale,
                      String i18nBasename,
                      Object root,
                      Writer out)
               throws freemarker.template.TemplateException,
                      IOException

Throws:

freemarker.template.TemplateException

IOException

checkLocale

protected Locale checkLocale(Locale locale)

Returns the passed Locale if non-null, otherwise attempts to get the Locale from the current context.

prepareRendering

protected void prepareRendering(Locale checkedLocale,
                                String i18nBasename,
                                Object root)

Call checkLocale() before calling this method, to ensure it is not null.

addDefaultData

protected void addDefaultData(Map<String,Object> data,
                              Locale locale,
                              String i18nBasename)

addTaglibSupportData

protected void addTaglibSupportData(Map<String,Object> data,
                                    info.magnolia.context.WebContext webCtx)

checkTaglibFactory

protected freemarker.ext.jsp.TaglibFactory checkTaglibFactory(javax.servlet.ServletContext servletContext)

checkServletContextModel

protected freemarker.ext.servlet.ServletContextHashModel checkServletContextModel(javax.servlet.ServletContext servletContext)
                                                                           throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

getConfiguration

protected freemarker.template.Configuration getConfiguration()

setEscapeHtml

public void setEscapeHtml(boolean escapeHtml)

isEscapeHtml

public boolean isEscapeHtml()