org.craftercms.engine.view.freemarker

Class CrafterFreeMarkerView

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractView

org.springframework.web.servlet.view.AbstractUrlBasedView

org.springframework.web.servlet.view.AbstractTemplateView

org.springframework.web.servlet.view.freemarker.FreeMarkerView

org.craftercms.engine.view.freemarker.CrafterFreeMarkerView

All Implemented Interfaces:

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

public class CrafterFreeMarkerView
extends org.springframework.web.servlet.view.freemarker.FreeMarkerView

Extends FreeMarkerView to add RenderComponentDirectives to support page component rendering in Freemarker templates and provide the Spring application context as part of the Freemarker model.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationContextAccessor	applicationContextAccessor
protected String	componentIncludeElementName
protected ScriptResolver	componentScriptResolver
protected String	componentTemplateNamePrefix
protected String	componentTemplateNameSuffix
protected String	componentTemplateXPathQuery
static String	KEY_APP_CONTEXT
static String	KEY_APP_CONTEXT_CAP
static String	KEY_APPLICATION
static String	KEY_APPLICATION_CAP
static String	KEY_COOKIES
static String	KEY_COOKIES_CAP
static String	KEY_CRAFTER_REQUEST_CONTEXT
static String	KEY_CRAFTER_REQUEST_CONTEXT_CAP
static String	KEY_ENUMS
static String	KEY_PROFILE
static String	KEY_PROFILE_CAP
static String	KEY_REQUEST
static String	KEY_REQUEST_CAP
static String	KEY_REQUEST_PARAMS
static String	KEY_REQUEST_PARAMS_CAP
static String	KEY_SESSION
static String	KEY_SESSION_CAP
static String	KEY_STATICS
static String	RENDER_COMPONENT_DIRECTIVE_NAME
protected ScriptFactory	scriptFactory
protected ServletContextHashModel	servletContextHashModel
protected SiteItemService	siteItemService

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

SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE

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

DEFAULT_CONTENT_TYPE

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

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CrafterFreeMarkerView()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.web.servlet.view.freemarker.FreeMarkerConfig	autodetectConfiguration() Instead of returning the same bean from the application context, a FreeMarkerConfig is returned for the current SiteContext.
protected freemarker.template.SimpleHash	buildTemplateModel(Map<String,Object> model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Map<String,String>	createCookieMap(javax.servlet.http.HttpServletRequest request)
protected freemarker.ext.servlet.HttpSessionHashModel	createSessionModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	initServletContext(javax.servlet.ServletContext servletContext)
void	setComponentIncludeElementName(String componentIncludeElementName)
void	setComponentScriptResolver(ScriptResolver componentScriptResolver)
void	setComponentTemplateNamePrefix(String componentTemplateNamePrefix)
void	setComponentTemplateNameSuffix(String componentTemplateNameSuffix)
void	setComponentTemplateXPathQuery(String componentTemplateXPathQuery)
void	setScriptFactory(ScriptFactory scriptFactory)
void	setSiteItemService(SiteItemService siteItemService)

Methods inherited from class org.springframework.web.servlet.view.freemarker.FreeMarkerView

checkResource, doRender, exposeHelpers, getConfiguration, getEncoding, getObjectWrapper, getTemplate, getTemplate, processTemplate, renderMergedTemplateModel, setConfiguration, setEncoding

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

applyContentType, renderMergedOutputModel, setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers

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

afterPropertiesSet, getUrl, isUrlRequired, setUrl, 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, 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

RENDER_COMPONENT_DIRECTIVE_NAME

public static final String RENDER_COMPONENT_DIRECTIVE_NAME

See Also:

Constant Field Values

KEY_APPLICATION_CAP

public static final String KEY_APPLICATION_CAP

See Also:

Constant Field Values

KEY_APPLICATION

public static final String KEY_APPLICATION

See Also:

Constant Field Values

KEY_SESSION_CAP

public static final String KEY_SESSION_CAP

See Also:

Constant Field Values

KEY_SESSION

public static final String KEY_SESSION

See Also:

Constant Field Values

KEY_REQUEST_CAP

public static final String KEY_REQUEST_CAP

See Also:

Constant Field Values

KEY_REQUEST

public static final String KEY_REQUEST

See Also:

Constant Field Values

KEY_REQUEST_PARAMS_CAP

public static final String KEY_REQUEST_PARAMS_CAP

See Also:

Constant Field Values

KEY_REQUEST_PARAMS

public static final String KEY_REQUEST_PARAMS

See Also:

Constant Field Values

KEY_APP_CONTEXT_CAP

public static final String KEY_APP_CONTEXT_CAP

See Also:

Constant Field Values

KEY_APP_CONTEXT

public static final String KEY_APP_CONTEXT

See Also:

Constant Field Values

KEY_COOKIES_CAP

public static final String KEY_COOKIES_CAP

See Also:

Constant Field Values

KEY_COOKIES

public static final String KEY_COOKIES

See Also:

Constant Field Values

KEY_PROFILE_CAP

public static final String KEY_PROFILE_CAP

See Also:

Constant Field Values

KEY_PROFILE

public static final String KEY_PROFILE

See Also:

Constant Field Values

KEY_CRAFTER_REQUEST_CONTEXT_CAP

public static final String KEY_CRAFTER_REQUEST_CONTEXT_CAP

See Also:

Constant Field Values

KEY_CRAFTER_REQUEST_CONTEXT

public static final String KEY_CRAFTER_REQUEST_CONTEXT

See Also:

Constant Field Values

KEY_STATICS

public static final String KEY_STATICS

See Also:

Constant Field Values

KEY_ENUMS

public static final String KEY_ENUMS

See Also:

Constant Field Values

siteItemService

protected SiteItemService siteItemService

scriptFactory

protected ScriptFactory scriptFactory

componentTemplateXPathQuery

protected String componentTemplateXPathQuery

componentTemplateNamePrefix

protected String componentTemplateNamePrefix

componentTemplateNameSuffix

protected String componentTemplateNameSuffix

componentIncludeElementName

protected String componentIncludeElementName

componentScriptResolver

protected ScriptResolver componentScriptResolver

servletContextHashModel

protected ServletContextHashModel servletContextHashModel

applicationContextAccessor

protected ApplicationContextAccessor applicationContextAccessor

Constructor Detail

CrafterFreeMarkerView

public CrafterFreeMarkerView()

Method Detail

initServletContext

protected void initServletContext(javax.servlet.ServletContext servletContext)
                           throws org.springframework.beans.BeansException

Overrides:

initServletContext in class org.springframework.web.servlet.view.freemarker.FreeMarkerView

Throws:

org.springframework.beans.BeansException

setSiteItemService

public void setSiteItemService(SiteItemService siteItemService)

setScriptFactory

public void setScriptFactory(ScriptFactory scriptFactory)

setComponentTemplateXPathQuery

public void setComponentTemplateXPathQuery(String componentTemplateXPathQuery)

setComponentTemplateNamePrefix

public void setComponentTemplateNamePrefix(String componentTemplateNamePrefix)

setComponentTemplateNameSuffix

public void setComponentTemplateNameSuffix(String componentTemplateNameSuffix)

setComponentIncludeElementName

public void setComponentIncludeElementName(String componentIncludeElementName)

setComponentScriptResolver

public void setComponentScriptResolver(ScriptResolver componentScriptResolver)

autodetectConfiguration

protected org.springframework.web.servlet.view.freemarker.FreeMarkerConfig autodetectConfiguration()
                                                                                            throws org.springframework.beans.BeansException

Instead of returning the same bean from the application context, a FreeMarkerConfig is returned for the current SiteContext.

Overrides:

autodetectConfiguration in class org.springframework.web.servlet.view.freemarker.FreeMarkerView

Throws:

org.springframework.beans.BeansException

buildTemplateModel

protected freemarker.template.SimpleHash buildTemplateModel(Map<String,Object> model,
                                                javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)

Overrides:

buildTemplateModel in class org.springframework.web.servlet.view.freemarker.FreeMarkerView

createSessionModel

protected freemarker.ext.servlet.HttpSessionHashModel createSessionModel(javax.servlet.http.HttpServletRequest request,
                                                             javax.servlet.http.HttpServletResponse response)

createCookieMap

protected Map<String,String> createCookieMap(javax.servlet.http.HttpServletRequest request)