FormeKey class

form key is a global key , also used to manage form

Inheritance

• Object
• Key
• GlobalKey<State<StatefulWidget>>
• LabeledGlobalKey<State<StatefulWidget>>
• FormeKey

Implemented types

• FormeController

Constructors

FormeKey({String? debugLabel})

Properties

controllers → List<FormeFieldController>

get all registered controllers

no setter, override

currentContext → BuildContext?

The build context in which the widget with this key builds.

no setter, inherited

currentState → State<StatefulWidget>?

The State for the widget in the tree that currently has this global key.

no setter, inherited

currentWidget → Widget?

The widget in the tree that currently has this global key.

no setter, inherited

data ↔ Map<String, dynamic>

get form data

getter/setter pair, override

fieldsListenable → ValueListenable<Map<String, FormeFieldController?>>

listen when fields initialed or disposed

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

initialized → bool

whether formKey is initialized

no setter

isValueChanged → bool

whether form' value changed after initialized

no setter, override

quietlyValidate ↔ bool

whether validate is quietly

getter/setter pair, override

readOnly ↔ bool

whether form is readonly

getter/setter pair, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

validation → FormeValidation

get validation of Form

no setter, override

validationListenable → ValueListenable<FormeValidation>

used to listen any form field's validation changes

no setter, override

Methods

field<T extends FormeFieldController>(String name) → T

find FormeFieldController by name

override

fieldListenable<T>(String name) → ValueListenable<FormeFieldController<T>?>

listen when field initialed or disposed

override

hasField(String name) → bool

whether form has a name field

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reset() → void

reset form

override

save() → void

save all form fields

override

toString() → String

A string representation of this object.

inherited

validate({bool quietly = false, Set<String> names = const {}, bool clearError = false, bool validateByOrder = false}) → Future<FormeValidateSnapshot>

perform a validate

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

of(BuildContext context) → FormeController?