org.springframework.web.servlet.view.velocity
Class VelocityViewResolver

java.lang.Object
  org.springframework.context.support.ApplicationObjectSupport
      org.springframework.web.context.support.WebApplicationObjectSupport
          org.springframework.web.servlet.view.AbstractCachingViewResolver
              org.springframework.web.servlet.view.UrlBasedViewResolver
                  org.springframework.web.servlet.view.AbstractTemplateViewResolver
                      org.springframework.web.servlet.view.velocity.VelocityViewResolver

All Implemented Interfaces:

ApplicationContextAware, ViewResolver

public class VelocityViewResolver

extends AbstractTemplateViewResolver

Convenience subclass of UrlBasedViewResolver that supports VelocityView (i.e. Velocity templates) and custom subclasses of it.

The view class for all views generated by this resolver can be specified via setViewClass. See UrlBasedViewResolver's javadocs for details.

Note: When chaining ViewResolvers, a VelocityViewResolver always needs to be last, as it will attempt to resolve any view name, no matter whether the underlying resource actually exists.

Since:

13.12.2003

Author:

Juergen Hoeller

See Also:

UrlBasedViewResolver.setViewClass(java.lang.Class), UrlBasedViewResolver.setPrefix(java.lang.String), UrlBasedViewResolver.setSuffix(java.lang.String), UrlBasedViewResolver.setRequestContextAttribute(java.lang.String), AbstractTemplateViewResolver.setExposeSpringMacroHelpers(boolean), setVelocityFormatterAttribute(java.lang.String), setDateToolAttribute(java.lang.String), setNumberToolAttribute(java.lang.String), VelocityView

Field Summary

Fields inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

VelocityViewResolver()
Sets default viewClass to VelocityView.

Method Summary

protected View	loadView(String viewName, Locale locale) Creates a new instance of the specified view class and configures it.
protected Class	requiredViewClass() Requires VelocityView.
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	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	setVelocityFormatterAttribute(String velocityFormatterAttribute) Set the name of the VelocityFormatter helper object to expose in the Velocity context of this view, or null if not needed.

Methods inherited from class org.springframework.web.servlet.view.AbstractTemplateViewResolver

setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers

Methods inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

createView, getAttributesMap, getCacheKey, initApplicationContext, setAttributes, setAttributesMap, setContentType, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass

Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

isCache, removeFromCache, resolveViewName, setCache

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, isContextRequired

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityViewResolver

public VelocityViewResolver()

Sets default viewClass to VelocityView.

See Also:

UrlBasedViewResolver.setViewClass(java.lang.Class)

Method Detail

requiredViewClass

protected Class requiredViewClass()

Requires VelocityView.

Overrides:

requiredViewClass in class AbstractTemplateViewResolver

See Also:

VelocityView

setVelocityFormatterAttribute

public void setVelocityFormatterAttribute(String velocityFormatterAttribute)

Set the name of the VelocityFormatter helper object to expose in the Velocity context of this view, or null if not needed. VelocityFormatter is part of the standard Velocity distribution.

See Also:

VelocityFormatter

setDateToolAttribute

public 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. DateTool is part of Velocity Tools 1.0.

See Also:

DateTool

setNumberToolAttribute

public 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. NumberTool is part of Velocity Tools 1.1.

See Also:

NumberTool

loadView

protected View loadView(String viewName,
                        Locale locale)
                 throws BeansException

Description copied from class: UrlBasedViewResolver

Creates a new instance of the specified view class and configures it. Does not perform any lookup for pre-defined View instances.

Overrides:

loadView in class AbstractTemplateViewResolver

Throws:

BeansException