Package org.springframework.web.servlet.view.velocity

Class VelocityLayoutView

  • All Implemented Interfaces:
    Aware, BeanNameAware, InitializingBean, ApplicationContextAware, ServletContextAware, View
    @Deprecated
public class VelocityLayoutView
extends VelocityToolboxView
    Deprecated.
    as of Spring 4.3, in favor of FreeMarker
    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.

    Since:
    1.2
    Author:
    Darren Davison, Juergen Hoeller
    See Also:
    setLayoutUrl(java.lang.String), setLayoutKey(java.lang.String), setScreenContentKey(java.lang.String)

    • Method Detail

      • setLayoutUrl

        public void setLayoutUrl​(String layoutUrl)
        Deprecated.
        Set the layout template to use. Default is "layout.vm".
        Parameters:
        layoutUrl - the template location (relative to the template root directory)

      • setLayoutKey

        public void setLayoutKey​(String layoutKey)
        Deprecated.
        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.

        Parameters:
        layoutKey - the name of the key you wish to use in your screen content templates to override the layout template

      • setScreenContentKey

        public void setScreenContentKey​(String screenContentKey)
        Deprecated.
        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.

        Parameters:
        screenContentKey - the name of the screen content key to use

      • checkResource

        public boolean checkResource​(Locale locale)
                      throws Exception
        Deprecated.
        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.
        Overrides:
        checkResource in class VelocityView
        Parameters:
        locale - the desired Locale that we're looking for
        Returns:
        true if the resource exists (or is assumed to exist); false if we know that it does not exist
        Throws:
        Exception - if the resource exists but is invalid (e.g. could not be parsed)