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.

Inheritance

Constructors

FormState()

Properties

context BuildContext
The location in the tree where this widget builds. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
mounted bool
Whether this State object is currently in a tree. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
widget Form
The current configuration. [...]
read-only, inherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
reset() → void
Resets every FormField that is a descendant of this Form back to its FormField.initialState. [...]
save() → void
Saves every FormField that is a descendant of this Form.
validate() bool
Validates every FormField that is a descendant of this Form, and returns true if there are no errors. [...]
deactivate() → void
Called when this object is removed from the tree. [...]
@mustCallSuper, @protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes. [...]
@mustCallSuper, @protected, inherited
didUpdateWidget(Form oldWidget) → void
Called whenever the widget configuration changes. [...]
@mustCallSuper, @protected, inherited
dispose() → void
Called when this object is removed from the tree permanently. [...]
@mustCallSuper, @protected, inherited
initState() → void
Called when this object is inserted into the tree. [...]
@mustCallSuper, @protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload. [...]
@mustCallSuper, @protected, inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed. [...]
@protected, inherited
toDiagnosticsNode({String name, DiagnosticsTreeStyle style }) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns 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 ==(dynamic other) bool
The equality operator. [...]
inherited