magoffin.matt.ma2.web
Class HelpController

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
                  org.springframework.web.servlet.mvc.BaseCommandController
                      org.springframework.web.servlet.mvc.AbstractCommandController
                          magoffin.matt.ma2.web.AbstractCommandController
                              magoffin.matt.ma2.web.HelpController

All Implemented Interfaces:

org.springframework.context.ApplicationContextAware, org.springframework.web.servlet.mvc.Controller

public class HelpController
extends AbstractCommandController

Controller for returning dynamic help.

The configurable properties of this class are:

customViews

A Map of help IDs to view names, to use instead of the default success view. This allows for specific help contents to be generated as more than just a simple message.

Version:

$Revision: 43 $ $Date: 2007-10-21 11:10:01 +1300 (Sun, 21 Oct 2007) $

Author:

Matt Magoffin (spamsqr@msqr.us)

Nested Class Summary

static class

HelpController.Command Command class.

Field Summary

static java.lang.String

HELP_ID_VIEW_MODEL_KEY The view model key that will contain the requested help ID.

Fields inherited from class magoffin.matt.ma2.web.AbstractCommandController

HTTP_USER_AGENT_HEADER

Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController

DEFAULT_COMMAND_NAME

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

HEADER_CACHE_CONTROL, HEADER_EXPIRES, HEADER_PRAGMA, METHOD_GET, METHOD_HEAD, METHOD_POST

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

logger

Constructor Summary

HelpController()

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getCustomViews()
protected org.springframework.web.servlet.ModelAndView	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
void	setCustomViews(java.util.Map<java.lang.String,java.lang.String> customViews)

Methods inherited from class magoffin.matt.ma2.web.AbstractCommandController

getDomainObjectFactory, getErrorView, getMessagesSource, getSuccessView, getSystemBiz, getWebHelper, initApplicationContext, registerCalendarEditor, setDomainObjectFactory, setErrorView, setMessagesSource, setSuccessView, setSystemBiz, setWebHelper

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

handleRequestInternal

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

bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommand, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, suppressBinding, suppressValidation

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, isRequireSession, isUseCacheControlHeader, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseExpiresHeader

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

getServletContext, getTempDir, getWebApplicationContext, isContextRequired

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

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

HELP_ID_VIEW_MODEL_KEY

public static final java.lang.String HELP_ID_VIEW_MODEL_KEY

The view model key that will contain the requested help ID.

See Also:

Constant Field Values

Constructor Detail

HelpController

public HelpController()

Method Detail

handle

protected org.springframework.web.servlet.ModelAndView handle(javax.servlet.http.HttpServletRequest request,
                                                              javax.servlet.http.HttpServletResponse response,
                                                              java.lang.Object command,
                                                              org.springframework.validation.BindException errors)
                                                       throws java.lang.Exception

Specified by:

handle in class org.springframework.web.servlet.mvc.AbstractCommandController

Throws:

java.lang.Exception

getCustomViews

public java.util.Map<java.lang.String,java.lang.String> getCustomViews()

Returns:

the customViews

setCustomViews

public void setCustomViews(java.util.Map<java.lang.String,java.lang.String> customViews)

Parameters:

customViews - the customViews to set