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

Class ExtendableViewToolManager

java.lang.Object

org.apache.velocity.tools.ToolManager

org.apache.velocity.tools.view.ViewToolManager

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

public class ExtendableViewToolManager
extends org.apache.velocity.tools.view.ViewToolManager

A tool manager which can be extended with additional tools.

Author:

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

Field Summary

Fields inherited from class org.apache.velocity.tools.view.ViewToolManager

CREATE_SESSION_PROPERTY, DEFAULT_TOOLBOX_KEY, PUBLISH_TOOLBOXES_PROPERTY, servletContext

Fields inherited from class org.apache.velocity.tools.ToolManager

factory, velocity

Constructor Summary

Constructors

Constructor and Description
ExtendableViewToolManager(javax.servlet.ServletContext servletContext, boolean autoConfig, boolean includeDefaults)

Method Summary

Modifier and Type	Method and Description
void	addApplicationScopeTools(String providerId, Class<?>... toolClasses) Add the provided application scope velocity tools to the toolbox.
void	addRequestScopeTools(String providerId, Class<?>... toolClasses) Add the provided request scope velocity tools to the toolbox.
void	configure(org.apache.velocity.tools.config.FactoryConfiguration config)
void	refresh()
void	removeApplicationScopeTools(String providerId) Remove all application scope tools of the given provider.
void	removeRequestScopeTools(String providerId) Remove all request scope tools of the given provider.
protected void	unpublishApplicationTools()

Methods inherited from class org.apache.velocity.tools.view.ViewToolManager

addToolboxes, autoConfigure, createContext, createContext, findConfig, getCreateSession, getPublishToolboxes, getSessionToolbox, getToolboxKey, hasSessionTools, prepareContext, publishToolboxes, publishToolboxes, setCreateSession, setPublishToolboxes, setToolboxKey, updateGlobalProperties

Methods inherited from class org.apache.velocity.tools.ToolManager

configure, createContext, createToolbox, debug, getApplicationToolbox, getLog, getRequestToolbox, getToolboxFactory, getUserCanOverwriteTools, getVelocityEngine, hasApplicationTools, hasRequestTools, hasTools, prepareContext, setToolboxFactory, setUserCanOverwriteTools, setVelocityEngine

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendableViewToolManager

public ExtendableViewToolManager(javax.servlet.ServletContext servletContext,
                                 boolean autoConfig,
                                 boolean includeDefaults)

Method Detail

addApplicationScopeTools

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

Add the provided application scope velocity tools to the toolbox. For the changes to become effective refresh() has to be called.

Parameters:

providerId - the ID of the provider whose tools should be added

toolClasses - the velocity tools to add

addRequestScopeTools

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

Add the provided request scope velocity tools to the toolbox. For the changes to become effective refresh() has to be called.

Parameters:

providerId - the ID of the provider whose tools should be added

toolClasses - the velocity tools to add

configure

public void configure(org.apache.velocity.tools.config.FactoryConfiguration config)

Overrides:

configure in class org.apache.velocity.tools.view.ViewToolManager

refresh

public void refresh()

removeApplicationScopeTools

public void removeApplicationScopeTools(String providerId)

Remove all application scope tools of the given provider. For the changes to become effective refresh() has to be called.

Parameters:

providerId - the ID of the provider whose tools should be removed

removeRequestScopeTools

public void removeRequestScopeTools(String providerId)

Remove all request scope tools of the given provider. For the changes to become effective refresh() has to be called.

Parameters:

providerId - the ID of the provider whose tools should be removed

unpublishApplicationTools

protected void unpublishApplicationTools()

Overrides:

unpublishApplicationTools in class org.apache.velocity.tools.view.ViewToolManager