FormBuilderSwitch class

On/Off switch field

Inheritance

Constructors

FormBuilderSwitch({Key? key, required String name, FormFieldValidator<bool>? validator, bool? initialValue, InputDecoration decoration = const InputDecoration(), ValueChanged<bool?>? onChanged, ValueTransformer<bool?>? valueTransformer, bool enabled = true, FormFieldSetter<bool>? onSaved, AutovalidateMode? autovalidateMode = AutovalidateMode.disabled, VoidCallback? onReset, FocusNode? focusNode, String? restorationId, required Widget title, Color? activeColor, Color? activeTrackColor, Color? inactiveThumbColor, Color? inactiveTrackColor, ImageProvider<Object>? activeThumbImage, ImageProvider<Object>? inactiveThumbImage, Widget? subtitle, Widget? secondary, ListTileControlAffinity controlAffinity = ListTileControlAffinity.trailing, EdgeInsets contentPadding = EdgeInsets.zero, bool autofocus = false, bool selected = false})
Creates On/Off switch field

Properties

activeColor → Color?
The color to use when this switch is on.
final
activeThumbImage → ImageProvider<Object>?
An image to use on the thumb of this switch when the switch is on.
final
activeTrackColor → Color?
The color to use on the track when this switch is on.
final
autofocus → bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
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
contentPadding → EdgeInsets
The tile's internal padding.
final
controlAffinity → ListTileControlAffinity
Where to place the control in widgets that use ListTile to position a control next to a label.
final
decoration → InputDecoration
finalinherited
enabled → bool
Whether the form is able to receive user input.
finalinherited
focusNode → FocusNode?
An optional focus node to use as the focus node for this widget.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
inactiveThumbColor → Color?
The color to use on the thumb when this switch is off.
final
inactiveThumbImage → ImageProvider<Object>?
An image to use on the thumb of this switch when the switch is off.
final
inactiveTrackColor → Color?
The color to use on the track when this switch is off.
final
initialValue → bool?
An optional value to initialize the form field to, or null otherwise.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
name → String
Used to reference the field within the form, or to reference form data after the form is submitted.
finalinherited
onChanged → ValueChanged<bool?>?
Called when the field value is changed.
finalinherited
onReset → VoidCallback?
Called when the field value is reset.
finalinherited
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
secondary → Widget?
A widget to display on the opposite side of the tile from the switch.
final
selected → bool
Whether to render icons and text in the activeColor.
final
subtitle → Widget?
Additional content displayed below the title.
final
title → Widget
The primary content of the list tile.
final
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
valueTransformer → ValueTransformer<bool?>?
Called just before field value is saved. Used to massage data just before committing the value.
finalinherited

Methods

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