public class

VelocityLayoutView

extends VelocityToolboxView

java.lang.Object
↳	org.springframework.context.support.ApplicationObjectSupport
	↳	org.springframework.web.context.support.WebApplicationObjectSupport
		↳	org.springframework.web.servlet.view.AbstractView
			↳	org.springframework.web.servlet.view.AbstractUrlBasedView
				↳	org.springframework.web.servlet.view.AbstractTemplateView
					↳	org.springframework.web.servlet.view.velocity.VelocityView
						↳	org.springframework.web.servlet.view.velocity.VelocityToolboxView
							↳	org.springframework.web.servlet.view.velocity.VelocityLayoutView

Class Overview

VelocityLayoutView emulates the functionality offered by Velocity's VelocityLayoutServlet to ease page composition from different templates.

The url property should be set to the content template for the view, and the layout template location should be specified as layoutUrl property. A view can override the configured layout template location by setting the appropriate key (the default is "layout") in the content template.

When the view is rendered, the VelocityContext is first merged with the content template (specified by the url property) and then merged with the layout template to produce the final output.

The layout template can include the screen content through a VelocityContext variable (the default is "screen_content"). At runtime, this variable will contain the rendered content template.

Summary

Constants
String	DEFAULT_LAYOUT_KEY	The default `layout key`.
String	DEFAULT_LAYOUT_URL	The default `layout url`.
String	DEFAULT_SCREEN_CONTENT_KEY	The default `screen content key`.

[Expand]

Inherited Constants

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

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

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

From interface org.springframework.web.servlet.View

Public Constructors
	VelocityLayoutView()

Public Methods
boolean	checkResource(Locale locale) Overrides `VelocityView.checkTemplate()` to additionally check that both the layout template and the screen content template can be loaded.
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
void	doRender(Context context, HttpServletResponse response) Overrides the normal rendering process in order to pre-process the Context, merging it with the screen template into a single value (identified by the value of screenContentKey).

[Expand]

Inherited Methods

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

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

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

From class org.springframework.context.support.ApplicationObjectSupport

From class java.lang.Object

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.beans.factory.InitializingBean

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.web.context.ServletContextAware

From interface org.springframework.web.servlet.View

Constants

public static final String DEFAULT_LAYOUT_KEY

The default layout key.

Constant Value: "layout"

public static final String DEFAULT_LAYOUT_URL

The default layout url.

Constant Value: "layout.vm"

public static final String DEFAULT_SCREEN_CONTENT_KEY

The default screen content key.

Constant Value: "screen_content"

Public Constructors

public VelocityLayoutView ()

Public Methods

public boolean checkResource (Locale locale)

Overrides VelocityView.checkTemplate() to additionally check that both the layout template and the screen content template can be loaded. Note that during rendering of the screen content, the layout template can be changed which may invalidate any early checking done here.

Parameters

locale	the desired Locale that we're looking for

Returns

true if the resource exists (or is assumed to exist); false if we know that it does not exist

Throws

Exception

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" )

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 void doRender (Context context, HttpServletResponse response)

Overrides the normal rendering process in order to pre-process the Context, merging it with the screen template into a single value (identified by the value of screenContentKey). The layout template is then merged with the modified Context in the super class.

Parameters

context	the Velocity context to use for rendering
response	servlet response (use this to get the OutputStream or Writer)

Throws

Exception

Interfaces

Classes

VelocityLayoutView

Class Overview

See Also

Summary

Constants

public static final String DEFAULT_LAYOUT_KEY

public static final String DEFAULT_LAYOUT_URL

public static final String DEFAULT_SCREEN_CONTENT_KEY

Public Constructors

public VelocityLayoutView ()

Public Methods

public boolean checkResource (Locale locale)

Parameters

Returns

Throws

public void setLayoutKey (String layoutKey)

Parameters

public void setLayoutUrl (String layoutUrl)

Parameters

public void setScreenContentKey (String screenContentKey)

Parameters

Protected Methods

protected void doRender (Context context, HttpServletResponse response)

Parameters

Throws