org.springframework.mobile.device.view

Class LiteDeviceDelegatingViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.mobile.device.view.AbstractDeviceDelegatingViewResolver

org.springframework.mobile.device.view.LiteDeviceDelegatingViewResolver

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

public class LiteDeviceDelegatingViewResolver
extends AbstractDeviceDelegatingViewResolver

A lightweight AbstractDeviceDelegatingViewResolver for adjusting a view based on the combination of resolved Device and specified SitePreference. View names can be augmented with a specified prefix or suffix.

Specify the prefix for the different device types. Default prefixes are empty strings. For the requested view name of "home", the following table illustrates how the view name will be adjusted based on device type.

Resolved Device	Method	Prefix	Adjusted View
Normal	setNormalPrefix(String)	"normal/"	"normal/home"
Mobile	setMobilePrefix(String)	"mobile/"	"mobile/home"
Tablet	setTabletPrefix(String)	"tablet/"	"tablet/home"

Alternatively, you may want to have the views adjusted to use a suffix for each device type. Again, using the requested view name of "home", the following table shows the adjusted view names.

Resolved Device	Method	Suffix	Adjusted View
Normal	setNormalSuffix(String)	".normal"	"home.normal"
Mobile	setMobileSuffix(String)	".mobile"	"home.mobile"
Tablet	setTabletSuffix(String)	".tablet"	"home.tablet"

It is also possible to use a combination of prefix and suffix. The view resolver will apply both to the adjusted view.

Since:

1.1

Author:

Scott Rossillo, Roy Clarkson

See Also:

ViewResolver, ContentNegotiatingViewResolver

Field Summary

Fields inherited from class org.springframework.mobile.device.view.AbstractDeviceDelegatingViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

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
LiteDeviceDelegatingViewResolver(org.springframework.web.servlet.ViewResolver delegate) Creates a new LiteDeviceDelegatingViewResolver

Method Summary

Methods

Modifier and Type	Method and Description
protected 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 java.lang.String	getMobilePrefix() Return the prefix that gets prepended to view names for mobile devices
protected java.lang.String	getMobileSuffix() Return the suffix that gets appended to view names for mobile devices
protected java.lang.String	getNormalPrefix() Return the prefix that gets prepended to view names for normal devices
protected java.lang.String	getNormalSuffix() Return the suffix that gets appended to view names for normal devices
protected java.lang.String	getTabletPrefix() Return the prefix that gets prepended to view names for tablet devices
protected java.lang.String	getTabletSuffix() Return the suffix that gets appended to view names for tablet devices
void	setMobilePrefix(java.lang.String mobilePrefix) Set the prefix that gets prepended to view names for mobile devices.
void	setMobileSuffix(java.lang.String mobileSuffix) Set the suffix that gets appended to view names for mobile devices
void	setNormalPrefix(java.lang.String normalPrefix) Set the prefix that gets prepended to view names for normal devices.
void	setNormalSuffix(java.lang.String normalSuffix) Set the suffix that gets appended to view names for normal devices.
void	setTabletPrefix(java.lang.String tabletPrefix) Set the prefix that gets prepended to view names for tablet devices.
void	setTabletSuffix(java.lang.String tabletSuffix) Set the suffix that gets appended to view names for tablet devices

Methods inherited from class org.springframework.mobile.device.view.AbstractDeviceDelegatingViewResolver

getDeviceViewName, getEnableFallback, getOrder, getViewResolver, initServletContext, resolveViewName, setEnableFallback, setOrder

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

Constructor Detail

LiteDeviceDelegatingViewResolver

public LiteDeviceDelegatingViewResolver(org.springframework.web.servlet.ViewResolver delegate)

Creates a new LiteDeviceDelegatingViewResolver

Parameters:

delegate - the ViewResolver in which to delegate

Method Detail

setNormalPrefix

public void setNormalPrefix(java.lang.String normalPrefix)

Set the prefix that gets prepended to view names for normal devices.

getNormalPrefix

protected java.lang.String getNormalPrefix()

Return the prefix that gets prepended to view names for normal devices

setMobilePrefix

public void setMobilePrefix(java.lang.String mobilePrefix)

Set the prefix that gets prepended to view names for mobile devices.

getMobilePrefix

protected java.lang.String getMobilePrefix()

Return the prefix that gets prepended to view names for mobile devices

setTabletPrefix

public void setTabletPrefix(java.lang.String tabletPrefix)

Set the prefix that gets prepended to view names for tablet devices.

getTabletPrefix

protected java.lang.String getTabletPrefix()

Return the prefix that gets prepended to view names for tablet devices

setNormalSuffix

public void setNormalSuffix(java.lang.String normalSuffix)

Set the suffix that gets appended to view names for normal devices.

getNormalSuffix

protected java.lang.String getNormalSuffix()

Return the suffix that gets appended to view names for normal devices

setMobileSuffix

public void setMobileSuffix(java.lang.String mobileSuffix)

Set the suffix that gets appended to view names for mobile devices

getMobileSuffix

protected java.lang.String getMobileSuffix()

Return the suffix that gets appended to view names for mobile devices

setTabletSuffix

public void setTabletSuffix(java.lang.String tabletSuffix)

Set the suffix that gets appended to view names for tablet devices

getTabletSuffix

protected java.lang.String getTabletSuffix()

Return the suffix that gets appended to view names for tablet devices

getDeviceViewNameInternal

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

Description copied from class: AbstractDeviceDelegatingViewResolver

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

Specified by:

getDeviceViewNameInternal in class AbstractDeviceDelegatingViewResolver

Parameters:

viewName - the name of the view before device resolution

Returns:

the adjusted view name

See Also:

AbstractDeviceDelegatingViewResolver.getDeviceViewName(String)