org.craftercms.engine.view

Class CrafterPageView

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractView

org.craftercms.engine.view.CrafterPageView

All Implemented Interfaces:

org.craftercms.core.util.cache.CachingAwareObject, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.View

Direct Known Subclasses:

UserAgentAwareCrafterPageView

public class CrafterPageView
extends org.springframework.web.servlet.view.AbstractView
implements org.craftercms.core.util.cache.CachingAwareObject, org.springframework.beans.factory.InitializingBean

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	cachingTime
static String	DEFAULT_CHARSET
static String	DEFAULT_CONTENT_TYPE
protected org.springframework.web.servlet.ViewResolver	delegatedViewResolver
protected List<Object>	dependencyKeys
protected Object	key
static String	KEY_MODE_PREVIEW
static String	KEY_PAGE_MODEL
protected Locale	locale
protected String	mimeTypeXPathQuery
protected boolean	modePreview
protected SiteItem	page
protected String	pageViewNameXPathQuery
protected String	scope
protected List<Script>	scripts
protected SiteItemService	siteItemService

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

logger

Fields inherited from interface org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CrafterPageView()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependencyKey(Object dependencyKey)
void	addDependencyKeys(Collection<Object> dependencyKeys)
void	afterPropertiesSet()
protected Map<String,Object>	createScriptVariables(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model)
protected void	executeScript(Script script, Map<String,Object> scriptVariables)
Long	getCachingTime()
List<Object>	getDependencyKeys()
Object	getKey()
protected String	getMimeType()
SiteItem	getPage()
protected String	getPageViewName()
String	getScope()
boolean	removeDependencyKey(Object dependencyKey)
boolean	removeDependencyKeys(Collection<Object> dependencyKeys)
protected void	renderActualView(String pageViewName, Map<String,Object> model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	renderMergedOutputModel(Map<String,Object> model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setCachingTime(Long cachingTime)
void	setDelegatedViewResolver(org.springframework.web.servlet.ViewResolver delegatedViewResolver)
void	setDependencyKeys(List<Object> dependencyKeys)
void	setKey(Object key)
void	setLocale(Locale locale)
void	setMimeTypeXPathQuery(String mimeTypeXPathQuery)
void	setModePreview(boolean modePreview)
void	setPage(SiteItem page)
void	setPageViewNameXPathQuery(String pageViewNameXPathQuery)
void	setScope(String scope)
void	setScripts(List<Script> scripts)
void	setSiteItemService(SiteItemService siteItemService)
String	toString()

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

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposePathVariables, setRequestContextAttribute, writeToResponse

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, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

See Also:

Constant Field Values

KEY_PAGE_MODEL

public static final String KEY_PAGE_MODEL

See Also:

Constant Field Values

KEY_MODE_PREVIEW

public static final String KEY_MODE_PREVIEW

See Also:

Constant Field Values

scope

protected transient String scope

key

protected transient Object key

dependencyKeys

protected transient List<Object> dependencyKeys

cachingTime

protected transient Long cachingTime

page

protected SiteItem page

modePreview

protected boolean modePreview

locale

protected Locale locale

siteItemService

protected SiteItemService siteItemService

pageViewNameXPathQuery

protected String pageViewNameXPathQuery

mimeTypeXPathQuery

protected String mimeTypeXPathQuery

scripts

protected List<Script> scripts

delegatedViewResolver

protected org.springframework.web.servlet.ViewResolver delegatedViewResolver

Constructor Detail

CrafterPageView

public CrafterPageView()

Method Detail

getPage

public SiteItem getPage()

setPage

public void setPage(SiteItem page)

setLocale

public void setLocale(Locale locale)

setModePreview

public void setModePreview(boolean modePreview)

setSiteItemService

public void setSiteItemService(SiteItemService siteItemService)

setPageViewNameXPathQuery

public void setPageViewNameXPathQuery(String pageViewNameXPathQuery)

setMimeTypeXPathQuery

public void setMimeTypeXPathQuery(String mimeTypeXPathQuery)

setScripts

public void setScripts(List<Script> scripts)

setDelegatedViewResolver

public void setDelegatedViewResolver(org.springframework.web.servlet.ViewResolver delegatedViewResolver)

getScope

public String getScope()

Specified by:

getScope in interface org.craftercms.core.util.cache.CachingAwareObject

setScope

public void setScope(String scope)

Specified by:

setScope in interface org.craftercms.core.util.cache.CachingAwareObject

getKey

public Object getKey()

Specified by:

getKey in interface org.craftercms.core.util.cache.CachingAwareObject

setKey

public void setKey(Object key)

Specified by:

setKey in interface org.craftercms.core.util.cache.CachingAwareObject

getDependencyKeys

public List<Object> getDependencyKeys()

Specified by:

getDependencyKeys in interface org.craftercms.core.util.cache.CachingAwareObject

setDependencyKeys

public void setDependencyKeys(List<Object> dependencyKeys)

Specified by:

setDependencyKeys in interface org.craftercms.core.util.cache.CachingAwareObject

addDependencyKeys

public void addDependencyKeys(Collection<Object> dependencyKeys)

Specified by:

addDependencyKeys in interface org.craftercms.core.util.cache.CachingAwareObject

addDependencyKey

public void addDependencyKey(Object dependencyKey)

Specified by:

addDependencyKey in interface org.craftercms.core.util.cache.CachingAwareObject

removeDependencyKeys

public boolean removeDependencyKeys(Collection<Object> dependencyKeys)

Specified by:

removeDependencyKeys in interface org.craftercms.core.util.cache.CachingAwareObject

removeDependencyKey

public boolean removeDependencyKey(Object dependencyKey)

Specified by:

removeDependencyKey in interface org.craftercms.core.util.cache.CachingAwareObject

getCachingTime

public Long getCachingTime()

Specified by:

getCachingTime in interface org.craftercms.core.util.cache.CachingAwareObject

setCachingTime

public void setCachingTime(Long cachingTime)

Specified by:

setCachingTime in interface org.craftercms.core.util.cache.CachingAwareObject

toString

public String toString()

Overrides:

toString in class org.springframework.web.servlet.view.AbstractView

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

renderMergedOutputModel

protected void renderMergedOutputModel(Map<String,Object> model,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                                throws Exception

Specified by:

renderMergedOutputModel in class org.springframework.web.servlet.view.AbstractView

Throws:

Exception

executeScript

protected void executeScript(Script script,
                 Map<String,Object> scriptVariables)
                      throws Exception

Throws:

Exception

createScriptVariables

protected Map<String,Object> createScriptVariables(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       Map<String,Object> model)

getPageViewName

protected String getPageViewName()
                          throws RenderingException

Throws:

RenderingException

getMimeType

protected String getMimeType()

renderActualView

protected void renderActualView(String pageViewName,
                    Map<String,Object> model,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
                         throws Exception

Throws:

Exception