AbstractWizardFormController (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.web.servlet.mvc
Class AbstractWizardFormController

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.AbstractFormController
                          org.springframework.web.servlet.mvc.AbstractWizardFormController

All Implemented Interfaces:: ApplicationContextAware, ServletContextAware, Controller

public abstract class AbstractWizardFormController
extends AbstractFormController
extends AbstractFormController

Form controller for typical wizard-style workflows.

In contrast to classic forms, wizards have more than one form view page. Therefore, there are various actions instead of one single submit action:

finish: trying to leave the wizard successfully, that is, perform its final action, and thus requiring a valid state;
cancel: leaving the wizard without performing its final action, and thus without regard to the validity of its current state;
page change: showing another wizard page, e.g. the next or previous one, with regard to "dirty back" and "dirty forward".

Finish and cancel actions can be triggered by request parameters, named PARAM_FINISH ("_finish") and PARAM_CANCEL ("_cancel"), ignoring parameter values to allow for HTML buttons. The target page for page changes can be specified by PARAM_TARGET, appending the page number to the parameter name (e.g. "_target1"). The action parameters are recognized when triggered by image buttons too (via "_finish.x", "_abort.x", or "_target1.x").

The current page number will be stored in the session. It can also be specified as request parameter PARAM_PAGE, to properly handle usage of the back button in a browser: In this case, a submission always contains the correct page number, even if the user submitted from an old view.

The page can only be changed if it validates correctly, except if a "dirty back" or "dirty forward" is allowed. At finish, all pages get validated again to guarantee a consistent state.

Note that a validator's default validate method is not executed when using this class! Rather, the validatePage(java.lang.Object, org.springframework.validation.Errors, int, boolean) implementation should call special validateXXX methods that the validator needs to provide, validating certain pieces of the object. These can be combined to validate the elements of individual pages.

Note: Page numbering starts with 0, to be able to pass an array consisting of the corresponding view names to the "pages" bean property.

Since:: 25.04.2003
Author:: Juergen Hoeller
See Also:: setPages(java.lang.String[]), validatePage(java.lang.Object, org.springframework.validation.Errors, int, boolean), processFinish(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.validation.BindException), processCancel(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.validation.BindException)

Field Summary

static String PARAM_CANCEL
          Parameter triggering the cancel action.

static String PARAM_FINISH
          Parameter triggering the finish action.

static String PARAM_PAGE
          Parameter specifying the current page as value.

static String PARAM_TARGET
          Parameter specifying the target page, appending the page number to the name.

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

DEFAULT_COMMAND_NAME

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

AbstractWizardFormController()
          Create a new AbstractWizardFormController.

Method Summary

protected int getCurrentPage(HttpServletRequest request)
          Return the current page number.

protected int getInitialPage(HttpServletRequest request)
          Return the initial page of the wizard, that is, the page shown at wizard startup.

protected int getInitialPage(HttpServletRequest request, Object command)
          Return the initial page of the wizard, that is, the page shown at wizard startup.

String getPageAttribute()
          Return the name of the page attribute in the model.

protected int getPageCount()
          Return the number of wizard pages.

protected int getPageCount(HttpServletRequest request, Object command)
          Return the page count for this wizard form controller.

String[] getPages()
          Return the wizard pages, i.e. the view names for the pages.

protected String getPageSessionAttributeName()
          Return the name of the HttpSession attribute that holds the page object for this wizard form controller.

protected String getPageSessionAttributeName(HttpServletRequest request)
          Return the name of the HttpSession attribute that holds the page object for this wizard form controller.

protected int getTargetPage(HttpServletRequest request, int currentPage)
          Return the target page specified in the request.

protected int getTargetPage(HttpServletRequest request, Object command, Errors errors, int currentPage)
          Return the target page specified in the request.

protected String getViewName(HttpServletRequest request, Object command, int page)
          Return the name of the view for the specified page of this wizard form controller.

protected ModelAndView handleInvalidSubmit(HttpServletRequest request, HttpServletResponse response)
          Handle an invalid submit request, e.g. when in session form mode but no form object was found in the session (like in case of an invalid resubmit by the browser).

boolean isAllowDirtyBack()
          Return whether "dirty back" is allowed.

boolean isAllowDirtyForward()
          Return whether "dirty forward" is allowed.

protected boolean isCancelRequest(HttpServletRequest request)
          Determine whether the incoming request is a request to cancel the processing of the current form.

protected boolean isFinishRequest(HttpServletRequest request)
          Determine whether the incoming request is a request to finish the processing of the current form.

protected boolean isFormSubmission(HttpServletRequest request)
          Consider an explicit finish or cancel request as a form submission too.

protected void onBindAndValidate(HttpServletRequest request, Object command, BindException errors)
          Calls page-specific onBindAndValidate method.

protected void onBindAndValidate(HttpServletRequest request, Object command, BindException errors, int page)
          Callback for custom post-processing in terms of binding and validation.

protected void postProcessPage(HttpServletRequest request, Object command, Errors errors, int page)
          Post-process the given page after binding and validation, potentially updating its command object.

protected ModelAndView processCancel(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)
          Template method for processing the cancel action of this wizard.

protected abstract ModelAndView processFinish(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)
          Template method for processing the final action of this wizard.

protected ModelAndView processFormSubmission(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)
          Apply wizard workflow: finish, cancel, page change.

protected Map referenceData(HttpServletRequest request, int page)
          Create a reference data map for the given request, consisting of bean name/bean instance pairs as expected by ModelAndView.

protected Map referenceData(HttpServletRequest request, Object command, Errors errors)
          Calls page-specific referenceData method.

protected Map referenceData(HttpServletRequest request, Object command, Errors errors, int page)
          Create a reference data map for the given request, consisting of bean name/bean instance pairs as expected by ModelAndView.

void setAllowDirtyBack(boolean allowDirtyBack)
          Set if "dirty back" is allowed, that is, if moving to a former wizard page is allowed in case of validation errors for the current page.

void setAllowDirtyForward(boolean allowDirtyForward)
          Set if "dirty forward" is allowed, that is, if moving to a later wizard page is allowed in case of validation errors for the current page.

void setPageAttribute(String pageAttribute)
          Set the name of the page attribute in the model, containing an Integer with the current page number.

void setPages(String[] pages)
          Set the wizard pages, i.e. the view names for the pages.

protected ModelAndView showForm(HttpServletRequest request, HttpServletResponse response, BindException errors)
          Show first page as form view.

protected ModelAndView showPage(HttpServletRequest request, BindException errors, int page)
          Prepare the form model and view, including reference and error data, for the given page.

protected void validatePage(Object command, Errors errors, int page)
          Template method for custom validation logic for individual pages.

protected void validatePage(Object command, Errors errors, int page, boolean finish)
          Template method for custom validation logic for individual pages.

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

currentFormObject, formBackingObject, getCommand, getErrorsForNewForm, getFormSessionAttributeName, getFormSessionAttributeName, handleRequestInternal, isBindOnNewForm, isSessionForm, onBindOnNewForm, onBindOnNewForm, setBindOnNewForm, setSessionForm, showForm, showForm, showNewForm

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

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

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, setServletContext

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 Summary
`static String`	`PARAM_CANCEL` Parameter triggering the cancel action.
`static String`	`PARAM_FINISH` Parameter triggering the finish action.
`static String`	`PARAM_PAGE` Parameter specifying the current page as value.
`static String`	`PARAM_TARGET` Parameter specifying the target page, appending the page number to the name.

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

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
`AbstractWizardFormController()` Create a new AbstractWizardFormController.

Method Summary
`protected int`	`getCurrentPage(HttpServletRequest request)` Return the current page number.
`protected int`	`getInitialPage(HttpServletRequest request)` Return the initial page of the wizard, that is, the page shown at wizard startup.
`protected int`	`getInitialPage(HttpServletRequest request, Object command)` Return the initial page of the wizard, that is, the page shown at wizard startup.
`String`	`getPageAttribute()` Return the name of the page attribute in the model.
`protected int`	`getPageCount()` Return the number of wizard pages.
`protected int`	`getPageCount(HttpServletRequest request, Object command)` Return the page count for this wizard form controller.
`String[]`	`getPages()` Return the wizard pages, i.e. the view names for the pages.
`protected String`	`getPageSessionAttributeName()` Return the name of the HttpSession attribute that holds the page object for this wizard form controller.
`protected String`	`getPageSessionAttributeName(HttpServletRequest request)` Return the name of the HttpSession attribute that holds the page object for this wizard form controller.
`protected int`	`getTargetPage(HttpServletRequest request, int currentPage)` Return the target page specified in the request.
`protected int`	`getTargetPage(HttpServletRequest request, Object command, Errors errors, int currentPage)` Return the target page specified in the request.
`protected String`	`getViewName(HttpServletRequest request, Object command, int page)` Return the name of the view for the specified page of this wizard form controller.
`protected ModelAndView`	`handleInvalidSubmit(HttpServletRequest request, HttpServletResponse response)` Handle an invalid submit request, e.g. when in session form mode but no form object was found in the session (like in case of an invalid resubmit by the browser).
`boolean`	`isAllowDirtyBack()` Return whether "dirty back" is allowed.
`boolean`	`isAllowDirtyForward()` Return whether "dirty forward" is allowed.
`protected boolean`	`isCancelRequest(HttpServletRequest request)` Determine whether the incoming request is a request to cancel the processing of the current form.
`protected boolean`	`isFinishRequest(HttpServletRequest request)` Determine whether the incoming request is a request to finish the processing of the current form.
`protected boolean`	`isFormSubmission(HttpServletRequest request)` Consider an explicit finish or cancel request as a form submission too.
`protected void`	`onBindAndValidate(HttpServletRequest request, Object command, BindException errors)` Calls page-specific onBindAndValidate method.
`protected void`	`onBindAndValidate(HttpServletRequest request, Object command, BindException errors, int page)` Callback for custom post-processing in terms of binding and validation.
`protected void`	`postProcessPage(HttpServletRequest request, Object command, Errors errors, int page)` Post-process the given page after binding and validation, potentially updating its command object.
`protected ModelAndView`	`processCancel(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)` Template method for processing the cancel action of this wizard.
`protected abstract ModelAndView`	`processFinish(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)` Template method for processing the final action of this wizard.
`protected ModelAndView`	`processFormSubmission(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)` Apply wizard workflow: finish, cancel, page change.
`protected Map`	`referenceData(HttpServletRequest request, int page)` Create a reference data map for the given request, consisting of bean name/bean instance pairs as expected by ModelAndView.
`protected Map`	`referenceData(HttpServletRequest request, Object command, Errors errors)` Calls page-specific referenceData method.
`protected Map`	`referenceData(HttpServletRequest request, Object command, Errors errors, int page)` Create a reference data map for the given request, consisting of bean name/bean instance pairs as expected by ModelAndView.
`void`	`setAllowDirtyBack(boolean allowDirtyBack)` Set if "dirty back" is allowed, that is, if moving to a former wizard page is allowed in case of validation errors for the current page.
`void`	`setAllowDirtyForward(boolean allowDirtyForward)` Set if "dirty forward" is allowed, that is, if moving to a later wizard page is allowed in case of validation errors for the current page.
`void`	`setPageAttribute(String pageAttribute)` Set the name of the page attribute in the model, containing an Integer with the current page number.
`void`	`setPages(String[] pages)` Set the wizard pages, i.e. the view names for the pages.
`protected ModelAndView`	`showForm(HttpServletRequest request, HttpServletResponse response, BindException errors)` Show first page as form view.
`protected ModelAndView`	`showPage(HttpServletRequest request, BindException errors, int page)` Prepare the form model and view, including reference and error data, for the given page.
`protected void`	`validatePage(Object command, Errors errors, int page)` Template method for custom validation logic for individual pages.
`protected void`	`validatePage(Object command, Errors errors, int page, boolean finish)` Template method for custom validation logic for individual pages.

Methods inherited from class org.springframework.web.servlet.mvc.AbstractFormController
`currentFormObject, formBackingObject, getCommand, getErrorsForNewForm, getFormSessionAttributeName, getFormSessionAttributeName, handleRequestInternal, isBindOnNewForm, isSessionForm, onBindOnNewForm, onBindOnNewForm, setBindOnNewForm, setSessionForm, showForm, showForm, showNewForm`

Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController
bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, initApplicationContext, initBinder, isValidateOnBinding, onBind, onBind, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, suppressBinding, suppressValidation, suppressValidation, suppressValidation, useDirectFieldAccess

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, setServletContext`

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

PARAM_FINISH

public static final String PARAM_FINISH

Parameter triggering the finish action. Can be called from any wizard page!

See Also:: Constant Field Values

PARAM_CANCEL

public static final String PARAM_CANCEL

Parameter triggering the cancel action. Can be called from any wizard page!

See Also:: Constant Field Values

PARAM_TARGET

public static final String PARAM_TARGET

Parameter specifying the target page, appending the page number to the name.

See Also:: Constant Field Values

PARAM_PAGE

public static final String PARAM_PAGE

Parameter specifying the current page as value. Not necessary on form pages, but allows to properly handle usage of the back button.

See Also:: setPageAttribute(java.lang.String), Constant Field Values

Constructor Detail

AbstractWizardFormController

public AbstractWizardFormController()

Create a new AbstractWizardFormController.

"sessionForm" is automatically turned on, "validateOnBinding" turned off, and "cacheSeconds" set to 0 by the base class (-> no caching for all form controllers).

Method Detail

setPages

public final void setPages(String[] pages)

Set the wizard pages, i.e. the view names for the pages. The array index is interpreted as page number.

Parameters:: pages - view names for the pages

getPages

public final String[] getPages()

Return the wizard pages, i.e. the view names for the pages. The array index corresponds to the page number.

Note that a concrete wizard form controller might override getViewName(HttpServletRequest, Object, int) to determine the view name for each page dynamically.

See Also:: getViewName(javax.servlet.http.HttpServletRequest, Object, int)

getPageCount

protected final int getPageCount()

Return the number of wizard pages. Useful to check whether the last page has been reached.

Note that a concrete wizard form controller might override getPageCount(HttpServletRequest, Object) to determine the page count dynamically. The default implementation of that extended getPageCount variant returns the static page count as determined by this getPageCount() method.

See Also:: getPageCount(javax.servlet.http.HttpServletRequest, Object)

setPageAttribute

public final void setPageAttribute(String pageAttribute)

Set the name of the page attribute in the model, containing an Integer with the current page number.

This will be necessary for single views rendering multiple view pages. It also allows for specifying the optional "_page" parameter.

Parameters:: pageAttribute - name of the page attribute
See Also:: PARAM_PAGE

getPageAttribute

public final String getPageAttribute()

Return the name of the page attribute in the model.

setAllowDirtyBack

public final void setAllowDirtyBack(boolean allowDirtyBack)

Set if "dirty back" is allowed, that is, if moving to a former wizard page is allowed in case of validation errors for the current page.

Parameters:: allowDirtyBack - if "dirty back" is allowed

isAllowDirtyBack

public final boolean isAllowDirtyBack()

Return whether "dirty back" is allowed.

setAllowDirtyForward

public final void setAllowDirtyForward(boolean allowDirtyForward)

Set if "dirty forward" is allowed, that is, if moving to a later wizard page is allowed in case of validation errors for the current page.

Parameters:: allowDirtyForward - if "dirty forward" is allowed

isAllowDirtyForward

public final boolean isAllowDirtyForward()

Return whether "dirty forward" is allowed.

onBindAndValidate

protected final void onBindAndValidate(HttpServletRequest request,
                                       Object command,
                                       BindException errors)
                                throws Exception

Calls page-specific onBindAndValidate method.

Overrides:: onBindAndValidate in class BaseCommandController

Parameters:: request - current HTTP request; command - the command object, still allowing for further binding; errors - validation errors holder, allowing for additional custom validation
Throws:: Exception - in case of invalid state or arguments
See Also:: BaseCommandController.bindAndValidate(javax.servlet.http.HttpServletRequest, java.lang.Object), Errors

onBindAndValidate

protected void onBindAndValidate(HttpServletRequest request,
                                 Object command,
                                 BindException errors,
                                 int page)
                          throws Exception

Callback for custom post-processing in terms of binding and validation. Called on each submit, after standard binding but before page-specific validation of this wizard form controller.

Note: AbstractWizardFormController does not perform standand validation on binding but rather applies page-specific validation on processing the form submission.

Parameters:: request - current HTTP request; command - bound command; errors - Errors instance for additional custom validation; page - current wizard page
Throws:: Exception - in case of invalid state or arguments
See Also:: BaseCommandController.bindAndValidate(javax.servlet.http.HttpServletRequest, java.lang.Object), processFormSubmission(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.validation.BindException), Errors

isFormSubmission

protected boolean isFormSubmission(HttpServletRequest request)

Consider an explicit finish or cancel request as a form submission too.

Overrides:: isFormSubmission in class AbstractFormController

Parameters:: request - current HTTP request
Returns:: if the request represents a form submission
See Also:: isFinishRequest(javax.servlet.http.HttpServletRequest), isCancelRequest(javax.servlet.http.HttpServletRequest)

referenceData

protected final Map referenceData(HttpServletRequest request,
                                  Object command,
                                  Errors errors)
                           throws Exception

Calls page-specific referenceData method.

Overrides:: referenceData in class AbstractFormController

Parameters:: request - current HTTP request; command - form object with request parameters bound onto it; errors - validation errors holder
Returns:: a Map with reference data entries, or null if none
Throws:: Exception - in case of invalid state or arguments
See Also:: ModelAndView

referenceData

protected Map referenceData(HttpServletRequest request,
                            Object command,
                            Errors errors,
                            int page)
                     throws Exception

Create a reference data map for the given request, consisting of bean name/bean instance pairs as expected by ModelAndView.

The default implementation delegates to referenceData(HttpServletRequest, int). Subclasses can override this to set reference data used in the view.

Parameters:: request - current HTTP request; command - form object with request parameters bound onto it; errors - validation errors holder; page - current wizard page
Returns:: a Map with reference data entries, or null if none
Throws:: Exception - in case of invalid state or arguments
See Also:: referenceData(HttpServletRequest, int), ModelAndView

referenceData

protected Map referenceData(HttpServletRequest request,
                            int page)
                     throws Exception

Create a reference data map for the given request, consisting of bean name/bean instance pairs as expected by ModelAndView.

The default implementation returns null. Subclasses can override this to set reference data used in the view.

Parameters:: request - current HTTP request; page - current wizard page
Returns:: a Map with reference data entries, or null if none
Throws:: Exception - in case of invalid state or arguments
See Also:: ModelAndView

showForm

protected final ModelAndView showForm(HttpServletRequest request,
                                      HttpServletResponse response,
                                      BindException errors)
                               throws Exception

Show first page as form view.

Specified by:: showForm in class AbstractFormController

Parameters:: request - current HTTP request; response - current HTTP response; errors - validation errors holder
Returns:: the prepared form view, or null if handled directly
Throws:: Exception - in case of invalid state or arguments
See Also:: AbstractFormController.showForm(HttpServletRequest, BindException, String), Errors, BindException.getModel(), AbstractFormController.referenceData(HttpServletRequest, Object, Errors), SimpleFormController.setFormView(java.lang.String)

showPage

protected final ModelAndView showPage(HttpServletRequest request,
                                      BindException errors,
                                      int page)
                               throws Exception

Prepare the form model and view, including reference and error data, for the given page. Can be used in

processFinish(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.validation.BindException)

implementations, to show the corresponding page in case of validation errors.

Parameters:: request - current HTTP request; errors - validation errors holder; page - number of page to show
Returns:: the prepared form view
Throws:: Exception - in case of invalid state or arguments

getPageCount

protected int getPageCount(HttpServletRequest request,
                           Object command)

Return the page count for this wizard form controller. The default implementation delegates to getPageCount().

Can be overridden to dynamically adapt the page count.

Parameters:: request - current HTTP request; command - the command object as returned by formBackingObject
Returns:: the current page count
See Also:: getPageCount()

getViewName

protected String getViewName(HttpServletRequest request,
                             Object command,
                             int page)

Return the name of the view for the specified page of this wizard form controller.

The default implementation takes the view name from the getPages() array.

Can be overridden to dynamically switch the page view or to return view names for dynamically defined pages.

Parameters:: request - current HTTP request; command - the command object as returned by formBackingObject
Returns:: the current page count
See Also:: getPageCount()

getInitialPage

protected int getInitialPage(HttpServletRequest request,
                             Object command)

Return the initial page of the wizard, that is, the page shown at wizard startup.

The default implementation delegates to getInitialPage(HttpServletRequest).

Parameters:: request - current HTTP request; command - the command object as returned by formBackingObject
Returns:: the initial page number
See Also:: getInitialPage(HttpServletRequest), AbstractFormController.formBackingObject(javax.servlet.http.HttpServletRequest)

getInitialPage

protected int getInitialPage(HttpServletRequest request)

Return the initial page of the wizard, that is, the page shown at wizard startup.

The default implementation returns 0 for first page.

Parameters:: request - current HTTP request
Returns:: the initial page number

getPageSessionAttributeName

protected String getPageSessionAttributeName(HttpServletRequest request)

Return the name of the HttpSession attribute that holds the page object for this wizard form controller.

The default implementation delegates to the getPageSessionAttributeName() variant without arguments.

Parameters:: request - current HTTP request
Returns:: the name of the form session attribute, or null if not in session form mode
See Also:: getPageSessionAttributeName(javax.servlet.http.HttpServletRequest), AbstractFormController.getFormSessionAttributeName(javax.servlet.http.HttpServletRequest), HttpSession.getAttribute(java.lang.String)

getPageSessionAttributeName

protected String getPageSessionAttributeName()

Return the name of the HttpSession attribute that holds the page object for this wizard form controller.

Default is an internal name, of no relevance to applications, as the form session attribute is not usually accessed directly. Can be overridden to use an application-specific attribute name, which allows other code to access the session attribute directly.

Returns:: the name of the page session attribute
See Also:: AbstractFormController.getFormSessionAttributeName(javax.servlet.http.HttpServletRequest), HttpSession.getAttribute(java.lang.String)

handleInvalidSubmit

protected ModelAndView handleInvalidSubmit(HttpServletRequest request,
                                           HttpServletResponse response)
                                    throws Exception

Handle an invalid submit request, e.g. when in session form mode but no form object was found in the session (like in case of an invalid resubmit by the browser).

The default implementation for wizard form controllers simply shows the initial page of a new wizard form. If you want to show some "invalid submit" message, you need to override this method.

Overrides:: handleInvalidSubmit in class AbstractFormController

Parameters:: request - current HTTP request; response - current HTTP response
Returns:: a prepared view, or null if handled directly
Throws:: Exception - in case of errors
See Also:: AbstractFormController.showNewForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), AbstractFormController.setBindOnNewForm(boolean)

processFormSubmission

protected final ModelAndView processFormSubmission(HttpServletRequest request,
                                                   HttpServletResponse response,
                                                   Object command,
                                                   BindException errors)
                                            throws Exception

Apply wizard workflow: finish, cancel, page change.

Specified by:: processFormSubmission in class AbstractFormController

Parameters:: request - current servlet request; response - current servlet response; command - form object with request parameters bound onto it; errors - holder without errors (subclass can add errors if it wants to)
Returns:: the prepared model and view, or null
Throws:: Exception - in case of errors
See Also:: AbstractFormController.handleRequestInternal(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), AbstractFormController.isFormSubmission(javax.servlet.http.HttpServletRequest), AbstractFormController.showForm(HttpServletRequest, HttpServletResponse, BindException), Errors, BindException.getModel()

getCurrentPage

protected int getCurrentPage(HttpServletRequest request)

Return the current page number. Used by processFormSubmission.

The default implementation checks the page session attribute. Subclasses can override this for customized page determination.

See Also:: processFormSubmission(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.validation.BindException), getPageSessionAttributeName(javax.servlet.http.HttpServletRequest)

isFinishRequest

protected boolean isFinishRequest(HttpServletRequest request)

Determine whether the incoming request is a request to finish the processing of the current form.

By default, this method returns true if a parameter matching the "_finish" key is present in the request, otherwise it returns false. Subclasses may override this method to provide custom logic to detect a finish request.

The parameter is recognized both when sent as a plain parameter ("_finish") or when triggered by an image button ("_finish.x").

Parameters:: request - current HTTP request
See Also:: PARAM_FINISH

isCancelRequest

protected boolean isCancelRequest(HttpServletRequest request)

Determine whether the incoming request is a request to cancel the processing of the current form.

By default, this method returns true if a parameter matching the "_cancel" key is present in the request, otherwise it returns false. Subclasses may override this method to provide custom logic to detect a cancel request.

The parameter is recognized both when sent as a plain parameter ("_cancel") or when triggered by an image button ("_cancel.x").

Parameters:: request - current HTTP request
See Also:: PARAM_CANCEL

getTargetPage

protected int getTargetPage(HttpServletRequest request,
                            Object command,
                            Errors errors,
                            int currentPage)

Return the target page specified in the request.

The default implementation delegates to getTargetPage(HttpServletRequest, int). Subclasses can override this for customized target page determination.

Parameters:: request - current HTTP request; command - form object with request parameters bound onto it; errors - validation errors holder; currentPage - the current page, to be returned as fallback if no target page specified
Returns:: the page specified in the request, or current page if not found
See Also:: getTargetPage(HttpServletRequest, int)

getTargetPage

protected int getTargetPage(HttpServletRequest request,
                            int currentPage)

Return the target page specified in the request.

The default implementation examines "_target" parameter (e.g. "_target1"). Subclasses can override this for customized target page determination.

Parameters:: request - current HTTP request; currentPage - the current page, to be returned as fallback if no target page specified
Returns:: the page specified in the request, or current page if not found
See Also:: PARAM_TARGET

validatePage

protected void validatePage(Object command,
                            Errors errors,
                            int page,
                            boolean finish)

Template method for custom validation logic for individual pages. The default implementation calls validatePage(Object, Errors, int).

Implementations will typically call fine-granular validateXXX methods of this instance's Validator, combining them to validation of the corresponding pages. The Validator's default validate method will not be called by a wizard form controller!

Parameters:: command - form object with the current wizard state; errors - validation errors holder; page - number of page to validate; finish - whether this method is called during final revalidation on finish (else, it is called for validating the current page)
See Also:: validatePage(Object, Errors, int), Validator.validate(java.lang.Object, org.springframework.validation.Errors)

validatePage

protected void validatePage(Object command,
                            Errors errors,
                            int page)

Template method for custom validation logic for individual pages. The default implementation is empty.

Implementations will typically call fine-granular validateXXX methods of this instance's validator, combining them to validation of the corresponding pages. The validator's default validate method will not be called by a wizard form controller!

Parameters:: command - form object with the current wizard state; errors - validation errors holder; page - number of page to validate
See Also:: Validator.validate(java.lang.Object, org.springframework.validation.Errors)

postProcessPage

protected void postProcessPage(HttpServletRequest request,
                               Object command,
                               Errors errors,
                               int page)
                        throws Exception

Post-process the given page after binding and validation, potentially updating its command object. The passed-in request might contain special parameters sent by the page.

Only invoked when displaying another page or the same page again, not when finishing or cancelling.

Parameters:: request - current HTTP request; command - form object with request parameters bound onto it; errors - validation errors holder; page - number of page to post-process
Throws:: Exception - in case of invalid state or arguments

processFinish

protected abstract ModelAndView processFinish(HttpServletRequest request,
                                              HttpServletResponse response,
                                              Object command,
                                              BindException errors)
                                       throws Exception

Template method for processing the final action of this wizard.

Call errors.getModel() to populate the ModelAndView model with the command and the Errors instance, under the specified command name, as expected by the "spring:bind" tag.

You can call the showPage(javax.servlet.http.HttpServletRequest, org.springframework.validation.BindException, int) method to return back to the wizard, in case of last-minute validation errors having been found that you would like to present to the user within the original wizard form.

Parameters:: request - current HTTP request; response - current HTTP response; command - form object with the current wizard state; errors - validation errors holder
Returns:: the finish view
Throws:: Exception - in case of invalid state or arguments
See Also:: Errors, BindException.getModel(), showPage(javax.servlet.http.HttpServletRequest, org.springframework.validation.BindException, int)

processCancel

protected ModelAndView processCancel(HttpServletRequest request,
                                     HttpServletResponse response,
                                     Object command,
                                     BindException errors)
                              throws Exception

Template method for processing the cancel action of this wizard.

The default implementation throws a ServletException, saying that a cancel operation is not supported by this controller. Thus, you do not need to implement this template method if you do not support a cancel operation.

Call errors.getModel() to populate the ModelAndView model with the command and the Errors instance, under the specified command name, as expected by the "spring:bind" tag.

Parameters:: request - current HTTP request; response - current HTTP response; command - form object with the current wizard state; errors - Errors instance containing errors
Returns:: the cancellation view
Throws:: Exception - in case of invalid state or arguments
See Also:: Errors, BindException.getModel()

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

AbstractWizardFormController (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

org.springframework.web.servlet.mvc Class AbstractWizardFormController

PARAM_FINISH

PARAM_CANCEL

PARAM_TARGET

PARAM_PAGE

AbstractWizardFormController

setPages

getPages

getPageCount

setPageAttribute

getPageAttribute

setAllowDirtyBack

isAllowDirtyBack

setAllowDirtyForward

isAllowDirtyForward

onBindAndValidate

onBindAndValidate

isFormSubmission

referenceData

referenceData

referenceData

showForm

showPage

getPageCount

getViewName

getInitialPage

getInitialPage

getPageSessionAttributeName

getPageSessionAttributeName

handleInvalidSubmit

processFormSubmission

getCurrentPage

isFinishRequest

isCancelRequest

getTargetPage

getTargetPage

validatePage

validatePage

postProcessPage

processFinish

processCancel

org.springframework.web.servlet.mvc
Class AbstractWizardFormController