org.springframework.extensions.webscripts

Class ProcessorModelHelper

java.lang.Object

org.springframework.extensions.webscripts.ProcessorModelHelper

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public final class ProcessorModelHelper
extends Object
implements org.springframework.context.ApplicationContextAware

Helper to generate the model map for Script and Template execution.

The model consists of a number of context driven objects such as current page and current template and a number of common helper objects such as the URL and current user.

Author:

muzquiano, kevinr, David Draper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessorModelHelper.ScriptMessageResolver Helper to resolve I18N messages in Template level JS controller scripts

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_INLINE_JAVASCRIPT_DIRECTIVE_NAME
static String	ANCHOR_DIRECTIVE_NAME
static String	CHECKSUM_RESOURCE_DIRECTIVE_NAME
static String	CHROME_DETECTION_DIRECTIVE_NAME
static String	COMPONENT_DIRECTIVE_NAME
static String	COMPONENT_INCLUDE_DIRECTIVE_NAME
static String	CREATE_WEBSCRIPT_WIDGETS_DIRECTIVE_NAME
static String	LINK_DIRECTIVE_NAME
static String	MARKUP_DIRECTIVE_NAME
static String	MESSAGES_DIRECTIVE_NAME
static String	MODEL_APP
static String	MODEL_AUTHENTICATION
static String	MODEL_CONFIG
static String	MODEL_CONTENT
static String	MODEL_CONTEXT
static String	MODEL_DESCRIPTION
static String	MODEL_DESCRIPTION_ID
static String	MODEL_FORM_INSTANCE
static String	MODEL_FORMDATA
static String	MODEL_HEAD
static String	MODEL_ID
static String	MODEL_INSTANCE
static String	MODEL_LOCALE
static String	MODEL_MESSAGE_METHOD
static String	MODEL_PAGE
static String	MODEL_PROPERTIES
static String	MODEL_RESOURCE_URL_METHOD
static String	MODEL_RESOURCE_UTILS
static String	MODEL_SITEDATA
static String	MODEL_SURF
static String	MODEL_TEMPLATE
static String	MODEL_THEME
static String	MODEL_TITLE
static String	MODEL_TITLE_ID
static String	MODEL_URL
static String	MODEL_USER
static String	MODEL_WIDGET_UTILS
static String	PAGE_LINK_DIRECTIVE_NAME
static String	PROP_HTMLID
static String	REGION_DIRECTIVE_NAME
static String	REGION_INCLUDE_DIRECTIVE_NAME
static String	RELOCATE_JAVASCRIPT_DEPENDENCIES_DIRECTIVE_NAME
static String	RESOURCE_DIRECTIVE_NAME
static String	SCRIPT_DIRECTIVE_NAME
static String	STANDALONE_WEBSCRIPT_WRAPPER_DIRECTIVE_NAME
static String	SURFBUG_INCLUDE_DIRECTIVE_NAME

Constructor Summary

Constructors

Constructor and Description
ProcessorModelHelper() A no argument constructor is required for Spring Framework to instantiate this class as a Spring Bean.

Method Summary

Methods

Modifier and Type	Method and Description
freemarker.ext.servlet.ServletContextHashModel	getServletContextHashModel()
freemarker.ext.jsp.TaglibFactory	getTaglibFactory()
WebFrameworkConfigElement	getWebFrameworkConfigElement()
void	populateScriptModel(RequestContext context, Map<String,Object> model, ModelObject object) Populate the model for script processor.
void	populateTemplateModel(RequestContext context, Map<String,Object> model, ModelObject object) Populate the model for template processor.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) This method is provided so that the Spring Framework can set the ApplicationContext required
void	setDependencyAggregator(DependencyAggregator dependencyAggregator)
void	setDirectiveFactory(DirectiveFactory directiveFactory)
void	setScriptConfigModelInstance(org.springframework.extensions.webscripts.ScriptConfigModel scriptConfigModelInstance)
void	setServletContextHashModel(freemarker.ext.servlet.ServletContextHashModel servletContextHashModel)
void	setTaglibFactory(freemarker.ext.jsp.TaglibFactory taglibFactory)
void	setTemplateConfigModelInstance(org.springframework.extensions.webscripts.TemplateConfigModel templateConfigModelInstance)
void	setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)
void	setWebFrameworkRenderService(RenderService webFrameworkRenderService)

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_CONFIG

public static final String MODEL_CONFIG

See Also:

Constant Field Values

MODEL_HEAD

public static final String MODEL_HEAD

See Also:

Constant Field Values

MODEL_URL

public static final String MODEL_URL

See Also:

Constant Field Values

MODEL_USER

public static final String MODEL_USER

See Also:

Constant Field Values

MODEL_INSTANCE

public static final String MODEL_INSTANCE

See Also:

Constant Field Values

MODEL_CONTENT

public static final String MODEL_CONTENT

See Also:

Constant Field Values

MODEL_CONTEXT

public static final String MODEL_CONTEXT

See Also:

Constant Field Values

MODEL_SITEDATA

public static final String MODEL_SITEDATA

See Also:

Constant Field Values

MODEL_WIDGET_UTILS

public static final String MODEL_WIDGET_UTILS

See Also:

Constant Field Values

MODEL_RESOURCE_UTILS

public static final String MODEL_RESOURCE_UTILS

See Also:

Constant Field Values

MODEL_LOCALE

public static final String MODEL_LOCALE

See Also:

Constant Field Values

MODEL_TEMPLATE

public static final String MODEL_TEMPLATE

See Also:

Constant Field Values

MODEL_PAGE

public static final String MODEL_PAGE

See Also:

Constant Field Values

MODEL_PROPERTIES

public static final String MODEL_PROPERTIES

See Also:

Constant Field Values

MODEL_THEME

public static final String MODEL_THEME

See Also:

Constant Field Values

MODEL_DESCRIPTION

public static final String MODEL_DESCRIPTION

See Also:

Constant Field Values

MODEL_DESCRIPTION_ID

public static final String MODEL_DESCRIPTION_ID

See Also:

Constant Field Values

MODEL_TITLE

public static final String MODEL_TITLE

See Also:

Constant Field Values

MODEL_TITLE_ID

public static final String MODEL_TITLE_ID

See Also:

Constant Field Values

MODEL_ID

public static final String MODEL_ID

See Also:

Constant Field Values

MODEL_FORM_INSTANCE

public static final String MODEL_FORM_INSTANCE

See Also:

Constant Field Values

MODEL_FORMDATA

public static final String MODEL_FORMDATA

See Also:

Constant Field Values

MODEL_APP

public static final String MODEL_APP

See Also:

Constant Field Values

PROP_HTMLID

public static final String PROP_HTMLID

See Also:

Constant Field Values

MODEL_MESSAGE_METHOD

public static final String MODEL_MESSAGE_METHOD

See Also:

Constant Field Values

MODEL_RESOURCE_URL_METHOD

public static final String MODEL_RESOURCE_URL_METHOD

See Also:

Constant Field Values

MODEL_SURF

public static final String MODEL_SURF

See Also:

Constant Field Values

MODEL_AUTHENTICATION

public static final String MODEL_AUTHENTICATION

See Also:

Constant Field Values

REGION_DIRECTIVE_NAME

public static final String REGION_DIRECTIVE_NAME

See Also:

Constant Field Values

COMPONENT_DIRECTIVE_NAME

public static final String COMPONENT_DIRECTIVE_NAME

See Also:

Constant Field Values

REGION_INCLUDE_DIRECTIVE_NAME

public static final String REGION_INCLUDE_DIRECTIVE_NAME

See Also:

Constant Field Values

COMPONENT_INCLUDE_DIRECTIVE_NAME

public static final String COMPONENT_INCLUDE_DIRECTIVE_NAME

See Also:

Constant Field Values

MARKUP_DIRECTIVE_NAME

public static final String MARKUP_DIRECTIVE_NAME

See Also:

Constant Field Values

SURFBUG_INCLUDE_DIRECTIVE_NAME

public static final String SURFBUG_INCLUDE_DIRECTIVE_NAME

See Also:

Constant Field Values

RESOURCE_DIRECTIVE_NAME

public static final String RESOURCE_DIRECTIVE_NAME

See Also:

Constant Field Values

ANCHOR_DIRECTIVE_NAME

public static final String ANCHOR_DIRECTIVE_NAME

See Also:

Constant Field Values

PAGE_LINK_DIRECTIVE_NAME

public static final String PAGE_LINK_DIRECTIVE_NAME

See Also:

Constant Field Values

LINK_DIRECTIVE_NAME

public static final String LINK_DIRECTIVE_NAME

See Also:

Constant Field Values

MESSAGES_DIRECTIVE_NAME

public static final String MESSAGES_DIRECTIVE_NAME

See Also:

Constant Field Values

CHECKSUM_RESOURCE_DIRECTIVE_NAME

public static final String CHECKSUM_RESOURCE_DIRECTIVE_NAME

See Also:

Constant Field Values

RELOCATE_JAVASCRIPT_DEPENDENCIES_DIRECTIVE_NAME

public static final String RELOCATE_JAVASCRIPT_DEPENDENCIES_DIRECTIVE_NAME

See Also:

Constant Field Values

CREATE_WEBSCRIPT_WIDGETS_DIRECTIVE_NAME

public static final String CREATE_WEBSCRIPT_WIDGETS_DIRECTIVE_NAME

See Also:

Constant Field Values

ADD_INLINE_JAVASCRIPT_DIRECTIVE_NAME

public static final String ADD_INLINE_JAVASCRIPT_DIRECTIVE_NAME

See Also:

Constant Field Values

CHROME_DETECTION_DIRECTIVE_NAME

public static final String CHROME_DETECTION_DIRECTIVE_NAME

See Also:

Constant Field Values

STANDALONE_WEBSCRIPT_WRAPPER_DIRECTIVE_NAME

public static final String STANDALONE_WEBSCRIPT_WRAPPER_DIRECTIVE_NAME

See Also:

Constant Field Values

SCRIPT_DIRECTIVE_NAME

public static final String SCRIPT_DIRECTIVE_NAME

See Also:

Constant Field Values

Constructor Detail

ProcessorModelHelper

public ProcessorModelHelper()

A no argument constructor is required for Spring Framework to instantiate this class as a Spring Bean.

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

This method is provided so that the Spring Framework can set the ApplicationContext required

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Parameters:

applicationContext - ApplicationContext

getTaglibFactory

public freemarker.ext.jsp.TaglibFactory getTaglibFactory()

setTaglibFactory

public void setTaglibFactory(freemarker.ext.jsp.TaglibFactory taglibFactory)

getServletContextHashModel

public freemarker.ext.servlet.ServletContextHashModel getServletContextHashModel()

setServletContextHashModel

public void setServletContextHashModel(freemarker.ext.servlet.ServletContextHashModel servletContextHashModel)

getWebFrameworkConfigElement

public WebFrameworkConfigElement getWebFrameworkConfigElement()

setWebFrameworkConfigElement

public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)

setScriptConfigModelInstance

public void setScriptConfigModelInstance(org.springframework.extensions.webscripts.ScriptConfigModel scriptConfigModelInstance)

setTemplateConfigModelInstance

public void setTemplateConfigModelInstance(org.springframework.extensions.webscripts.TemplateConfigModel templateConfigModelInstance)

setWebFrameworkRenderService

public void setWebFrameworkRenderService(RenderService webFrameworkRenderService)

setDirectiveFactory

public void setDirectiveFactory(DirectiveFactory directiveFactory)

setDependencyAggregator

public void setDependencyAggregator(DependencyAggregator dependencyAggregator)

populateScriptModel

public void populateScriptModel(RequestContext context,
                       Map<String,Object> model,
                       ModelObject object)

Populate the model for script processor.

Parameters:

context - render context

model - to populate

populateTemplateModel

public void populateTemplateModel(RequestContext context,
                         Map<String,Object> model,
                         ModelObject object)
                           throws RendererExecutionException,
                                  UnsupportedEncodingException

Populate the model for template processor.

Parameters:

context - render context

model - to populate

Throws:

RendererExecutionException

UnsupportedEncodingException