com.communote.server.web.commons.controller

Class VelocityViewController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

com.communote.server.web.commons.controller.VelocityViewController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

EditBlogViewController, InitialFiltersViewController, StaticPageVelocityViewController, UserProfileController

public class VelocityViewController
extends org.springframework.web.servlet.mvc.AbstractController

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

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

logger

Constructor Summary

Constructors

Constructor and Description
VelocityViewController()

Method Summary

Modifier and Type	Method and Description
protected String	getContentTemplate(Map<String,Object> model) Returns the template to be used for rendering the view
protected String	getPage()
protected String	getSelectedMenu(Map<String,Object> model) Returns the identifier to be exported as selected menu.
String	getView()
protected org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	prepareModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Prepares the model by adding the key value pairs.
void	setContentTemplate(String contentTemplate) Set the template to be rendered as view.
void	setCssCategories(String[] categories) Set the names of the categories whose CSS resources should be included when rendering the page
void	setJavaScriptCategories(String[] categories) Set the names of the categories whose JavaScript resources should be included when rendering the page
void	setPage(String page)
void	setSelectedMenu(String menuIdentifier) Set the identifier to be exported as selected menu.
void	setTemplateManager(TemplateManager templateManager) Set the template manager to use for resolving template names into templates
void	setView(String view)

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

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, toString, wait, wait, wait

Constructor Detail

VelocityViewController

public VelocityViewController()

Method Detail

getContentTemplate

protected String getContentTemplate(Map<String,Object> model)

Returns the template to be used for rendering the view

Parameters:

model - the current model of the model and view

Returns:

the contentTemplate

See Also:

setContentTemplate(String)

getPage

protected String getPage()

Returns:

the page

getSelectedMenu

protected String getSelectedMenu(Map<String,Object> model)

Returns the identifier to be exported as selected menu.

Parameters:

model - the current model of the model and view

Returns:

the selected menu

See Also:

setSelectedMenu(String)

getView

public String getView()

Returns:

the view

handleRequestInternal

protected org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception

Specified by:

handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractController

Throws:

Exception

prepareModel

protected boolean prepareModel(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               Map<String,Object> model)
                        throws Exception

Prepares the model by adding the key value pairs.

Parameters:

request - the request

response - the response

model - the model to prepare

Returns:

true if the preparation succeeded and the model can be passed to the view to write to the response. False should be returned if an error occurred and the error handler already wrote to the response which is now considered to be committed.

Throws:

Exception - Exception.

setContentTemplate

public void setContentTemplate(String contentTemplate)

Set the template to be rendered as view.

Parameters:

contentTemplate - the content template to set

setCssCategories

public void setCssCategories(String[] categories)

Set the names of the categories whose CSS resources should be included when rendering the page

Parameters:

categories - the names of the categories in the order the resources of the category should be rendered

setJavaScriptCategories

public void setJavaScriptCategories(String[] categories)

Set the names of the categories whose JavaScript resources should be included when rendering the page

Parameters:

categories - the names of the categories in the order the resources of the category should be rendered

setPage

public void setPage(String page)

Parameters:

page - the page to set

setSelectedMenu

public void setSelectedMenu(String menuIdentifier)

Set the identifier to be exported as selected menu. This could be used in the view to highlight the current page in a top navigation

Parameters:

menuIdentifier - the menu identifier to set

setTemplateManager

public void setTemplateManager(TemplateManager templateManager)

Set the template manager to use for resolving template names into templates

Parameters:

templateManager - the manager

setView

public void setView(String view)

Parameters:

view - the view to set