Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.action.util
Class JiveFreemarkerManager

java.lang.Object
  extended by com.opensymphony.webwork.views.freemarker.FreemarkerManager
      extended by com.jivesoftware.base.action.util.JiveFreemarkerManager

public class JiveFreemarkerManager
extends com.opensymphony.webwork.views.freemarker.FreemarkerManager

Overridden so we can put static methods from the JiveGlobals, JiveConstants, LocaleUtils and StringUtils classes into the FreeMarker context. As well, this class will set the locale and timeZone in the FreeMarker config so that templates do not have to manually set those.

The template update delay for the JiveFreemarker manager is two seconds. This value can be overrided by specifying the jive property, jive.freemarker.templateUpdateDelay. Changing this property will require a restart


Field Summary
 
Fields inherited from class com.opensymphony.webwork.views.freemarker.FreemarkerManager
CONFIG_SERVLET_CONTEXT_KEY, KEY_APPLICATION, KEY_EXCEPTION, KEY_JSP_TAGLIBS, KEY_REQUEST_MODEL, KEY_REQUEST_PARAMETER_MODEL, KEY_SESSION_MODEL
 
Constructor Summary
JiveFreemarkerManager()
           
 
Method Summary
protected  freemarker.template.Configuration createConfiguration(javax.servlet.ServletContext servletContext)
          Create the instance of the FreeMarker Configuration object.
protected  freemarker.cache.TemplateLoader getTemplateLoader(javax.servlet.ServletContext servletContext)
           
protected  void loadSettings(javax.servlet.ServletContext servletContext, freemarker.template.Configuration configuration)
          Loads the parent's (super) settings before setting the action's locale and user's time zone in the FreeMarker context.
 void populateContext(com.opensymphony.webwork.views.freemarker.ScopesHashModel model, com.opensymphony.xwork.util.OgnlValueStack stack, java.lang.Object action, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Populates the FreeMarker context.
 
Methods inherited from class com.opensymphony.webwork.views.freemarker.FreemarkerManager
buildScopesHashModel, buildTemplateModel, getConfiguration, getInstance, getObjectWrapper
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JiveFreemarkerManager

public JiveFreemarkerManager()
Method Detail

createConfiguration

protected freemarker.template.Configuration createConfiguration(javax.servlet.ServletContext servletContext)
                                                         throws freemarker.template.TemplateException
Create the instance of the FreeMarker Configuration object.

This implementation:

.

Overrides:
createConfiguration in class com.opensymphony.webwork.views.freemarker.FreemarkerManager
Throws:
freemarker.template.TemplateException

loadSettings

protected void loadSettings(javax.servlet.ServletContext servletContext,
                            freemarker.template.Configuration configuration)
Loads the parent's (super) settings before setting the action's locale and user's time zone in the FreeMarker context.

Overrides:
loadSettings in class com.opensymphony.webwork.views.freemarker.FreemarkerManager

populateContext

public void populateContext(com.opensymphony.webwork.views.freemarker.ScopesHashModel model,
                            com.opensymphony.xwork.util.OgnlValueStack stack,
                            java.lang.Object action,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
Populates the FreeMarker context. Allow the parent to load first (by calling super method) then add static Jive classes to the context.

Overrides:
populateContext in class com.opensymphony.webwork.views.freemarker.FreemarkerManager

getTemplateLoader

protected freemarker.cache.TemplateLoader getTemplateLoader(javax.servlet.ServletContext servletContext)
Overrides:
getTemplateLoader in class com.opensymphony.webwork.views.freemarker.FreemarkerManager

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.