FormState class
State associated with a Form widget.
A FormState object can be used to save, reset, and validate every FormField that is a descendant of the associated Form.
Typically obtained via Form.of.
Constructors
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- fields → Iterable<FormFieldState>
-
The FormFieldState objects that are currently registered with this Form.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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 → Form
-
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
- clearError() → void
- Clears the validation errors for all FormFields in this Form without resetting their values.
- 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 Form oldWidget) → void
-
Called whenever the widget configuration changes.
inherited
- dispose() → void
-
Called when this object is removed from the tree permanently.
inherited
- 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 FormField that is a descendant of this Form back to its FormField.initialValue.
- save() → void
- Saves every FormField that is a descendant of this Form.
- 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 FormField that is a descendant of this Form, and returns true if there are no errors.
- validateGranularly() → Set<FormFieldState<Object?>>
- Validates every FormField that is a descendant of this Form, and returns a Set of FormFieldState of the invalid field(s) only, if any.
Operators
- operator ==(Object other) → bool
-
The equality operator.
inherited