AFFormState<T extends StatefulWidget, G extends TemplateForm> class
abstract
The AFFormState allows to override and customize even more the behavior of the form widget's logic.
Before considering extending this class, make sure that the AFWidget class does not satisfy your requirements!
- Inheritance
- Implementers
Constructors
-
AFFormState.new({required G model, bool enableFinalAction = true, ValueChanged<
String> ? handleErrorOnSubmit, bool? enableSubmitFormWrapper})
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- enableFinalAction → bool
-
Whether to submit the form when the user clicks on the last field's TextInputAction.
final
- enableSubmitFormWrapper → bool?
-
Whether to use wrap the submit function inside the AFThemeData.submitFormWrapper
function. This can be useful to display a loading dialog while submitting
the data.
final
-
focusNodes
→ Map<
String, FocusNode> -
A map linking each AFTextField'id to its respective FocusNode
that will be populated inside the initState method.
final
- forceDisplayFieldsError ↔ bool
-
Whether to display each field's respective error (if there is one) even if
the user did not interact with any of these fields.
getter/setter pair
-
formsState
→ Map<
String, GlobalKey< AFWidgetState< >TemplateForm> > -
A map linking each form field AFFormField to its counterpart AFFormState instance.
allowing this very widget to validate (display errors) and retrieve data from
the sub-form.
final
-
handleErrorOnSubmit
→ ValueChanged<
String> ? -
A callback that will be triggered whenever the submitForm method is called
while the form is invalid. It exposes the first error returned by one of the
form's field (Field
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- model → G
-
The TemplateForm that will be used as the blueprint of this class.
final
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
-
multipleFormsState
→ Map<
String, GlobalKey< AFMultipleFormFieldWidgetState> > -
A map linking each form field AFMultipleFormField to its counterpart
AFMultipleFormFieldWidgetStateinstance.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
textEditingControllers
→ Map<
String, TextEditingController> -
A map linking each AFTextField'id to its respective TextEditingController
that will be populated inside the initState method.
final
- theme → AFThemeData
-
Since this getter makes use of the context value, it should not be
called inside the initState.
no setter
- widget → T
-
The current configuration.
no setterinherited
Methods
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
buildBooleanField(
AFBooleanField field) → Widget -
buildFileField(
AFFileField field) → FileFieldWidget -
buildFormFieldWidget(
AFFormField< TemplateForm> field) → FormFieldWidget -
buildMultipleFormFieldWidget(
AFMultipleFormField< TemplateForm> field) → AFMultipleFormFieldWidget -
buildSearchModelField(
AFSearchModelField< Object> field, AutovalidateMode validateMode) → Widget -
buildSearchMultipleModelsField(
AFSearchMultipleModelsField< Object> field, AutovalidateMode validateMode) → Widget -
buildSelectField(
AFSelectField< Object> field) → SelectFieldWidget<Object> -
buildTextField(
String? nextFocusName, AFTextField< Object> field, bool isFinal) → Widget -
deactivate(
) → void -
Called when this object is removed from the tree.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes.
inherited
-
didUpdateWidget(
covariant T oldWidget) → void -
Called whenever the widget configuration changes.
inherited
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
override
-
fieldWidget(
Field< Object> field, {String? nextFieldId, bool isFinal = false}) → Widget - Returns the matching widget for a given Field
-
form(
) → Widget - Builds each Field contained inside the TemplateForm.
-
getAutoFillHintsFromFieldType(
AFTextField< Object> field) → List<String> -
getErrorText(
Field< Object> field) → String? -
initState(
) → void -
Called when this object is inserted into the tree.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
inherited
-
submit(
G form) → FutureOr< void> -
submitForm(
) → Future< void> -
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited