Package 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:
org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver
public class VelocityViewResolver extends org.springframework.web.servlet.view.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 the "viewClass" property. See UrlBasedViewResolver's javadoc for details.

Note: When chaining ViewResolvers, a VelocityViewResolver will check for the existence of the specified template resources and only return a non-null View object if the template was actually found.

Since:
13.12.2003
Author:
Juergen Hoeller
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

    org.springframework.web.servlet.view.AbstractCachingViewResolver.CacheFilter

  • Field Summary

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

    FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

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

    DEFAULT_CACHE_LIMIT

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

    logger

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    VelocityViewResolver()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.springframework.web.servlet.view.AbstractUrlBasedView
    buildView(String viewName)
     
    protected void
    initApplicationContext()
     
    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
    setToolboxConfigLocation(String toolboxConfigLocation)
    Set a Velocity Toolbox config location, for example "/WEB-INF/toolbox.xml", to automatically load a Velocity Tools toolbox definition file and expose all defined tools in the specified scopes.

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

    setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers

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

    applyLifecycleMethods, canHandle, createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRedirectHosts, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, instantiateView, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHosts, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

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

    clearCache, getCacheFilter, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCache, setCacheFilter, setCacheLimit, setCacheUnresolved

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

    getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

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

    getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • VelocityViewResolver

      public VelocityViewResolver()

  • Method Details

    • requiredViewClass

      protected Class<?> requiredViewClass()
      Requires VelocityView.
      Overrides:
      requiredViewClass in class org.springframework.web.servlet.view.AbstractTemplateViewResolver

    • 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:

    • 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:

    • setToolboxConfigLocation

      public void setToolboxConfigLocation(String toolboxConfigLocation)
      Set a Velocity Toolbox config location, 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.

      The specified location string needs to refer to a ServletContext resource, as expected by ServletToolboxManager which is part of the view package of Velocity Tools.

      Note: Specifying a toolbox config location will lead to VelocityToolboxView instances being created.

      See Also:

    • initApplicationContext

      protected void initApplicationContext()
      Overrides:
      initApplicationContext in class org.springframework.web.servlet.view.UrlBasedViewResolver

    • buildView

      protected org.springframework.web.servlet.view.AbstractUrlBasedView buildView(String viewName) throws Exception
      Overrides:
      buildView in class org.springframework.web.servlet.view.AbstractTemplateViewResolver
      Throws:
      Exception