View

org.springframework.web.servlet.View

Known Indirect Subclasses

AbstractAtomFeedView, AbstractExcelView, AbstractFeedView<T extends WireFeed>, AbstractJExcelView, AbstractJasperReportsSingleFormatView, AbstractJasperReportsView, AbstractPdfStamperView, AbstractPdfView, AbstractRssFeedView, AbstractTemplateView, AbstractUrlBasedView, AbstractView, AbstractXsltView, ConfigurableJasperReportsView, FreeMarkerView, and 16 others.

AbstractAtomFeedView	Abstract superclass for Atom Feed views, using java.net's ROME package.
AbstractExcelView	Convenient superclass for Excel document views.
AbstractFeedView<T extends WireFeed>	Abstract base class for Atom and RSS Feed views, using java.net's ROME package.
AbstractJExcelView	Convenient superclass for Excel document views.
AbstractJasperReportsSingleFormatView	Extends `AbstractJasperReportsView` to provide basic rendering logic for views that use a fixed format, e.g.
AbstractJasperReportsView	Base class for all JasperReports views.
AbstractPdfStamperView	Abstract superclass for PDF views that operate on an existing document with an AcroForm.
AbstractPdfView	Abstract superclass for PDF views, using Bruno Lowagie's iText package.
AbstractRssFeedView	Abstract superclass for RSS Feed views, using java.net's ROME package.
AbstractTemplateView	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.
AbstractUrlBasedView	Abstract base class for URL-based views.
AbstractView	Abstract base class for `View` implementations.
AbstractXsltView	This class is deprecated. since Spring 2.5; superseded by `XsltView` and its more flexible `locateSource(Map)` mechanism
ConfigurableJasperReportsView	Configurable JasperReports View, allowing to specify the JasperReports exporter to be specified through bean properties rather than through the view class name.
FreeMarkerView	View using the FreeMarker template engine.
InternalResourceView	Wrapper for a JSP or other resource within the same web application.
JasperReportsCsvView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in CSV format.
JasperReportsHtmlView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in HTML format.
JasperReportsMultiFormatView	Jasper Reports view class that allows for the actual rendering format to be specified at runtime using a parameter contained in the model.
JasperReportsPdfView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in PDF format.
JasperReportsXlsView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in XLS format.
JstlView	Specialization of `InternalResourceView` for JSTL pages, i.e.
MappingJacksonJsonView	Spring-MVC `View` that renders JSON content by serializing the model for the current request using Jackson's ObjectMapper.
MarshallingView	Spring-MVC `View` that allows for response context to be rendered as the result of marshalling by a `Marshaller`.
RedirectView	View that redirects to an absolute, context relative, or current request relative URL.
TilesJstlView	This class is deprecated. as of Spring 3.0
TilesView	This class is deprecated. as of Spring 3.0
VelocityLayoutView	VelocityLayoutView emulates the functionality offered by Velocity's VelocityLayoutServlet to ease page composition from different templates.
VelocityToolboxView	`VelocityView` subclass which adds support for Velocity Tools toolboxes and Velocity Tools ViewTool callbacks / Velocity Tools 1.3 init methods.
VelocityView	View using the Velocity template engine.
XsltView	XSLT-driven View that allows for response context to be rendered as the result of an XSLT transformation.

Class Overview

MVC View for a web interaction. Implementations are responsible for rendering content, and exposing the model. A single view exposes multiple model attributes.

This class and the MVC approach associated with it is discussed in Chapter 12 of Expert One-On-One J2EE Design and Development by Rod Johnson (Wrox, 2002).

View implementations may differ widely. An obvious implementation would be JSP-based. Other implementations might be XSLT-based, or use an HTML generation library. This interface is designed to avoid restricting the range of possible implementations.

Views should be beans. They are likely to be instantiated as beans by a ViewResolver. As this interface is stateless, view implementations should be thread-safe.

Summary

Fields
public static final String	RESPONSE_STATUS_ATTRIBUTE	Name of the HttpServletRequest attribute that contains the response status code.

Public Methods
abstract String	getContentType() Return the content type of the view, if predetermined.
abstract void	render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Render the view given the specified model.

Fields

public static final String RESPONSE_STATUS_ATTRIBUTE

Name of the HttpServletRequest attribute that contains the response status code.

Note: This attribute is not required to be supported by all View implementations.

Public Methods

public abstract String getContentType ()

Return the content type of the view, if predetermined.

Can be used to check the content type upfront, before the actual rendering process.

Returns

the content type String (optionally including a character set), or null if not predetermined.

public abstract void render (Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)

Render the view given the specified model.

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	Map with name Strings as keys and corresponding model objects as values (Map can also be `null` in case of empty model)
request	current HTTP request
response	HTTP response we are building

Throws

Exception	if rendering failed

Interfaces

Classes

Exceptions