public class

TilesView

extends InternalResourceView

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.InternalResourceView
					↳	org.springframework.web.servlet.view.tiles.TilesView

Known Direct Subclasses

TilesJstlView

This class is deprecated.
as of Spring 3.0

Class Overview

View implementation that retrieves a Tiles definition. The "url" property is interpreted as name of a Tiles definition.

TilesJstlView with JSTL support is a separate class, mainly to avoid JSTL dependencies in this class.

NOTE: This TilesView class supports Tiles 1.x, a.k.a. "Struts Tiles", which comes as part of Struts 1.x. For Tiles 2.x support, check out TilesView.

Depends on a Tiles DefinitionsFactory which must be available in the ServletContext. This factory is typically set up via a TilesConfigurer bean definition in the application context.

Check out ComponentControllerSupport which provides a convenient base class for Spring-aware component controllers, allowing convenient access to the Spring ApplicationContext.

Summary

[Expand]

Inherited Constants

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

Fields
public static final String	PATH_ATTRIBUTE	Name of the attribute that will override the path of the layout page to render.

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

From interface org.springframework.web.servlet.View

Public Constructors
	TilesView()

Public Methods
static void	setPath(HttpServletRequest request, String path) Set the path of the layout page to render.

Protected Methods
void	executeController(Controller controller, ComponentContext context, HttpServletRequest request, HttpServletResponse response) Execute the given Tiles controller.
ComponentContext	getComponentContext(ComponentDefinition definition, HttpServletRequest request) Determine the Tiles component context for the given Tiles definition.
ComponentDefinition	getComponentDefinition(DefinitionsFactory factory, HttpServletRequest request) Determine the Tiles component definition for the given Tiles definitions factory.
Controller	getController(ComponentDefinition definition, HttpServletRequest request) Determine and initialize the Tiles component controller for the given Tiles definition, if any.
String	getDispatcherPath(ComponentDefinition definition, HttpServletRequest request) Determine the dispatcher path for the given Tiles definition, i.e.
void	initApplicationContext() Subclasses can override this for custom initialization behavior.
String	prepareForRendering(HttpServletRequest request, HttpServletResponse response) Prepare for rendering the Tiles definition: Execute the associated component controller if any, and determine the request dispatcher path.

[Expand]

Inherited Methods

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

void	exposeForwardRequestAttributes(HttpServletRequest request) Expose the current request URI and paths as HttpServletRequest attributes under the keys defined in the Servlet 2.4 specification, for Servlet 2.3 containers as well as misbehaving Servlet 2.4 containers (such as OC4J).
void	exposeHelpers(HttpServletRequest request) Expose helpers unique to each rendering operation.
RequestDispatcher	getRequestDispatcher(HttpServletRequest request, String path) Obtain the RequestDispatcher to use for the forward/include.
HttpServletRequest	getRequestToExpose(HttpServletRequest originalRequest) Get the request handle to expose to the RequestDispatcher, i.e.
void	initServletContext(ServletContext sc) Checks whether we need to explicitly expose the Servlet 2.4 request attributes by default.
boolean	isContextRequired() An ApplicationContext is not strictly required for InternalResourceView.
String	prepareForRendering(HttpServletRequest request, HttpServletResponse response) Prepare for rendering, and determine the request dispatcher path to forward to (or to include).
void	renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Render the internal resource given the specified model.
void	setAlwaysInclude(boolean alwaysInclude) Specify whether to always include the view rather than forward to it.
void	setExposeContextBeansAsAttributes(boolean exposeContextBeansAsAttributes) Set whether to make all Spring beans in the application context accessible as request attributes, through lazy checking once an attribute gets accessed.
void	setExposeForwardAttributes(boolean exposeForwardAttributes) Set whether to explictly expose the Servlet 2.4 forward request attributes when forwarding to the underlying view resource.
void	setExposedContextBeanNames(String[] exposedContextBeanNames) Specify the names of beans in the context which are supposed to be exposed.
void	setPreventDispatchLoop(boolean preventDispatchLoop) Set whether to explicitly prevent dispatching back to the current handler path.
boolean	useInclude(HttpServletRequest request, HttpServletResponse response) Determine whether to use RequestDispatcher's `include` or `forward` method.

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

Fields

public static final String PATH_ATTRIBUTE

Name of the attribute that will override the path of the layout page to render. A Tiles component controller can set such an attribute to dynamically switch the look and feel of a Tiles page.

Public Constructors

public TilesView ()

Public Methods

public static void setPath (HttpServletRequest request, String path)

Set the path of the layout page to render.

Parameters

request	current HTTP request
path	the path of the layout page

Protected Methods

protected void executeController (Controller controller, ComponentContext context, HttpServletRequest request, HttpServletResponse response)

Execute the given Tiles controller.

Parameters

controller	the component controller to execute
context	the component context
request	current HTTP request
response	current HTTP response

Throws

Exception	if controller execution failed

protected ComponentContext getComponentContext (ComponentDefinition definition, HttpServletRequest request)

Determine the Tiles component context for the given Tiles definition.

Parameters

definition	the Tiles definition to render
request	current HTTP request

Returns

the component context

Throws

Exception	if preparations failed

protected ComponentDefinition getComponentDefinition (DefinitionsFactory factory, HttpServletRequest request)

Determine the Tiles component definition for the given Tiles definitions factory.

Parameters

factory	the Tiles definitions factory
request	current HTTP request

Returns

the component definition

Throws

Exception

protected Controller getController (ComponentDefinition definition, HttpServletRequest request)

Determine and initialize the Tiles component controller for the given Tiles definition, if any.

Parameters

definition	the Tiles definition to render
request	current HTTP request

Returns

the component controller to execute, or null if none

Throws

Exception	if preparations failed

protected String getDispatcherPath (ComponentDefinition definition, HttpServletRequest request)

Determine the dispatcher path for the given Tiles definition, i.e. the request dispatcher path of the layout page.

Parameters

definition	the Tiles definition to render
request	current HTTP request

Returns

the path of the layout page to render

Throws

Exception	if preparations failed

protected void initApplicationContext ()

Subclasses can override this for custom initialization behavior.

The default implementation is empty. Called by initApplicationContext(org.springframework.context.ApplicationContext).

Throws

ApplicationContextException

protected String prepareForRendering (HttpServletRequest request, HttpServletResponse response)

Prepare for rendering the Tiles definition: Execute the associated component controller if any, and determine the request dispatcher path.

Parameters

request	current HTTP request
response	current HTTP response

Returns

the request dispatcher path to use

Throws

Exception

Classes

TilesView

Class Overview

See Also

Summary

Fields

public static final String PATH_ATTRIBUTE

See Also

Public Constructors

public TilesView ()

Public Methods

public static void setPath (HttpServletRequest request, String path)

Parameters

See Also

Protected Methods

protected void executeController (Controller controller, ComponentContext context, HttpServletRequest request, HttpServletResponse response)

Parameters

Throws

protected ComponentContext getComponentContext (ComponentDefinition definition, HttpServletRequest request)

Parameters

Returns

Throws

protected ComponentDefinition getComponentDefinition (DefinitionsFactory factory, HttpServletRequest request)

Parameters

Returns

Throws

protected Controller getController (ComponentDefinition definition, HttpServletRequest request)

Parameters

Returns

Throws

protected String getDispatcherPath (ComponentDefinition definition, HttpServletRequest request)

Parameters

Returns

Throws

protected void initApplicationContext ()

Throws

protected String prepareForRendering (HttpServletRequest request, HttpServletResponse response)

Parameters

Returns

Throws