public class Form extends Object
Form
consists of two parts:
FormData
, wrapping the various FormElement
sFormConfirmation
, responsible for what happens after the form has been submitted.
FormProcessProvider
s which are processing the form inputs.FormData
,
FormElement
,
FormConfirmation
,
FormProcessProvider
Modifier and Type | Method and Description |
---|---|
boolean |
addFormProcessProvider(FormProcessProvider formProcessProvider)
Adds a
FormProcessProvider to this Form . |
void |
enableLogging()
|
FormConfirmation |
getFormConfirmation()
Returns the
FormConfirmation for this Form . |
FormData |
getFormData()
|
Request |
getRequest()
|
Boolean |
getRestoreRequestData() |
RuleValidation |
getRuleValidation()
Returns the
RuleValidation for this Form . |
boolean |
hasErrors()
Convenient method for checking whethers this
Form has validation errors, delegating to
FormElementOwner.hasErrors() . |
boolean |
isSubmitted()
Checks whether this
Form has been submitted. |
boolean |
removeFormProcessProvider(FormProcessProvider formProcessProvider)
Removes a
FormProcessProvider to this Form . |
void |
runProcessProviders(Writer writer,
Map<String,Object> properties)
Executes the
FormProcessProvider previously added by calling
addFormProcessProvider(FormProcessProvider) . |
void |
setFormConfirmation(FormConfirmation formConfirmation)
Sets the
FormConfirmation for this Form . |
void |
setFormData(FormData formData)
|
void |
setRequest(Request request)
Sets the
Request for this form. |
void |
setRestoreRequestData(Boolean restoreRequestData) |
void |
setSubmitted(boolean submitted)
Sets whether or not this
Form has been submitted. |
public Form()
Form
public void enableLogging()
public boolean addFormProcessProvider(FormProcessProvider formProcessProvider)
FormProcessProvider
to this Form
.formProcessProvider
- the FormProcessProvider
to addtrue
if adding was successful, false
otherwisepublic boolean removeFormProcessProvider(FormProcessProvider formProcessProvider)
FormProcessProvider
to this Form
.formProcessProvider
- the FormProcessProvider
to removetrue
if removing was successful, false
otherwisepublic boolean isSubmitted()
Form
has been submitted.true
if this Form
has been submitted, false
otherwisepublic void setSubmitted(boolean submitted)
Form
has been submitted.submitted
- public boolean hasErrors()
Form
has validation errors, delegating to
FormElementOwner.hasErrors()
.true
if this Form
has validation errors, false
otherwisepublic void setRequest(Request request)
Request
for this form.request
- the Request
public RuleValidation getRuleValidation()
RuleValidation
for this Form
.RuleValidation
public Boolean getRestoreRequestData()
public void setRestoreRequestData(Boolean restoreRequestData)
public FormConfirmation getFormConfirmation()
FormConfirmation
for this Form
.FormConfirmation
public void setFormConfirmation(FormConfirmation formConfirmation)
FormConfirmation
for this Form
.formConfirmation
- the FormConfirmation
public void runProcessProviders(Writer writer, Map<String,Object> properties)
FormProcessProvider
previously added by calling
addFormProcessProvider(FormProcessProvider)
. Thus means,
FormProcessProvider.onFormSuccess(Writer, Form, Map)
is being executed with the given Writer
and
the given property Map
.writer
- a Writer
properties
- the property Map
FormProcessProvider.onFormSuccess(Writer, Form, Map)
Copyright © 2011–2019 aiticon GmbH. All rights reserved.