org.springframework.web.servlet.view.tiles2

Class TilesViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractCachingViewResolver

org.springframework.web.servlet.view.UrlBasedViewResolver

org.springframework.web.servlet.view.tiles2.TilesViewResolver

All Implemented Interfaces:

Aware, ApplicationContextAware, Ordered, ServletContextAware, ViewResolver

public class TilesViewResolver
extends UrlBasedViewResolver

Convenience subclass of UrlBasedViewResolver that supports TilesView (i.e. Tiles definitions) and custom subclasses of it.

The view class for all views generated by this resolver can be specified via the "viewClass" property. See UrlBasedViewResolver's javadoc for details.

Note: When chaining ViewResolvers, a TilesViewResolver will check for the existence of the specified template resources and only return a non-null View object if the template was actually found.

Since:

3.0

Author:

Juergen Hoeller, Sebastien Deleuze

See Also:

UrlBasedViewResolver.setViewClass(java.lang.Class<?>), UrlBasedViewResolver.setPrefix(java.lang.String), UrlBasedViewResolver.setSuffix(java.lang.String), UrlBasedViewResolver.setRequestContextAttribute(java.lang.String), TilesView

Field Summary

Fields inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

Fields inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

DEFAULT_CACHE_LIMIT

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
TilesViewResolver()

Method Summary

Modifier and Type	Method and Description
protected AbstractUrlBasedView	buildView(java.lang.String viewName) Creates a new View instance of the specified view class and configures it.
protected java.lang.Class<?>	requiredViewClass() This resolver requires TilesView.
void	setAlwaysInclude(java.lang.Boolean alwaysInclude) Specify whether to always include the view rather than forward to it.

Methods inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

canHandle, createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

clearCache, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCache, setCacheLimit, setCacheUnresolved

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TilesViewResolver

public TilesViewResolver()

Method Detail

requiredViewClass

protected java.lang.Class<?> requiredViewClass()

This resolver requires TilesView.

Overrides:

requiredViewClass in class UrlBasedViewResolver

See Also:

AbstractUrlBasedView

setAlwaysInclude

public void setAlwaysInclude(java.lang.Boolean alwaysInclude)

Specify whether to always include the view rather than forward to it.

Default is "false". Switch this flag on to enforce the use of a Servlet include, even if a forward would be possible.

Since:

4.1.2

See Also:

TilesView.setAlwaysInclude(boolean)

buildView

protected AbstractUrlBasedView buildView(java.lang.String viewName)
                                  throws java.lang.Exception

Description copied from class: UrlBasedViewResolver

Creates a new View instance of the specified view class and configures it. Does not perform any lookup for pre-defined View instances.

Spring lifecycle methods as defined by the bean container do not have to be called here; those will be applied by the loadView method after this method returns.

Subclasses will typically call super.buildView(viewName) first, before setting further properties themselves. loadView will then apply Spring lifecycle methods at the end of this process.

Overrides:

buildView in class UrlBasedViewResolver

Parameters:

viewName - the name of the view to build

Returns:

the View instance

Throws:

java.lang.Exception - if the view couldn't be resolved

See Also:

UrlBasedViewResolver.loadView(String, java.util.Locale)