GuardedForm class
A Form that tracks for changes and may prevent pop.
Current implementation just track if form has been modified once (calling Form.save() doesn't reset status).
Call markAsSaved to reset status (automatically done by SubmitFormBuilder on success).
When changed, registers to the closest EditingScope, until saved or disposed.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- GuardedForm
Constructors
-
GuardedForm({Key? key, VoidCallback? onChanged, Future<
bool?> onUnsavedFormPop()?, required Widget child}) -
const
Properties
- child → Widget
-
The form content.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onChanged → VoidCallback?
-
Called when one of the form fields changes.
final
-
onUnsavedFormPop
→ Future<
bool?> Function()? -
Called when current route tries to pop with unsaved changes.
Return
trueto allow pop,falseornullto prevent pop. Usually used to show a dialog to confirm pop. If null, will not prevent pop (behavior disabled, acts like a normal Form).final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< GuardedForm> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
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
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
markAsSaved(
BuildContext context) → void - Marks the closest GuardedForm ancestor as saved: allows pop again, and unregisters it from its EditingScope. Does nothing if there is no GuardedForm ancestor.