Package 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	Description
protected Long	cachingTime
static final String	DEFAULT_CHARSET
static final String	DEFAULT_CONTENT_TYPE
protected org.springframework.web.servlet.ViewResolver	delegatedViewResolver
protected boolean	disableVariableRestrictions
protected Object	key
static final String	KEY_CONTENT_MODEL
static final String	KEY_MODEL	Deprecated.
protected Locale	locale
protected String	mimeTypeXPathQuery
protected SiteItem	page
static final String	PAGE_URL_ATTRIBUTE_NAME
protected String	pageViewNameXPathQuery
protected String	scope
protected List<Script>	scripts

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

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
CrafterPageView(SiteItem page, Locale locale, String pageViewNameXPathQuery, String mimeTypeXPathQuery, List<Script> scripts, org.springframework.web.servlet.ViewResolver delegatedViewResolver)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected Map<String,Object>	createScriptVariables(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Map<String,Object> model)
protected void	executeScript(Script script, Map<String,Object> scriptVariables)
Long	getCachingTime()
Object	getKey()
protected String	getMimeType()
SiteItem	getPage()
protected String	getPageViewName()
String	getScope()
protected void	renderActualView(String pageViewName, Map<String,Object> model, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	renderMergedOutputModel(Map<String,Object> model, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	setCachingTime(Long cachingTime)
void	setDisableVariableRestrictions(boolean disableVariableRestrictions)
void	setKey(Object key)
void	setScope(String scope)
String	toString()

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

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, 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, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Details

PAGE_URL_ATTRIBUTE_NAME

public static final String PAGE_URL_ATTRIBUTE_NAME

See Also:

• Constant Field Values

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_MODEL

@Deprecated
public static final String KEY_MODEL

Deprecated.

See Also:

• Constant Field Values

KEY_CONTENT_MODEL

public static final String KEY_CONTENT_MODEL

See Also:

• Constant Field Values

scope

protected transient String scope

key

protected transient Object key

cachingTime

protected transient Long cachingTime

page

protected SiteItem page

locale

protected Locale locale

pageViewNameXPathQuery

protected String pageViewNameXPathQuery

mimeTypeXPathQuery

protected String mimeTypeXPathQuery

scripts

protected List<Script> scripts

delegatedViewResolver

protected org.springframework.web.servlet.ViewResolver delegatedViewResolver

disableVariableRestrictions

protected boolean disableVariableRestrictions

Constructor Details

CrafterPageView

public CrafterPageView(SiteItem page,
 Locale locale,
 String pageViewNameXPathQuery,
 String mimeTypeXPathQuery,
 List<Script> scripts,
 org.springframework.web.servlet.ViewResolver delegatedViewResolver)

Method Details

getPage

public SiteItem getPage()

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

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

setDisableVariableRestrictions

public void setDisableVariableRestrictions(boolean disableVariableRestrictions)

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,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.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(jakarta.servlet.http.HttpServletRequest request,
 jakarta.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,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                         throws Exception

Throws:

Exception