public abstract class

AbstractTemplateView

extends AbstractUrlBasedView

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

Known Direct Subclasses

FreeMarkerView, VelocityView

Known Indirect Subclasses

VelocityLayoutView, VelocityToolboxView

Class Overview

Adapter base class for template-based view technologies such as Velocity and FreeMarker, with the ability to use request and session attributes in their model and the option to expose helper objects for Spring's Velocity/FreeMarker macro library.

JSP/JSTL and other view technologies automatically have access to the HttpServletRequest object and thereby the request/session attributes for the current user. Furthermore, they are able to create and cache helper objects as request attributes themselves.

Summary

Constants
String	SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE	Variable name of the RequestContext instance in the template model, available to Spring's macros: e.g.

[Expand]

Inherited Constants

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

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

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

[Expand]

Inherited Methods

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 SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE

Variable name of the RequestContext instance in the template model, available to Spring's macros: e.g. for creating BindStatus objects.

Constant Value: "springMacroRequestContext"

Public Constructors

public AbstractTemplateView ()

Public Methods

public void setAllowRequestOverride (boolean allowRequestOverride)

Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. Default is "false", which causes an exception to be thrown if request attributes of the same name as model attributes are found.

public void setAllowSessionOverride (boolean allowSessionOverride)

Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. Default is "false", which causes an exception to be thrown if session attributes of the same name as model attributes are found.

public void setExposeRequestAttributes (boolean exposeRequestAttributes)

Set whether all request attributes should be added to the model prior to merging with the template. Default is "false".

public void setExposeSessionAttributes (boolean exposeSessionAttributes)

Set whether all HttpSession attributes should be added to the model prior to merging with the template. Default is "false".

public void setExposeSpringMacroHelpers (boolean exposeSpringMacroHelpers)

Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". Default is "true".

Currently needed for Spring's Velocity and FreeMarker default macros. Note that this is not required for templates that use HTML forms unless you wish to take advantage of the Spring helper macros.

Protected Methods

protected void applyContentType (HttpServletResponse response)

Apply this view's content type as specified in the "contentType" bean property to the given response.

When running on Servlet 2.4, only applies the view's contentType if no content type has been set on the response before. This allows handlers to override the default content type beforehand.

Parameters

response	current HTTP response

protected final void renderMergedOutputModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Subclasses must implement this method to actually render the view.

The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.

Parameters

model	combined output Map (never `null`), with dynamic values taking precedence over static attributes
request	current HTTP request
response	current HTTP response

Throws

Exception

protected abstract void renderMergedTemplateModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Subclasses must implement this method to actually render the view.

Parameters

model	combined output Map, with request attributes and session attributes merged into it if required
request	current HTTP request
response	current HTTP response

Throws

Exception	if rendering failed

Classes

AbstractTemplateView

Class Overview

See Also

Summary

Constants

public static final String SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE

Public Constructors

public AbstractTemplateView ()

Public Methods

public void setAllowRequestOverride (boolean allowRequestOverride)

public void setAllowSessionOverride (boolean allowSessionOverride)

public void setExposeRequestAttributes (boolean exposeRequestAttributes)

public void setExposeSessionAttributes (boolean exposeSessionAttributes)

public void setExposeSpringMacroHelpers (boolean exposeSpringMacroHelpers)

See Also

Protected Methods

protected void applyContentType (HttpServletResponse response)

Parameters

See Also

protected final void renderMergedOutputModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Parameters

Throws

protected abstract void renderMergedTemplateModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Parameters

Throws