FormFieldState<T> class
The current state of a FormField. Passed to the FormFieldBuilder method for use in constructing the form field's widget.
Subclasses whose FormField.builder returns a sliver can override wrapWithSemantics, wrapWithFocus, and focusIncludesSemantics to replace the default render-box wrappers with sliver-compatible ones.
- Inheritance
- Mixed-in types
Constructors
Properties
- bucket → RestorationBucket?
-
The RestorationBucket used for the restoration data of the
RestorablePropertys registered to this mixin.
no setterinherited
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- errorText → String?
-
The current validation error returned by the FormField.validator
callback, or the manually provided error message using the
FormField.forceErrorText property.
no setter
- focusIncludesSemantics → bool
-
Whether wrapWithFocus's Focus should add its own Semantics node.
no setter
- hasError → bool
-
True if this field has any validation errors.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasInteractedByUser → bool
-
Returns true if the user has modified the value of this field.
no setter
- isValid → bool
-
True if the current value is valid.
no setter
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- restorationId → String?
-
The restoration ID used for the RestorationBucket in which the mixin
will store the restoration data of all registered properties.
no setteroverride
- restorePending → bool
-
Whether restoreState will be called at the beginning of the next build
phase.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticsValidationResult → SemanticsValidationResult
-
The SemanticsValidationResult published by wrapWithSemantics for this
field's current state.
no setter
- value → T?
-
The current value of the form field.
no setter
-
widget
→ FormField<
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.
override
-
clearError(
) → void - Clears any visible validation error for this field without resetting the field's value.
-
deactivate(
) → void -
Called when this object is removed from the tree.
override
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
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.
override
-
didToggleBucket(
RestorationBucket? oldBucket) → void -
Called when bucket switches between null and non-null values.
inherited
-
didUpdateRestorationId(
) → void -
Must be called when the value returned by restorationId changes.
inherited
-
didUpdateWidget(
covariant FormField< T> oldWidget) → void -
Called whenever the widget configuration changes.
override
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
override
-
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
-
registerForRestoration(
RestorableProperty< Object?> property, String restorationId) → void -
Registers a RestorableProperty for state restoration.
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.
override
-
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.
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.
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
-
unregisterFromRestoration(
RestorableProperty< Object?> property) → void -
Unregisters a RestorableProperty from state restoration.
inherited
-
validate(
) → bool - Calls FormField.validator to set the errorText only if FormField.forceErrorText is null. When FormField.forceErrorText is not null, FormField.validator will not be called.
-
wrapWithFocus(
Widget child) → Widget -
Wraps
childwith the Focus node used to drive AutovalidateMode.onUnfocus validation. -
wrapWithSemantics(
Widget child) → Widget - Wraps the result of FormField.builder with a Semantics node that publishes the field's SemanticsValidationResult.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited