FormBuilderFieldState<F extends FormBuilderField<T>, T> class

Inheritance

Constructors

FormBuilderFieldState()

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
effectiveFocusNode ↔ FocusNode
The focus node that is used to focus this field.
getter/setter pair
enabled → bool
Returns true if the field is enabled and the parent FormBuilder is enabled.
no setter
errorText → String?
Returns the current error text, which may be a validation error or a custom error text.
no setteroverride
focusAttachment ↔ FocusAttachment?
The focus attachment for the effectiveFocusNode.
getter/setter pair
formState → FormBuilderState?
Returns the parent FormBuilderState if it exists.
no setter
hasError → bool
Returns true if the field has an error or has a custom error text.
no setteroverride
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 setterinherited
initialValue → T?
Returns the initial value, which may be declared at the field, or by the parent FormBuilder.initialValue. When declared at both levels, the field initialValue prevails.
no setter
isDirty → bool
Will be true if the field is dirty
no setter
isTouched → bool
Will be true if the field is touched
no setter
isValid → bool
Returns true if the field is valid and has no custom error text.
no setteroverride
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
readOnly → bool
Returns true if the field is read only.
no setter
restorationId → String?
The restoration ID used for the RestorationBucket in which the mixin will store the restoration data of all registered properties.
no setterinherited
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
transformedValue → dynamic
no setter
value → T?
The current value of the form field.
no setterinherited
valueHasError → bool
Returns true if the field has an error.
no setter
valueIsValid → bool
Returns true if the field is valid.
no setter
widget → F
The current configuration.
no setteroverride

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.
inherited
clearError() → void
Clears any visible validation error for this field without resetting the field's value.
inherited
deactivate() → void
Called when this object is removed from the tree.
inherited
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.
override
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
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 FormBuilderField<T> oldWidget) → void
Called whenever the widget configuration changes.
override
dispose() → void
Called when this object is removed from the tree permanently.
override
ensureScrollableVisibility() → void
Scroll to show field
focus() → void
Focus field
initState() → void
Called when this object is inserted into the tree.
override
invalidate(String errorText, {bool shouldFocus = true, bool shouldAutoScrollWhenFocus = false}) → void
Invalidate field with a errorText
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
registerTransformer(Map<String, Function> map) → void
reset() → void
Reset field value to initial value
override
restoreState(RestorationBucket? oldBucket, bool initialRestore) → void
Called to initialize or restore the RestorablePropertys used by the State object.
inherited
save() → void
Calls the FormField's onSaved method with the current value.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
setValue(T? value, {bool populateForm = true}) → void
Sets the value associated with this form field.
override
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 clearCustomError = true, bool focusOnInvalid = true, bool autoScrollWhenFocusOnInvalid = false}) → bool
Validate field
override

Operators

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