FlutterFormOptions class

The options used to set parameters to a FlutterForm.

The pages determine what pages the pageview will contain via a List of FlutterFormPages.

Using a checkpage gives the ability for the user to check all input values before commiting by CheckPage. If checkPage is null no check page will be shown.

nextButton and backButton are both a way to give controls to user. Both are just plain widgets used in a Stack. So the widgets can be aligned where ever. The formcontroller of FlutterForm should be used to give control to the widgets/buttons.

onFinished and onNext are both callbacks which give the users results. onNext is called when the user goes to the next page. onFinished is called when the form is finished. When checkpage is set onFinished is called when the checkpage is finished.

scrollDirection can be set to change the Axis on which the pageview slides. Defaults to horizontal.

scrollPhysics can be set to set the scroll phyisics of the scroll views in each page. Default to ClampingScrollPhysics.

Constructors

FlutterFormOptions({required List<FlutterFormPage> pages, required void onFinished(Map<int, Map<String, dynamic>>), required void onNext(int pageNumber, Map<String, dynamic>), CheckPage? checkPage, Widget nextButton(int pageNumber, bool checkingPages)?, Widget backButton(int pageNumber, bool checkingPages, int pageAmount)?, Axis scrollDirection = Axis.horizontal, ScrollPhysics? scrollPhysics})
const

Properties

backButton → (Widget Function(int pageNumber, bool checkingPages, int pageAmount)?)
final
checkPage → CheckPage?
final
hashCode → int
The hash code for this object.
no setterinherited
nextButton → (Widget Function(int pageNumber, bool checkingPages)?)
final
onFinished → void Function(Map<int, Map<String, dynamic>>)
final
onNext → void Function(int pageNumber, Map<String, dynamic>)
final
pages → List<FlutterFormPage>
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollDirection → Axis
final
scrollPhysics → ScrollPhysics?
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited