public class

VelocityLayoutViewResolver

extends 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
						↳	org.springframework.web.servlet.view.velocity.VelocityLayoutViewResolver

Class Overview

Convenience subclass of VelocityViewResolver, adding support for VelocityLayoutView and its properties.

See VelocityViewResolver's javadoc for general usage info.

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
	VelocityLayoutViewResolver()

Public Methods
void	setLayoutKey(String layoutKey) Set the context key used to specify an alternate layout to be used instead of the default layout.
void	setLayoutUrl(String layoutUrl) Set the layout template to use.
void	setScreenContentKey(String screenContentKey) Set the name of the context key that will hold the content of the screen within the layout template.

Protected Methods
AbstractUrlBasedView	buildView(String viewName) Creates a new View instance of the specified view class and configures it.
Class	requiredViewClass() Requires VelocityLayoutView.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.view.velocity.VelocityViewResolver

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 VelocityLayoutViewResolver ()

Public Methods

public void setLayoutKey (String layoutKey)

Set the context key used to specify an alternate layout to be used instead of the default layout. Screen content templates can override the layout template that they wish to be wrapped with by setting this value in the template, for example:
#set( $layout = "MyLayout.vm" )

The default key is "layout", as illustrated above.

Parameters

layoutKey	the name of the key you wish to use in your screen content templates to override the layout template

public void setLayoutUrl (String layoutUrl)

Set the layout template to use. Default is "layout.vm".

Parameters

layoutUrl	the template location (relative to the template root directory)

public void setScreenContentKey (String screenContentKey)

Set the name of the context key that will hold the content of the screen within the layout template. This key must be present in the layout template for the current screen to be rendered.

Default is "screen_content": accessed in VTL as $screen_content.

Parameters

screenContentKey	the name of the screen content key to use

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 Class requiredViewClass ()

Requires VelocityLayoutView.

Interfaces

Classes

VelocityLayoutViewResolver

Class Overview

See Also

Summary

Public Constructors

public VelocityLayoutViewResolver ()

Public Methods

public void setLayoutKey (String layoutKey)

Parameters

See Also

public void setLayoutUrl (String layoutUrl)

Parameters

See Also

public void setScreenContentKey (String screenContentKey)

Parameters

See Also

Protected Methods

protected AbstractUrlBasedView buildView (String viewName)

Parameters

Returns

Throws

protected Class requiredViewClass ()

See Also