public abstract class

AbstractUrlBasedView

extends AbstractView
implements InitializingBean

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

Known Direct Subclasses

AbstractJasperReportsView, AbstractPdfStamperView, AbstractTemplateView, InternalResourceView, RedirectView, TilesView, XsltView

Known Indirect Subclasses

AbstractJasperReportsSingleFormatView, ConfigurableJasperReportsView, FreeMarkerView, JasperReportsCsvView, JasperReportsHtmlView, JasperReportsMultiFormatView, JasperReportsPdfView, JasperReportsXlsView, JstlView, TilesJstlView, TilesView, VelocityLayoutView, VelocityToolboxView, VelocityView

AbstractJasperReportsSingleFormatView	Extends `AbstractJasperReportsView` to provide basic rendering logic for views that use a fixed format, e.g.
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.
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.
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.

Class Overview

Abstract base class for URL-based views. Provides a consistent way of holding the URL that a View wraps, in the form of a "url" bean property.

Summary

[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

Protected Constructors
	AbstractUrlBasedView() Constructor for use as a bean.
	AbstractUrlBasedView(String url) Create a new AbstractUrlBasedView with the given URL.

Public Methods
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
boolean	checkResource(Locale locale) Check whether the underlying resource that the configured URL points to actually exists.
String	getUrl() Return the URL of the resource that this view wraps.
void	setUrl(String url) Set the URL of the resource that this view wraps.
String	toString()

Protected Methods
boolean	isUrlRequired() Return whether the 'url' property is required.

[Expand]

Inherited Methods

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

Protected Constructors

protected AbstractUrlBasedView ()

Constructor for use as a bean.

protected AbstractUrlBasedView (String url)

Create a new AbstractUrlBasedView with the given URL.

Parameters

url	the URL to forward to

Public Methods

public void afterPropertiesSet ()

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Throws

Exception

public boolean checkResource (Locale locale)

Check whether the underlying resource that the configured URL points to actually exists.

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	if the resource exists but is invalid (e.g. could not be parsed)

public String getUrl ()

Return the URL of the resource that this view wraps.

public void setUrl (String url)

Set the URL of the resource that this view wraps. The URL must be appropriate for the concrete View implementation.

public String toString ()

Protected Methods

protected boolean isUrlRequired ()

Return whether the 'url' property is required.

The default implementation returns true











Generated by Doclava.

Classes

AbstractUrlBasedView

Class Overview

Summary

Protected Constructors

protected AbstractUrlBasedView ()

protected AbstractUrlBasedView (String url)

Parameters

Public Methods

public void afterPropertiesSet ()

Throws

public boolean checkResource (Locale locale)

Parameters

Returns

Throws

public String getUrl ()

public void setUrl (String url)

public String toString ()

Protected Methods

protected boolean isUrlRequired ()