VelocityToolboxView

Class Overview

VelocityView subclass which adds support for Velocity Tools toolboxes and Velocity Tools ViewTool callbacks / Velocity Tools 1.3 init methods.

Specify a "toolboxConfigLocation", for example "/WEB-INF/toolbox.xml", to automatically load a Velocity Tools toolbox definition file and expose all defined tools in the specified scopes. If no config location is specified, no toolbox will be loaded and exposed.

This view will always create a special Velocity context, namely an instance of the ChainedContext class which is part of the view package of Velocity tools. This allows to use tools from the view package of Velocity Tools, like LinkTool, which need to be initialized with a special context that implements the ViewContext interface (i.e. a ChainedContext).

This view also checks tools that are specified as "toolAttributes": If they implement the ViewTool interface, they will get initialized with the Velocity context. This allows tools from the view package of Velocity Tools, such as LinkTool, to be defined as "toolAttributes" on a VelocityToolboxView, instead of in a separate toolbox XML file.

This is a separate class mainly to avoid a required dependency on the view package of Velocity Tools in VelocityView itself. As of Spring 3.0, this class requires Velocity Tools 1.3 or higher.

Summary

[Expand] Inherited Constants
From class org.springframework.web.servlet.view.AbstractTemplateView String SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE Variable name of the RequestContext instance in the template model, available to Spring's macros: e.g.
From class org.springframework.web.servlet.view.AbstractView String DEFAULT_CONTENT_TYPE Default content type.

[Expand] Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport protected final Log logger Logger that is available to subclasses
From interface org.springframework.web.servlet.View public static final String RESPONSE_STATUS_ATTRIBUTE Name of the HttpServletRequest attribute that contains the response status code.

[Expand] Inherited Methods
From class org.springframework.web.servlet.view.velocity.VelocityView VelocityEngine autodetectVelocityEngine() Autodetect a VelocityEngine via the ApplicationContext. boolean checkResource(Locale locale) Check that the Velocity template used for this view exists and is valid. Context createVelocityContext(Map<String, Object> model) Create a Velocity Context instance for the given model, to be passed to the template for merging. Context createVelocityContext(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Create a Velocity Context instance for the given model, to be passed to the template for merging. void doRender(Context context, HttpServletResponse response) Render the Velocity view to the given response, using the given Velocity context which contains the complete template model to use. void exposeHelpers(Context velocityContext, HttpServletRequest request) Expose helpers unique to each rendering operation. void exposeHelpers(Map<String, Object> model, HttpServletRequest request) Expose helpers unique to each rendering operation. void exposeHelpers(Context velocityContext, HttpServletRequest request, HttpServletResponse response) Expose helpers unique to each rendering operation. void exposeToolAttributes(Context velocityContext, HttpServletRequest request) Expose the tool attributes, according to corresponding bean property settings. String getEncoding() Return the encoding for the Velocity template. Template getTemplate(String name) Retrieve the Velocity template specified by the given name, using the encoding specified by the "encoding" bean property. Template getTemplate() Retrieve the Velocity template to be rendered by this view. VelocityEngine getVelocityEngine() Return the VelocityEngine used by this view. void initApplicationContext() Invoked on startup. void initTool(Object tool, Context velocityContext) Initialize the given tool instance. boolean isCacheTemplate() Return whether the Velocity template should be cached. void mergeTemplate(Template template, Context context, HttpServletResponse response) Merge the template with the context. void renderMergedTemplateModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Process the model map by merging it with the Velocity template. void setCacheTemplate(boolean cacheTemplate) Set whether the Velocity template should be cached. void setDateToolAttribute(String dateToolAttribute) Set the name of the DateTool helper object to expose in the Velocity context of this view, or null if not needed. void setEncoding(String encoding) Set the encoding of the Velocity template file. void setNumberToolAttribute(String numberToolAttribute) Set the name of the NumberTool helper object to expose in the Velocity context of this view, or null if not needed. void setToolAttributes(Map<String, Class> toolAttributes) Set tool attributes to expose to the view, as attribute name / class name pairs. void setVelocityEngine(VelocityEngine velocityEngine) Set the VelocityEngine to be used by this view.
From class org.springframework.web.servlet.view.AbstractTemplateView void applyContentType(HttpServletResponse response) Apply this view's content type as specified in the "contentType" bean property to the given response. final void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view. abstract void renderMergedTemplateModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view. void setAllowRequestOverride(boolean allowRequestOverride) Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. void setAllowSessionOverride(boolean allowSessionOverride) Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. void setExposeRequestAttributes(boolean exposeRequestAttributes) Set whether all request attributes should be added to the model prior to merging with the template. void setExposeSessionAttributes(boolean exposeSessionAttributes) Set whether all HttpSession attributes should be added to the model prior to merging with the template. void setExposeSpringMacroHelpers(boolean exposeSpringMacroHelpers) Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext".
From class org.springframework.web.servlet.view.AbstractUrlBasedView void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware). boolean checkResource(Locale locale) Check whether the underlying resource that the configured URL points to actually exists. String getUrl() Return the URL of the resource that this view wraps. boolean isUrlRequired() Return whether the 'url' property is required. void setUrl(String url) Set the URL of the resource that this view wraps. String toString()
From class org.springframework.web.servlet.view.AbstractView void addStaticAttribute(String name, Object value) Add static data to this view, exposed in each view. RequestContext createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String, Object> model) Create a RequestContext to expose under the specified attribute name. ByteArrayOutputStream createTemporaryOutputStream() Create a temporary OutputStream for this view. void exposeModelAsRequestAttributes(Map<String, Object> model, HttpServletRequest request) Expose the model objects in the given map as request attributes. boolean generatesDownloadContent() Return whether this view generates download content (typically binary content like PDF or Excel files). Map<String, Object> getAttributesMap() Allow Map access to the static attributes of this view, with the option to add or override specific entries. String getBeanName() Return the view's name. String getContentType() Return the content type for this view. String getRequestContextAttribute() Return the name of the RequestContext attribute, if any. Map getStaticAttributes() Return the static attributes for this view. void prepareResponse(HttpServletRequest request, HttpServletResponse response) Prepare the given response for rendering. void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary. abstract void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view. void setAttributes(Properties attributes) Set static attributes for this view from a java.util.Properties object. void setAttributesCSV(String propString) Set static attributes as a CSV string. void setAttributesMap(Map<String, ?> attributes) Set static attributes for this view from a Map. void setBeanName(String beanName) Set the view's name. void setContentType(String contentType) Set the content type for this view. void setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for this view. String toString() void writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos) Write the given temporary OutputStream to the HTTP response.
From class org.springframework.web.context.support.WebApplicationObjectSupport final ServletContext getServletContext() Return the current ServletContext. final File getTempDir() Return the temporary directory for the current web application, as provided by the servlet container. final WebApplicationContext getWebApplicationContext() Return the current application context as WebApplicationContext. void initApplicationContext(ApplicationContext context) Calls initServletContext(javax.servlet.ServletContext) if the given ApplicationContext is a WebApplicationContext. void initServletContext(ServletContext servletContext) Subclasses may override this for custom initialization based on the ServletContext that this application object runs in. boolean isContextRequired() Overrides the base class behavior to enforce running in an ApplicationContext. final void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From class org.springframework.context.support.ApplicationObjectSupport final ApplicationContext getApplicationContext() Return the ApplicationContext that this object is associated with. final MessageSourceAccessor getMessageSourceAccessor() Return a MessageSourceAccessor for the application context used by this object, for easy message access. void initApplicationContext() Subclasses can override this for custom initialization behavior. void initApplicationContext(ApplicationContext context) Subclasses can override this for custom initialization behavior. boolean isContextRequired() Determine whether this application object needs to run in an ApplicationContext. Class requiredContextClass() Determine the context class that any context passed to setApplicationContext must be an instance of. final void setApplicationContext(ApplicationContext context) Set the ApplicationContext that this object runs in.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.BeanNameAware abstract void setBeanName(String name) Set the name of the bean in the bean factory that created this bean.
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.context.ApplicationContextAware abstract void setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
From interface org.springframework.web.context.ServletContextAware abstract void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From interface org.springframework.web.servlet.View abstract String getContentType() Return the content type of the view, if predetermined. abstract void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Render the view given the specified model.