org.springframework.mobile.device.view

Class AbstractDeviceDelegatingViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.mobile.device.view.AbstractDeviceDelegatingViewResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver

Direct Known Subclasses:

LiteDeviceDelegatingViewResolver

public abstract class AbstractDeviceDelegatingViewResolver
extends org.springframework.web.context.support.WebApplicationObjectSupport
implements org.springframework.web.servlet.ViewResolver, org.springframework.core.Ordered

Abstract ViewResolver implementation, providing a device aware ViewResolver wrapper that delegates to another view resolver implementation, allowing for resolution of device specific view names without the need for a dedicated mapping to be defined for each view.

Since:

1.1

Author:

Roy Clarkson

See Also:

LiteDeviceDelegatingViewResolver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FORWARD_URL_PREFIX Prefix for special view names that specify a forward URL (usually to a controller after a form has been submitted and processed).
static java.lang.String	REDIRECT_URL_PREFIX Prefix for special view names that specify a redirect URL (usually to a controller after a form has been submitted and processed).

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

Modifier	Constructor and Description
protected	AbstractDeviceDelegatingViewResolver(org.springframework.web.servlet.ViewResolver delegate) Creates a new AbstractDeviceDelegatingViewResolver

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	getDeviceViewName(java.lang.String viewName) Returns the adjusted view name as determined by subclass implementation.
protected abstract java.lang.String	getDeviceViewNameInternal(java.lang.String viewName) Subclasses must implement this method, adjusting the device view name based on device resolution used within the subclass.
protected boolean	getEnableFallback() Return whether fallback view resolution is enabled
int	getOrder()
org.springframework.web.servlet.ViewResolver	getViewResolver() Returns the delegate view resolver
protected void	initServletContext(javax.servlet.ServletContext servletContext)
org.springframework.web.servlet.View	resolveViewName(java.lang.String viewName, java.util.Locale locale)
void	setEnableFallback(boolean enableFallback) Enables support for fallback resolution, meaning if the adjusted view name cannot be resolved, and attempt will be made to resolve the original view name.
void	setOrder(int order)

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

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, isContextRequired, setServletContext

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

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

REDIRECT_URL_PREFIX

public static final java.lang.String REDIRECT_URL_PREFIX

Prefix for special view names that specify a redirect URL (usually to a controller after a form has been submitted and processed).

See Also:

Constant Field Values

FORWARD_URL_PREFIX

public static final java.lang.String FORWARD_URL_PREFIX

Prefix for special view names that specify a forward URL (usually to a controller after a form has been submitted and processed).

See Also:

Constant Field Values

Constructor Detail

AbstractDeviceDelegatingViewResolver

protected AbstractDeviceDelegatingViewResolver(org.springframework.web.servlet.ViewResolver delegate)

Creates a new AbstractDeviceDelegatingViewResolver

Parameters:

delegate - the ViewResolver in which to delegate

Method Detail

getViewResolver

public org.springframework.web.servlet.ViewResolver getViewResolver()

Returns the delegate view resolver

setOrder

public void setOrder(int order)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setEnableFallback

public void setEnableFallback(boolean enableFallback)

Enables support for fallback resolution, meaning if the adjusted view name cannot be resolved, and attempt will be made to resolve the original view name. This may be helpful in situations where not all views within a web site have device specific implementations.

Note: fallback resolution will only work when delegating to a view resolver which returns null from resolveViewName(String, Locale) if it cannot resolve a view. For example, InternalResourceViewResolver never returns null, so fallback resolution will not be available.

getEnableFallback

protected boolean getEnableFallback()

Return whether fallback view resolution is enabled

See Also:

setEnableFallback(boolean)

resolveViewName

public org.springframework.web.servlet.View resolveViewName(java.lang.String viewName,
                                                   java.util.Locale locale)
                                                     throws java.lang.Exception

Specified by:

resolveViewName in interface org.springframework.web.servlet.ViewResolver

Throws:

java.lang.Exception

getDeviceViewName

protected java.lang.String getDeviceViewName(java.lang.String viewName)

Returns the adjusted view name as determined by subclass implementation. In the case where a requested URL is prefixed with "redirect:" or "forward:", the view name will not be adjusted.

Parameters:

viewName - the name of the view before device resolution

Returns:

the adjusted view name

See Also:

getDeviceViewNameInternal(String)

getDeviceViewNameInternal

protected abstract java.lang.String getDeviceViewNameInternal(java.lang.String viewName)

Subclasses must implement this method, adjusting the device view name based on device resolution used within the subclass.

Parameters:

viewName - the name of the view before device resolution

Returns:

the adjusted view name

See Also:

getDeviceViewName(String)

initServletContext

protected void initServletContext(javax.servlet.ServletContext servletContext)

Overrides:

initServletContext in class org.springframework.web.context.support.WebApplicationObjectSupport