- All Known Subinterfaces:
IFormSubmittingComponent
- All Known Implementing Classes:
AbstractSubmitLink
,AjaxButton
,AjaxFallbackButton
,AjaxFormSubmitBehavior.AjaxFormSubmitter
,AjaxSubmitLink
,Button
,CancelButton
,FinishButton
,ImageButton
,IndicatingAjaxButton
,LastButton
,NextButton
,PreviousButton
,SubmitLink
,WizardButton
public interface IFormSubmitter
Triggers a form submit and controls its processing
- Author:
- Igor Vaynberg (ivaynberg)
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether form should be processed the default way.Form<?>
getForm()
Returns the form this component submits.void
Override this method to provide special submit handling in a multi-button form.void
onError()
Method that is invoked when form processing fails; for example, when there are validation errors.void
onSubmit()
Override this method to provide special submit handling in a multi-button form.
-
Method Details
-
getForm
Returns the form this component submits.- Returns:
- form submitted by this component
-
getDefaultFormProcessing
boolean getDefaultFormProcessing()Returns whether form should be processed the default way. When false (default is true), all validation and form updating is bypassed and the onSubmit method of that button is called directly, and the onSubmit method of the parent form is not called. A common use for this is to create a cancel button.- Returns:
- defaultFormProcessing
-
onSubmit
void onSubmit()Override this method to provide special submit handling in a multi-button form. This method will be called before the form's onSubmit method. -
onAfterSubmit
void onAfterSubmit()Override this method to provide special submit handling in a multi-button form. This method will be called after the form's onSubmit method. -
onError
void onError()Method that is invoked when form processing fails; for example, when there are validation errors.
-