|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.velocity.VelocityView org.springframework.web.servlet.view.velocity.VelocityToolboxView org.springframework.web.servlet.view.velocity.VelocityLayoutView
public class VelocityLayoutView
VelocityLayoutView emulates the functionality offered by Velocity's VelocityLayoutServlet to ease page composition from different templates.
The url
property should be set to the content template
for the view, and the layout template location should be specified as
layoutUrl
property. A view can override the configured
layout template location by setting the appropriate key (the default
is "layout") in the content template.
When the view is rendered, the VelocityContext is first merged with
the content template (specified by the url
property) and
then merged with the layout template to produce the final output.
The layout template can include the screen content through a VelocityContext variable (the default is "screen_content"). At runtime, this variable will contain the rendered content template.
setLayoutUrl(java.lang.String)
,
setLayoutKey(java.lang.String)
,
setScreenContentKey(java.lang.String)
Field Summary | |
---|---|
static String |
DEFAULT_LAYOUT_KEY
The default layout key . |
static String |
DEFAULT_LAYOUT_URL
The default layout url . |
static String |
DEFAULT_SCREEN_CONTENT_KEY
The default screen content key . |
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 class org.springframework.context.support.ApplicationObjectSupport |
---|
logger |
Constructor Summary | |
---|---|
VelocityLayoutView()
|
Method Summary | |
---|---|
protected void |
checkTemplate()
Overrides VelocityView.checkTemplate() to additionally check
that both the layout template and the screen content template can be loaded. |
protected void |
doRender(org.apache.velocity.context.Context context,
HttpServletResponse response)
Overrides the normal rendering process in order to pre-process the Context, merging it with the screen template into a single value (identified by the value of screenContentKey). |
void |
setLayoutKey(String layoutKey)
Set the context key used to specify an alternate layout to be used instead of the default layout. |
void |
setLayoutUrl(String layoutUrl)
Set the layout template to use. |
void |
setScreenContentKey(String screenContentKey)
Set the name of the context key that will hold the content of the screen within the layout template. |
Methods inherited from class org.springframework.web.servlet.view.velocity.VelocityToolboxView |
---|
createVelocityContext, getToolboxConfigLocation, initTool, setToolboxConfigLocation |
Methods inherited from class org.springframework.web.servlet.view.velocity.VelocityView |
---|
autodetectVelocityEngine, createVelocityContext, exposeHelpers, exposeHelpers, exposeHelpers, exposeToolAttributes, getEncoding, getTemplate, getTemplate, getVelocityEngine, initApplicationContext, isCacheTemplate, mergeTemplate, renderMergedTemplateModel, setCacheTemplate, setDateToolAttribute, setEncoding, setNumberToolAttribute, setToolAttributes, setVelocityEngine, setVelocityFormatterAttribute |
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, setUrl, toString |
Methods inherited from class org.springframework.web.servlet.view.AbstractView |
---|
addStaticAttribute, createRequestContext, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setRequestContextAttribute |
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport |
---|
getServletContext, getTempDir, getWebApplicationContext, isContextRequired, setServletContext |
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_LAYOUT_URL
layout url
.
public static final String DEFAULT_LAYOUT_KEY
layout key
.
public static final String DEFAULT_SCREEN_CONTENT_KEY
screen content key
.
Constructor Detail |
---|
public VelocityLayoutView()
Method Detail |
---|
public void setLayoutUrl(String layoutUrl)
"layout.vm"
.
layoutUrl
- the template location (relative to the template
root directory)public void setLayoutKey(String layoutKey)
#set( $layout = "MyLayout.vm" )
Default key is "layout"
, as illustrated above.
layoutKey
- the name of the key you wish to use in your
screen content templates to override the layout templatepublic void setScreenContentKey(String screenContentKey)
Default is "screen_content"
:
accessed in VTL as $screen_content
.
screenContentKey
- the name of the screen content key to useprotected void checkTemplate() throws ApplicationContextException
VelocityView.checkTemplate()
to additionally check
that both the layout template and the screen content template can be loaded.
Note that during rendering of the screen content, the layout template
can be changed which may invalidate any early checking done here.
checkTemplate
in class VelocityView
ApplicationContextException
- if the template cannot be found or is invalidprotected void doRender(org.apache.velocity.context.Context context, HttpServletResponse response) throws Exception
doRender
in class VelocityView
context
- the Velocity context to use for renderingresponse
- servlet response (use this to get the OutputStream or Writer)
Exception
- if thrown by VelocityAbstractUrlBasedView.setUrl(java.lang.String)
,
VelocityView.getTemplate()
,
VelocityView.mergeTemplate(org.apache.velocity.Template, org.apache.velocity.context.Context, javax.servlet.http.HttpServletResponse)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |