|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object info.magnolia.freemarker.FreemarkerHelper
@Singleton public class FreemarkerHelper
A generic helper to render Content instances with Freemarker templates. TODO : expose Configuration#clearTemplateCache()
Constructor Summary | |
---|---|
FreemarkerHelper()
Deprecated. since 4.5, use IoC, i.e use FreemarkerHelper(FreemarkerConfig) |
|
FreemarkerHelper(FreemarkerConfig freemarkerConfig)
|
Method Summary | |
---|---|
protected void |
addDefaultData(Map<String,Object> data,
Locale locale,
String i18nBasename)
|
protected void |
addTaglibSupportData(Map<String,Object> data,
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 ! |
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 |
resetObjectWrapper()
Deprecated. not needed anymore since 4.3 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FreemarkerHelper()
FreemarkerHelper(FreemarkerConfig)
public FreemarkerHelper(FreemarkerConfig freemarkerConfig)
Method Detail |
---|
public static FreemarkerHelper getInstance()
public void resetObjectWrapper()
public void render(String templatePath, Object root, Writer out) throws freemarker.template.TemplateException, IOException
freemarker.template.TemplateException
IOException
render(String, Locale, String, Object, java.io.Writer)
public void render(String templatePath, Locale locale, String i18nBasename, Object root, Writer out) throws freemarker.template.TemplateException, IOException
freemarker.template.TemplateException
IOException
ServerConfiguration.getDefaultBaseUrl()
public void render(Reader template, Object root, Writer out) throws freemarker.template.TemplateException, IOException
freemarker.template.TemplateException
IOException
render(Reader, Locale, String, Object, Writer)
protected void render(Reader template, Locale locale, String i18nBasename, Object root, Writer out) throws freemarker.template.TemplateException, IOException
freemarker.template.TemplateException
IOException
protected Locale checkLocale(Locale locale)
protected void prepareRendering(Locale checkedLocale, String i18nBasename, Object root)
protected void addDefaultData(Map<String,Object> data, Locale locale, String i18nBasename)
protected void addTaglibSupportData(Map<String,Object> data, WebContext webCtx)
protected freemarker.ext.jsp.TaglibFactory checkTaglibFactory(javax.servlet.ServletContext servletContext)
protected freemarker.ext.servlet.ServletContextHashModel checkServletContextModel(javax.servlet.ServletContext servletContext) throws javax.servlet.ServletException
javax.servlet.ServletException
protected freemarker.template.Configuration getConfiguration()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |