org.springframework.extensions.webscripts
Class ScriptRenderContext

java.lang.Object
  extended by org.springframework.extensions.webscripts.ScriptBase
      extended by org.springframework.extensions.webscripts.ScriptRenderContext
All Implemented Interfaces:
Serializable

public final class ScriptRenderContext
extends ScriptBase

A root-scoped Java object that wraps the Render Context object.

Author:
muzquiano
See Also:
Serialized Form

Field Summary
protected  ScriptableMap<String,Serializable> attributes
           
protected  ScriptableMap<String,Serializable> headers
           
protected  ScriptableMap<String,Serializable> parameters
           
 
Fields inherited from class org.springframework.extensions.webscripts.ScriptBase
context, properties
 
Constructor Summary
ScriptRenderContext(RenderContext context)
          Constructs a new ScriptRequestContext object.
 
Method Summary
protected  ScriptableMap buildProperties()
           
 ScriptableMap getAttributes()
           
 boolean getAuthenticated()
           
 String getContentId()
           
 boolean getExternalAuthentication()
           
 String getFormatId()
           
 String getFrameworkTitle()
           
 String getFrameworkVersion()
           
 ScriptableMap getHeaders()
           
 String getId()
           
 ScriptLinkBuilder getLinkBuilder()
           
 ScriptModelObject getPage()
           
 String getPageId()
           
 ScriptableMap getParameters()
           
 String getPreviewStoreId()
           
 String getPreviewUserId()
           
 String getPreviewWebappId()
           
 ScriptResource getResource()
           
 ScriptModelObject getRootPage()
           
 ScriptModelObject getSiteConfiguration()
           
 ScriptModelObject getTemplate()
           
 String getTemplateId()
           
 ScriptModelObject getTheme()
           
 String getThemeId()
           
 String getUri()
           
 ScriptUser getUser()
           
 String getWebsiteTitle()
           
 ScriptResource loadResource(String resourceId)
           
 ScriptResource loadResource(String protocolId, String endpointId, String objectId)
           
 void setThemeId(String themeId)
           
 void setValue(String key, Object value)
           
 
Methods inherited from class org.springframework.extensions.webscripts.ScriptBase
getConfig, getObject, getObjectService, getProperties, getRequestContext, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

parameters

protected ScriptableMap<String,Serializable> parameters

attributes

protected ScriptableMap<String,Serializable> attributes

headers

protected ScriptableMap<String,Serializable> headers
Constructor Detail

ScriptRenderContext

public ScriptRenderContext(RenderContext context)
Constructs a new ScriptRequestContext object.

Parameters:
context - The RenderContext instance for the current request
Method Detail

buildProperties

protected ScriptableMap buildProperties()
Specified by:
buildProperties in class ScriptBase

setValue

public void setValue(String key,
                     Object value)

getContentId

public String getContentId()

getResource

public ScriptResource getResource()

getFormatId

public String getFormatId()

getId

public String getId()

getPageId

public String getPageId()

getPage

public ScriptModelObject getPage()

getTemplateId

public String getTemplateId()

getTemplate

public ScriptModelObject getTemplate()

getThemeId

public String getThemeId()

getTheme

public ScriptModelObject getTheme()

setThemeId

public void setThemeId(String themeId)

getSiteConfiguration

public ScriptModelObject getSiteConfiguration()

getUser

public ScriptUser getUser()

getAuthenticated

public boolean getAuthenticated()

getExternalAuthentication

public boolean getExternalAuthentication()

getLinkBuilder

public ScriptLinkBuilder getLinkBuilder()

getWebsiteTitle

public String getWebsiteTitle()

getUri

public String getUri()

getRootPage

public ScriptModelObject getRootPage()

getPreviewWebappId

public String getPreviewWebappId()

getPreviewStoreId

public String getPreviewStoreId()

getPreviewUserId

public String getPreviewUserId()

getFrameworkTitle

public String getFrameworkTitle()

getFrameworkVersion

public String getFrameworkVersion()

loadResource

public ScriptResource loadResource(String resourceId)

loadResource

public ScriptResource loadResource(String protocolId,
                                   String endpointId,
                                   String objectId)

getParameters

public ScriptableMap getParameters()

getAttributes

public ScriptableMap getAttributes()

getHeaders

public ScriptableMap getHeaders()


Copyright © 2009-2010 SpringSource, Inc. All Rights Reserved.