FormFieldState<T> class Null safety

The current state of a FormField. Passed to the FormFieldBuilder method for use in constructing the form field's widget.

Mixed in types




bucket RestorationBucket?
The RestorationBucket used for the restoration data of the RestorablePropertys registered to this mixin.
read-only, inherited
context BuildContext
The location in the tree where this widget builds.
read-only, inherited
errorText String?
The current validation error returned by the FormField.validator callback, or null if no errors have been triggered. This only updates when validate is called.
hasError bool
True if this field has any validation errors.
hashCode int
The hash code for this object.
read-only, inherited
isValid bool
True if the current value is valid.
mounted bool
Whether this State object is currently in a tree.
read-only, inherited
restorationId String?
The restoration ID used for the RestorationBucket in which the mixin will store the restoration data of all registered properties.
read-only, override
restorePending bool
Whether restoreState will be called at the beginning of the next build phase.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
value → T?
The current value of the form field.
widget FormField<T>
The current configuration.
read-only, inherited


activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
@mustCallSuper, @protected, inherited
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
deactivate() → void
Called when this object is removed from the tree.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
didChange(T? value) → void
Updates this field's state to the new value. Useful for responding to child widget changes, e.g. Slider's Slider.onChanged argument.
didChangeDependencies() → void
Called when a dependency of this State object changes.
didToggleBucket(RestorationBucket? oldBucket) → void
Called when bucket switches between null and non-null values.
@mustCallSuper, @protected, inherited
didUpdateRestorationId() → void
Must be called when the value returned by restorationId changes.
@protected, inherited
didUpdateWidget(covariant FormField<T> oldWidget) → void
Called whenever the widget configuration changes.
dispose() → void
Called when this object is removed from the tree permanently.
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.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
@mustCallSuper, @protected, inherited
registerForRestoration(RestorableProperty<Object?> property, String restorationId) → void
Registers a RestorableProperty for state restoration.
@protected, inherited
reset() → void
Resets the field to its initial value.
restoreState(RestorationBucket? oldBucket, bool initialRestore) → void
Called to initialize or restore the RestorablePropertys used by the State object.
save() → void
Calls the FormField's onSaved method with the current value.
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
@protected, inherited
setValue(T? value) → void
Sets the value associated with this form field.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode.
unregisterFromRestoration(RestorableProperty<Object?> property) → void
Unregisters a RestorableProperty from state restoration.
@protected, inherited
validate() bool
Calls FormField.validator to set the errorText. Returns true if there were no errors.


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