org.springframework.extensions.surf.render
Interface RenderContext

All Superinterfaces:

RequestContext, Serializable

All Known Implementing Classes:

AbstractRenderContext, DefaultRenderContext, WrappedRenderContext

public interface RenderContext
extends RequestContext

Defines a render response context

Author:

muzquiano

Field Summary

Fields inherited from interface org.springframework.extensions.surf.RequestContext

ATTR_REQUEST_CONTEXT, DEBUG_MODE_VALUE_COMPONENTS, VALUE_CREDENTIAL_VAULT, VALUE_HEAD_TAGS, VALUE_IDENTITY_VAULT

Method Summary

ModelObject	getObject()
RenderContextProvider	getProvider()
String	getRenderId()
RenderMode	getRenderMode()
javax.servlet.http.HttpServletResponse	getResponse()
Serializable	getValue(String key, RenderContextScope scope)
boolean	hasValue(String key, RenderContextScope scope)
boolean	isPassiveMode()
void	release() Release any resources held by the request context As part of the contract for a RequestContext object, this will only ever be called once and no further method calls will be made to the RequestContext object.
void	removeValue(String key, RenderContextScope scope)
void	setObject(ModelObject modelObject)
void	setPassiveMode(boolean passiveMode)
void	setRenderMode(RenderMode renderMode)
void	setRequest(javax.servlet.http.HttpServletRequest request)
void	setResponse(javax.servlet.http.HttpServletResponse response)
void	setValue(String key, Serializable value, RenderContextScope scope)

Methods inherited from interface org.springframework.extensions.surf.RequestContext

getCredentialVault, getCurrentObject, getCurrentObjectId, getFormatId, getId, getLinkBuilder, getModel, getPage, getPageId, getPageTitle, getParameter, getParameters, getRenderingComponents, getRequest, getRequestContent, getRequestContentType, getRequestMethod, getRootPage, getServiceRegistry, getSiteConfiguration, getTemplate, getTemplateId, getTheme, getThemeId, getUri, getUser, getUserId, getValue, getValuesMap, getViewModel, getWebsiteTitle, hasParameter, hasValue, removeValue, setCurrentObject, setFormatId, setModel, setPage, setRenderingComponent, setTemplate, setThemeId, setUri, setUser, setValue, setViewModel

Method Detail

getRenderMode

RenderMode getRenderMode()

setRenderMode

void setRenderMode(RenderMode renderMode)

setRequest

void setRequest(javax.servlet.http.HttpServletRequest request)

getResponse

javax.servlet.http.HttpServletResponse getResponse()

setResponse

void setResponse(javax.servlet.http.HttpServletResponse response)

getObject

ModelObject getObject()

setObject

void setObject(ModelObject modelObject)

getRenderId

String getRenderId()

setPassiveMode

void setPassiveMode(boolean passiveMode)

isPassiveMode

boolean isPassiveMode()

getProvider

RenderContextProvider getProvider()

release

void release()

Description copied from interface: RequestContext

Release any resources held by the request context As part of the contract for a RequestContext object, this will only ever be called once and no further method calls will be made to the RequestContext object.

Specified by:

release in interface RequestContext

setValue

void setValue(String key,
              Serializable value,
              RenderContextScope scope)

getValue

Serializable getValue(String key,
                      RenderContextScope scope)

removeValue

void removeValue(String key,
                 RenderContextScope scope)

hasValue

boolean hasValue(String key,
                 RenderContextScope scope)