com.communote.server.web.commons.view.velocity

Class VelocityTemplateManager

java.lang.Object

com.communote.server.web.commons.view.TemplateManager

com.communote.server.web.commons.view.velocity.VelocityTemplateManager

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware

public class VelocityTemplateManager
extends TemplateManager
implements org.springframework.web.context.ServletContextAware

Template manager optimized for velocity templates.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
VelocityTemplateManager(org.springframework.web.servlet.view.velocity.VelocityConfigurer engineConfig, String toolConfigLocation) Create a new manager

Method Summary

Modifier and Type	Method and Description
void	addApplicationScopeTools(String providerId, Class<?>... toolClass) Add the provided velocity tools to the application scope toolbox.
protected void	addCoreTemplates(Map<String,String> templateMapping) Add the core templates
void	addRequestScopeTools(String providerId, Class<?>... toolClass) Add the provided velocity tools to the request scope toolbox.
void	addTemplateBasePath(String basePath) Add a base directory for searching templates which are registered with a relative path.
void	addTools(String providerId, Collection<Class<?>> applicationTools, Collection<Class<?>> requestTools) Add the provided velocity tools to the application and request scope toolboxes.
org.apache.velocity.tools.view.ViewToolManager	getToolManager()
void	removeTools(String providerId) Remove all tools that were added by the given provider.
void	setServletContext(javax.servlet.ServletContext servletContext)

Methods inherited from class com.communote.server.web.commons.view.TemplateManager

getTemplate, getTemplateNames, registerTemplate, unregisterTemplates

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityTemplateManager

public VelocityTemplateManager(org.springframework.web.servlet.view.velocity.VelocityConfigurer engineConfig,
                               String toolConfigLocation)

Create a new manager

Parameters:

engineConfig - the VelocityEngine configuration that provides the engine

toolConfigLocation - classpath or filesystem location of the toolbox configuration

Method Detail

addApplicationScopeTools

public void addApplicationScopeTools(String providerId,
                                     Class<?>... toolClass)

Add the provided velocity tools to the application scope toolbox.

Parameters:

providerId - the ID of the provider of the tools. This is usually the ID of a plugin.

toolClass - the tools to add

addCoreTemplates

protected void addCoreTemplates(Map<String,String> templateMapping)

Description copied from class: TemplateManager

Add the core templates

Overrides:

addCoreTemplates in class TemplateManager

Parameters:

templateMapping - a mapping from template key to template file where the templates should be added to

addRequestScopeTools

public void addRequestScopeTools(String providerId,
                                 Class<?>... toolClass)

Add the provided velocity tools to the request scope toolbox.

Parameters:

providerId - the ID of the provider of the tools. This is usually the ID of a plugin.

toolClass - the tools to add

addTemplateBasePath

public void addTemplateBasePath(String basePath)

Add a base directory for searching templates which are registered with a relative path.

Parameters:

basePath - absolute path to a directory for searching for templates

addTools

public void addTools(String providerId,
                     Collection<Class<?>> applicationTools,
                     Collection<Class<?>> requestTools)

Add the provided velocity tools to the application and request scope toolboxes. This method is more efficient if tools should be added to both toolboxes than calling the specific add-methods individually.

Parameters:

providerId - the ID of the provider of the tools. This is usually the ID of a plugin.

applicationTools - the application scope tools to add

requestTools - the request scope tools to add

getToolManager

public org.apache.velocity.tools.view.ViewToolManager getToolManager()

removeTools

public void removeTools(String providerId)

Remove all tools that were added by the given provider.

Parameters:

providerId - the ID of the provider whose tools should be removed. This is usually the ID of a plugin.

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware