com.communote.server.widgets.springmvc

Class SpringFormWidget<T>

java.lang.Object

com.communote.server.widgets.AbstractWidget

com.communote.server.widgets.FormWidget

com.communote.server.widgets.springmvc.SpringFormWidget<T>

All Implemented Interfaces:

Widget

Direct Known Subclasses:

UserProfileChangePasswordWidget

public abstract class SpringFormWidget<T>
extends FormWidget

FormWidget that supports data binding and validation as done by spring's form controllers.

Author:

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

Field Summary

Fields inherited from class com.communote.server.widgets.AbstractWidget

METADATA_KEY_NO_CONTENT

Fields inherited from interface com.communote.server.widgets.Widget

PARAM_WIDGET_ID

Constructor Summary

Constructors

Constructor and Description
SpringFormWidget()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.web.bind.ServletRequestDataBinder	createBinder(javax.servlet.http.HttpServletRequest request, T formBackingObject) Create a binder for the given request and form backing object.
protected abstract T	formBackingObject(javax.servlet.http.HttpServletRequest request) Create the form backing object.
org.springframework.web.servlet.ModelAndView	handleRefresh() Handle a refresh
org.springframework.web.servlet.ModelAndView	handleSubmit() Handle a submit
protected void	initBinder(javax.servlet.http.HttpServletRequest request, org.springframework.web.bind.ServletRequestDataBinder binder) Called by #createBinder(HttpServletRequest, T) to init the binder.
protected abstract void	onSubmit(javax.servlet.http.HttpServletRequest request, T formBackingObject, org.springframework.validation.BindingResult errors) Do the actual submit operation, like updating database values.
protected void	prepareBackingObjectOnRefresh(javax.servlet.http.HttpServletRequest request, T formBackingObject) Called when the form widget is refreshing to allow initialization of the backing object if not already done in formBackingObject(HttpServletRequest).
protected void	prepareBackingObjectOnSubmit(javax.servlet.http.HttpServletRequest request, T formBackingObject) Called during submit of a form widget after the binder applied the request parameters to the backing object, but before calling the validator.
protected void	processFormSubmission(javax.servlet.http.HttpServletRequest request, T formBackingObject, org.springframework.validation.BindingResult errors)
void	setValidator(org.springframework.validation.Validator validator) Set the validator to validate the submitted form backing object.
protected boolean	suppressValidation(javax.servlet.http.HttpServletRequest request, T formBackingObject) Whether to suppress validation for the current submit
protected void	validateForm(T formBackingObject, org.springframework.validation.BindingResult errors)

Methods inherited from class com.communote.server.widgets.FormWidget

handleRequest, initParameters

Methods inherited from class com.communote.server.widgets.AbstractWidget

determineOutputType, getAttribute, getBooleanParameter, getGroupName, getIntParameter, getIntParameter, getLongArrayParameter, getLongParameter, getLongParameter, getParameter, getParameter, getParameterEscaped, getParameterEscaped, getParameters, getRequest, getResponse, getResponseMetadata, getStringArrayParameter, getViewIdentifier, getWidgetId, isSuccess, setAttribute, setGroupName, setParameter, setRequest, setResponse, setResponseMetadata, setSuccess

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.widgets.Widget

getTile

Constructor Detail

SpringFormWidget

public SpringFormWidget()

Method Detail

createBinder

protected org.springframework.web.bind.ServletRequestDataBinder createBinder(javax.servlet.http.HttpServletRequest request,
                                                                             T formBackingObject)

Create a binder for the given request and form backing object. The name of the target object will be

Parameters:

request - the current request

formBackingObject - the backing object

Returns:

the prepared binder

formBackingObject

protected abstract T formBackingObject(javax.servlet.http.HttpServletRequest request)

Create the form backing object. The returned object can be a pre-initialized or empty object. In case an empty one is returned it can be filled later within prepareBackingObjectOnRefresh(HttpServletRequest, Object) or prepareBackingObjectOnSubmit(HttpServletRequest, Object).

Parameters:

request - the current request

Returns:

the backing object

handleRefresh

public org.springframework.web.servlet.ModelAndView handleRefresh()

Description copied from class: FormWidget

Handle a refresh

Specified by:

handleRefresh in class FormWidget

Returns:

the result to be passed to the view for rendering

handleSubmit

public org.springframework.web.servlet.ModelAndView handleSubmit()

Description copied from class: FormWidget

Handle a submit

Specified by:

handleSubmit in class FormWidget

Returns:

the result to be passed to the view for rendering

initBinder

protected void initBinder(javax.servlet.http.HttpServletRequest request,
                          org.springframework.web.bind.ServletRequestDataBinder binder)

Called by #createBinder(HttpServletRequest, T) to init the binder. This allows registering custom editors for certain fields of the backing object class.

Parameters:

request - the current request

binder - the binder

See Also:

DataBinder.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor)

onSubmit

protected abstract void onSubmit(javax.servlet.http.HttpServletRequest request,
                                 T formBackingObject,
                                 org.springframework.validation.BindingResult errors)

Do the actual submit operation, like updating database values. This method is only called if the validation did not find any errors.

Parameters:

request - the current request

formBackingObject - the form backing object

errors - for adding errors that occur during the submit operation

prepareBackingObjectOnRefresh

protected void prepareBackingObjectOnRefresh(javax.servlet.http.HttpServletRequest request,
                                             T formBackingObject)

Called when the form widget is refreshing to allow initialization of the backing object if not already done in formBackingObject(HttpServletRequest). The default implementation does nothing.

Parameters:

request - the current request

formBackingObject - the backing object

prepareBackingObjectOnSubmit

protected void prepareBackingObjectOnSubmit(javax.servlet.http.HttpServletRequest request,
                                            T formBackingObject)

Called during submit of a form widget after the binder applied the request parameters to the backing object, but before calling the validator. The default implementation does nothing.

Parameters:

request - the current request

formBackingObject - the backing object

processFormSubmission

protected void processFormSubmission(javax.servlet.http.HttpServletRequest request,
                                     T formBackingObject,
                                     org.springframework.validation.BindingResult errors)

setValidator

public void setValidator(org.springframework.validation.Validator validator)

Set the validator to validate the submitted form backing object.

Parameters:

validator - the validator to use. If null no validation will be done.

suppressValidation

protected boolean suppressValidation(javax.servlet.http.HttpServletRequest request,
                                     T formBackingObject)

Whether to suppress validation for the current submit

Parameters:

request - the current request

formBackingObject - the backing object that will be validated

Returns:

false

validateForm

protected void validateForm(T formBackingObject,
                            org.springframework.validation.BindingResult errors)