An optional container for grouping together multiple form field widgets (e.g. TextField widgets).

Each individual form field should be wrapped in a FormField widget, with the Form widget as a common ancestor of all of those. Call methods on FormState to save, reset, or validate each FormField that is a descendant of this Form. To obtain the FormState, you may use Form.of with a context whose ancestor is the Form, or pass a GlobalKey to the Form constructor and call GlobalKey.currentState.

Inheritance

Constructors

Form({Key key, Widget child, bool autovalidate: false, WillPopCallback onWillPop })

Creates a container for form fields.

const

Properties

autovalidate bool

If true, form fields will validate and update their error text immediately after every change. Otherwise, you must call FormState.validate to validate.

final
child Widget

Root of the widget hierarchy that contains this form.

final
onWillPop WillPopCallback

Enables the form to veto attempts by the user to dismiss the ModalRoute that contains the form.

final
hashCode int

The hash code for this object.

read-only, inherited
key Key

Controls how one widget replaces another widget in the tree.

final, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited

Methods

createState() FormState

Creates the mutable state for this widget at a given location in the tree.

createElement() StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited
debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

@mustCallSuper, @protected, inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() String

Returns a string representation of this object.

inherited
toStringShort() String

A short, textual description of this widget.

inherited

Operators

operator ==(other) bool

The equality operator.

inherited

Static Methods

of(BuildContext context) FormState

Returns the closest FormState which encloses the given context.