public class

VelocityViewResolver

extends AbstractTemplateViewResolver

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

Known Direct Subclasses

VelocityLayoutViewResolver

Class Overview

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.

Summary

[Expand]

Inherited Constants

From class org.springframework.web.servlet.view.UrlBasedViewResolver

From interface org.springframework.core.Ordered

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

Public Constructors
	VelocityViewResolver()

Public Methods
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.

Protected Methods
AbstractUrlBasedView	buildView(String viewName) Creates a new View instance of the specified view class and configures it.
void	initApplicationContext() Subclasses can override this for custom initialization behavior.
Class	requiredViewClass() Requires `VelocityView`.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.view.AbstractTemplateViewResolver

AbstractUrlBasedView	buildView(String viewName) Creates a new View instance of the specified view class and configures it.
Class	requiredViewClass() Return the required type of view for this resolver.
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.UrlBasedViewResolver

AbstractUrlBasedView	buildView(String viewName) Creates a new View instance of the specified view class and configures it.
boolean	canHandle(String viewName, Locale locale) Indicates whether or not this `ViewResolver` can handle the supplied view name.
View	createView(String viewName, Locale locale) Overridden to implement check for "redirect:" prefix.
Map<String, Object>	getAttributesMap() Allow Map access to the static attributes for views returned by this resolver, with the option to add or override specific entries.
Object	getCacheKey(String viewName, Locale locale) This implementation returns just the view name, as this ViewResolver doesn't support localized resolution.
String	getContentType() Return the content type for all views, if any.
int	getOrder() Return the order in which this `ViewResolver` is evaluated.
String	getPrefix() Return the prefix that gets prepended to view names when building a URL.
String	getRequestContextAttribute() Return the name of the RequestContext attribute for all views, if any.
String	getSuffix() Return the suffix that gets appended to view names when building a URL.
Class	getViewClass() Return the view class to be used to create views.
String[]	getViewNames() Return the view names (or name patterns) that can be handled by this `ViewResolver`.
void	initApplicationContext() Subclasses can override this for custom initialization behavior.
boolean	isRedirectContextRelative() Return whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e.
boolean	isRedirectHttp10Compatible() Return whether redirects should stay compatible with HTTP 1.0 clients.
View	loadView(String viewName, Locale locale) Delegates to `buildView` for creating a new instance of the specified view class, and applies the following Spring lifecycle methods (as supported by the generic Spring bean factory): ApplicationContextAware's `setApplicationContext` InitializingBean's `afterPropertiesSet`
Class	requiredViewClass() Return the required type of view for this resolver.
void	setAttributes(Properties props) Set static attributes from a `java.util.Properties` object, for all views returned by this resolver.
void	setAttributesMap(Map<String, ?> attributes) Set static attributes from a Map, for all views returned by this resolver.
void	setContentType(String contentType) Set the content type for all views.
void	setOrder(int order) Set the order in which this `ViewResolver` is evaluated.
void	setPrefix(String prefix) Set the prefix that gets prepended to view names when building a URL.
void	setRedirectContextRelative(boolean redirectContextRelative) Set whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e.
void	setRedirectHttp10Compatible(boolean redirectHttp10Compatible) Set whether redirects should stay compatible with HTTP 1.0 clients.
void	setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for all views.
void	setSuffix(String suffix) Set the suffix that gets appended to view names when building a URL.
void	setViewClass(Class viewClass) Set the view class that should be used to create views.
void	setViewNames(String[] viewNames) Set the view names (or name patterns) that can be handled by this `ViewResolver`.

From class org.springframework.web.servlet.view.AbstractCachingViewResolver

From class org.springframework.web.context.support.WebApplicationObjectSupport

From class org.springframework.context.support.ApplicationObjectSupport

From class java.lang.Object

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.core.Ordered

From interface org.springframework.web.context.ServletContextAware

From interface org.springframework.web.servlet.ViewResolver

Public Constructors

public VelocityViewResolver ()

Public Methods

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.

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.

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 specfied 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.

Protected Methods

protected AbstractUrlBasedView buildView (String viewName)

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

Spring lifecycle methods as defined by the bean container do not have to be called here; those will be applied by the loadView method after this method returns.

Subclasses will typically call super.buildView(viewName) first, before setting further properties themselves. loadView will then apply Spring lifecycle methods at the end of this process.

Parameters

viewName	the name of the view to build

Returns

the View instance

Throws

Exception

protected void initApplicationContext ()

Subclasses can override this for custom initialization behavior.

The default implementation is empty. Called by initApplicationContext(org.springframework.context.ApplicationContext).

protected Class requiredViewClass ()

Requires VelocityView.

Interfaces

Classes

VelocityViewResolver

Class Overview

See Also

Summary

Public Constructors

public VelocityViewResolver ()

Public Methods

public void setDateToolAttribute (String dateToolAttribute)

See Also

public void setNumberToolAttribute (String numberToolAttribute)

See Also

public void setToolboxConfigLocation (String toolboxConfigLocation)

See Also

Protected Methods

protected AbstractUrlBasedView buildView (String viewName)

Parameters

Returns

Throws

protected void initApplicationContext ()

protected Class requiredViewClass ()