org.springframework.extensions.surf.mvc

Class RegionView

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.extensions.surf.mvc.AbstractWebFrameworkView

org.springframework.extensions.surf.mvc.RegionView

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.View

public class RegionView
extends AbstractWebFrameworkView

View implementation for a Surf page region. URLs are expected to be invoked as shown:

• /regionId/{regionId} - displays a globally scoped region
• /scope/{scopeId}/regionId/{regionId}/sourceId/{sourceId} - displays a page or template scoped region

Most commonly, these are:

• scopeId: the scope of the region (i.e. 'page', 'template' or 'global')
• regionId: the id of the region (i.e. 'footer')
• sourceId: the id of the template or page instance or 'global' if in the global scope

The region is rendered along with its chrome. If a component is contained in the region, it is also rendered.

Author:

muzquiano, David Draper

Field Summary

Fields inherited from class org.springframework.extensions.surf.mvc.AbstractWebFrameworkView

MIMETYPE_HTML

Fields inherited from class org.springframework.web.servlet.view.AbstractView

DEFAULT_CONTENT_TYPE

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
RegionView(WebFrameworkConfigElement webFrameworkConfiguration, ModelObjectService modelObjectService, ResourceService resourceService, RenderService renderService, TemplatesContainer templatesContainer) This is the preferred constructor to use for instantiating a new RegionView because it allows complete flexibility when rendering the view.
RegionView(WebFrameworkServiceRegistry serviceRegistry) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	renderView(RequestContext context) To be implemented by view classes to provide render dispatch

Methods inherited from class org.springframework.extensions.surf.mvc.AbstractWebFrameworkView

exposeForwardRequestAttributes, getObjectService, getRenderService, getResourceService, getTemplatesContainer, getUriTokens, getUrlHelperFactory, getWebFrameworkConfiguration, lookupPage, populateRequestContext, renderMergedOutputModel, setupRequestContext, setUriTokens, setUrlHelperFactory, validateRequestContext

Methods inherited from class org.springframework.web.servlet.view.AbstractUrlBasedView

afterPropertiesSet, checkResource, getUrl, isUrlRequired, setUrl, toString

Methods inherited from class org.springframework.web.servlet.view.AbstractView

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RegionView

public RegionView(WebFrameworkConfigElement webFrameworkConfiguration,
          ModelObjectService modelObjectService,
          ResourceService resourceService,
          RenderService renderService,
          TemplatesContainer templatesContainer)

This is the preferred constructor to use for instantiating a new RegionView because it allows complete flexibility when rendering the view. An AbstractWebFrameworkView is typically instantiated from within a AbstractWebFrameworkViewResolver and all the arguments in the constructor signature should be supplied to the AbstractWebFrameworkViewResolver as beans via the Spring configuration.

Parameters:

webFrameworkConfiguration - WebFrameworkConfigElement

modelObjectService - ModelObjectService

resourceService - ResourceService

renderService - RenderService

templatesContainer - TemplatesContainer

RegionView

public RegionView(WebFrameworkServiceRegistry serviceRegistry)

Deprecated.

This constructor should be avoided if possible because it relies on the supplied WebFrameworkServiceRegistry argument to provide all the other Spring beans required to render the view. This means that there is no flexibility via configuration to adapt different views to use different beans.

Parameters:

serviceRegistry - WebFrameworkServiceRegistry

Method Detail

renderView

protected void renderView(RequestContext context)
                   throws Exception

Description copied from class: AbstractWebFrameworkView

To be implemented by view classes to provide render dispatch

Specified by:

renderView in class AbstractWebFrameworkView

Parameters:

context - the render context

Throws:

Exception