FormSwitch<TValue> class

This widget is used to display switches and save ON/OFF of switches.

If labelText or labelWidget is specified, the switch is displayed with a label. Only one of labelText and labelWidget should be specified.

Place under the Form that gave FormController.key, or pass FormController to form.

When FormController is passed to form, onSaved must also be passed together. The contents of onSaved will be used to save the data.

Enter the initial value given by FormController.value in initialValue.

Each time the content is changed, onChanged is executed.

When FormController.validate is executed, validation and data saving are performed.

If enabled is false, the switch is deactivated.

If readOnly is set to true, it will show enabled, but the value cannot be changed.

スイッチを表示して、スイッチのON・OFFを保存するためのウィジェットです。

labelTextもしくはlabelWidgetを指定するとラベル付きでスイッチが表示されます。 labelTextとlabelWidgetはどちらか一方のみを指定してください。

FormController.keyを与えたForm配下に配置、もしくはformにFormControllerを渡します。

formにFormControllerを渡した場合、一緒にonSavedも渡してください。データの保存はonSavedの内容が実行されます。

initialValueにFormController.valueから与えられた初期値を入力します。

内容が変更される度onChangedが実行されます。

FormController.validateが実行された場合、バリデーションとデータの保存を行ないます。

enabledがfalseになるとスイッチが非有効化されます。

readOnlyがtrueになっている場合は、有効化の表示になりますが、値が変更できなくなります。

Inheritance
Available Extensions

Constructors

FormSwitch({FormController<TValue>? form, Key? key, FormStyle? style, TValue onSaved(bool value)?, bool initialValue = false, bool enabled = true, void onChanged(bool value)?, bool keepAlive = true, FocusNode? focusNode, bool autofocus = false, bool readOnly = false, String? labelText, Widget? labelWidget, FormAffixStyle? prefix, FormAffixStyle? suffix})
This widget is used to display switches and save ON/OFF of switches.

Properties

autovalidateMode → AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder → FormFieldBuilder<bool>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
finalinherited
enabled → bool
Whether the form is able to receive user input.
finalinherited
form → FormController<TValue>?
Context for forms.
final
hashCode → int
The hash code for this object.
no setterinherited
initialValue → bool?
An optional value to initialize the form field to, or null otherwise.
finalinherited
keepAlive → bool
If placed in a list, whether or not it should not be discarded on scrolling.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onChanged → (void Function(bool value)?)
Callback to be executed each time the value is changed.
final
onSaved → FormFieldSetter<bool>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
restorationId → String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validator → FormFieldValidator<bool>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → FormFieldState<bool>
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}) → 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