Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » web » servlet » view » velocity » [javadoc | source]
org.springframework.web.servlet.view.velocity
public class: VelocityLayoutView [javadoc | source] 
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

All Implemented Interfaces:
    InitializingBean, View, BeanNameAware, ServletContextAware, ApplicationContextAware

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.

Field Summary
public static final  String DEFAULT_LAYOUT_URL    The default layout url . 
public static final  String DEFAULT_LAYOUT_KEY    The default layout key . 
public static final  String DEFAULT_SCREEN_CONTENT_KEY    The default screen content key . 
Fields inherited from org.springframework.web.servlet.view.AbstractTemplateView:
SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE
Fields inherited from org.springframework.web.servlet.view.AbstractView:
DEFAULT_CONTENT_TYPE
Fields inherited from org.springframework.context.support.ApplicationObjectSupport:
logger
Method from org.springframework.web.servlet.view.velocity.VelocityLayoutView Summary:
checkTemplate,   doRender,   setLayoutKey,   setLayoutUrl,   setScreenContentKey
Methods from org.springframework.web.servlet.view.velocity.VelocityToolboxView:
createVelocityContext,   getToolboxConfigLocation,   initTool,   setToolboxConfigLocation
Methods from org.springframework.web.servlet.view.velocity.VelocityView:
autodetectVelocityEngine,   checkTemplate,   createVelocityContext,   createVelocityContext,   doRender,   exposeHelpers,   exposeHelpers,   exposeHelpers,   exposeToolAttributes,   getEncoding,   getTemplate,   getTemplate,   getVelocityEngine,   initApplicationContext,   initTool,   isCacheTemplate,   mergeTemplate,   renderMergedTemplateModel,   setCacheTemplate,   setDateToolAttribute,   setEncoding,   setNumberToolAttribute,   setToolAttributes,   setVelocityEngine,   setVelocityFormatterAttribute
Methods from org.springframework.web.servlet.view.AbstractTemplateView:
applyContentType,   renderMergedOutputModel,   renderMergedTemplateModel,   setAllowRequestOverride,   setAllowSessionOverride,   setExposeRequestAttributes,   setExposeSessionAttributes,   setExposeSpringMacroHelpers
Methods from org.springframework.web.servlet.view.AbstractUrlBasedView:
afterPropertiesSet,   getUrl,   isUrlRequired,   setUrl,   toString
Methods from org.springframework.web.servlet.view.AbstractView:
addStaticAttribute,   createRequestContext,   createTemporaryOutputStream,   exposeModelAsRequestAttributes,   generatesDownloadContent,   getAttributesMap,   getBeanName,   getContentType,   getRequestContextAttribute,   getStaticAttributes,   prepareResponse,   render,   renderMergedOutputModel,   setAttributes,   setAttributesCSV,   setAttributesMap,   setBeanName,   setContentType,   setRequestContextAttribute,   toString,   writeToResponse
Methods from org.springframework.web.context.support.WebApplicationObjectSupport:
getServletContext,   getTempDir,   getWebApplicationContext,   initApplicationContext,   initServletContext,   isContextRequired,   setServletContext
Methods from org.springframework.context.support.ApplicationObjectSupport:
getApplicationContext,   getMessageSourceAccessor,   initApplicationContext,   initApplicationContext,   isContextRequired,   requiredContextClass,   setApplicationContext
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.web.servlet.view.velocity.VelocityLayoutView Detail:
 protected  void checkTemplate() throws ApplicationContextException
    Overrides 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.
 protected  void doRender(Context context,
    HttpServletResponse response) throws Exception
    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). The layout template is then merged with the modified Context in the super class.
 public  void setLayoutKey(String layoutKey)
    Set the context key used to specify an alternate layout to be used instead of the default layout. Screen content templates can override the layout template that they wish to be wrapped with by setting this value in the template, for example:
    #set( $layout = "MyLayout.vm" )

    Default key is "layout" , as illustrated above.

 public  void setLayoutUrl(String layoutUrl) 
 public  void setScreenContentKey(String screenContentKey)
    Set the name of the context key that will hold the content of the screen within the layout template. This key must be present in the layout template for the current screen to be rendered.

    Default is "screen_content" : accessed in VTL as $screen_content.