org.springframework.web.servlet.view.velocity: public class: VelocityLayoutViewResolver

org.springframework.web.servlet.view.velocity
public class: VelocityLayoutViewResolver [javadoc | source]

java.lang.Object
   org.springframework.context.support.ApplicationObjectSupport
      org.springframework.web.context.support.WebApplicationObjectSupport
         org.springframework.web.servlet.view.AbstractCachingViewResolver
            org.springframework.web.servlet.view.UrlBasedViewResolver
               org.springframework.web.servlet.view.AbstractTemplateViewResolver
                  org.springframework.web.servlet.view.velocity.VelocityViewResolver
                     org.springframework.web.servlet.view.velocity.VelocityLayoutViewResolver

All Implemented Interfaces:
Ordered, ViewResolver, ServletContextAware, ApplicationContextAware

Convenience subclass of VelocityViewResolver, adding support for VelocityLayoutView and its properties.

See VelocityViewResolver's javadoc for general usage info.

Also see:

author: Juergen - Hoeller

since: 1.2.7 -

Fields inherited from org.springframework.web.servlet.view.UrlBasedViewResolver:
REDIRECT_URL_PREFIX, FORWARD_URL_PREFIX

Fields inherited from org.springframework.context.support.ApplicationObjectSupport:
logger

Method from org.springframework.web.servlet.view.velocity.VelocityLayoutViewResolver Summary:
buildView, requiredViewClass, setLayoutKey, setLayoutUrl, setScreenContentKey

Methods from org.springframework.web.servlet.view.velocity.VelocityViewResolver:
buildView, initApplicationContext, requiredViewClass, setDateToolAttribute, setNumberToolAttribute, setToolboxConfigLocation, setVelocityFormatterAttribute

Methods from org.springframework.web.servlet.view.AbstractTemplateViewResolver:
buildView, requiredViewClass, setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers

Methods from org.springframework.web.servlet.view.UrlBasedViewResolver:
buildView, canHandle, createView, getAttributesMap, getCacheKey, getContentType, getOrder, getPrefix, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, requiredViewClass, setAttributes, setAttributesMap, setContentType, setOrder, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods from org.springframework.web.servlet.view.UrlBasedViewResolver:

buildView, canHandle, createView, getAttributesMap, getCacheKey, getContentType, getOrder, getPrefix, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, requiredViewClass, setAttributes, setAttributesMap, setContentType, setOrder, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods from org.springframework.web.servlet.view.AbstractCachingViewResolver:
clearCache, createView, getCacheKey, isCache, loadView, removeFromCache, resolveViewName, setCache

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.VelocityLayoutViewResolver Detail:
protected AbstractUrlBasedView buildView(String viewName) throws Exception { VelocityLayoutView view = (VelocityLayoutView) super.buildView(viewName); // Use not-null checks to preserve VelocityLayoutView's defaults. if (this.layoutUrl != null) { view.setLayoutUrl(this.layoutUrl); } if (this.layoutKey != null) { view.setLayoutKey(this.layoutKey); } if (this.screenContentKey != null) { view.setScreenContentKey(this.screenContentKey); } return view; }
protected Class requiredViewClass() { return VelocityLayoutView.class; } Requires VelocityLayoutView.
public void setLayoutKey(String layoutKey) { this.layoutKey = 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" )` The default key is "layout", as illustrated above.
public void setLayoutUrl(String layoutUrl) { this.layoutUrl = layoutUrl; } Set the layout template to use. Default is "layout.vm".
public void setScreenContentKey(String screenContentKey) { this.screenContentKey = 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`.

Method from org.springframework.web.servlet.view.velocity.VelocityLayoutViewResolver Detail:

 protected AbstractUrlBasedView buildView(String viewName) throws Exception {
		VelocityLayoutView view = (VelocityLayoutView) super.buildView(viewName);
		// Use not-null checks to preserve VelocityLayoutView's defaults.
		if (this.layoutUrl != null) {
			view.setLayoutUrl(this.layoutUrl);
		}
		if (this.layoutKey != null) {
			view.setLayoutKey(this.layoutKey);
		}
		if (this.screenContentKey != null) {
			view.setScreenContentKey(this.screenContentKey);
		}
		return view;
}

 protected Class requiredViewClass() {
		return VelocityLayoutView.class;
}

Requires VelocityLayoutView.

 public  void setLayoutKey(String layoutKey) {
		this.layoutKey = layoutKey;
}

#set( $layout = "MyLayout.vm" )

The default key is "layout", as illustrated above.

 public  void setLayoutUrl(String layoutUrl) {
		this.layoutUrl = layoutUrl;
}

Set the layout template to use. Default is "layout.vm".

 public  void setScreenContentKey(String screenContentKey) {
		this.screenContentKey = screenContentKey;
}

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