EasyFormState class
State associated with a EasyForm widget.
A EasyFormState object can be used to save, reset, and validate every EasyFormField that is a descendant of the associated EasyForm.
Typically obtained via EasyForm.of.
- Inheritance
- Implementers
Constructors
Properties
- adaptivity → EasyFormAdaptivity
-
The mode of adaptability of form elements, in which design system
the form elements will be displayed: Material, Apple, or
will be automatically determined based on the platform.
no setter
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
-
errors
↔ Map<
String, String?> ? -
getter/setter pair
-
fields
→ Set<
EasyFormFieldState> -
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
isSaving
→ ValueNotifier<
bool> -
no setter
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- widget → EasyForm
-
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.
override
-
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.
override
-
didUpdateWidget(
covariant EasyForm oldWidget) → void -
Called whenever the widget configuration changes.
override
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
inherited
-
doSave(
Map< String, dynamic> values) → Future<void> -
fieldByName(
String name) → EasyFormFieldState? -
Returns EasyFormFieldState for the field named
name, if no such field is found, returns null. -
fieldError(
String name) → String? -
Returns error text for the field named
name, if no such field is found or there is no error in the field, returns null. -
initState(
) → void -
Called when this object is inserted into the tree.
inherited
-
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
-
reset(
) → void - Resets every EasyFormField that is a descendant of this EasyForm back to its EasyFormField.initialValue.
-
save(
) → Future< bool> - Validate & saves every EasyFormField that is a descendant of this EasyForm.
-
setErrors(
Map< String, String?> ? newErrors) → void - Sets errors in fields as a Map, where key is the name of the field and value is the text of the error message.
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
inherited
-
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
-
validate(
) → bool - Validates every EasyFormField that is a descendant of this EasyForm, and returns true if there are no errors.
-
values(
) → Map< String, dynamic> - Returns the values of form fields as a Map<String, dynamic>
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited