CardSettingsSwitch class
This is a field that allows a boolean to be set via a switch widget.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FormField<
bool> - CardSettingsSwitch
- Implemented types
Constructors
-
CardSettingsSwitch({Key? key, AutovalidateMode autovalidateMode = AutovalidateMode.onUserInteraction, FormFieldSetter<
bool> ? onSaved, FormFieldValidator<bool> ? validator, bool initialValue = false, bool enabled = true, String trueLabel = "Yes", String falseLabel = "No", bool visible = true, String label = 'Label', double? labelWidth, Widget? requiredIndicator, TextAlign? labelAlign, Icon? icon, TextAlign? contentAlign, ValueChanged<bool> ? onChanged, bool? showMaterialonIOS, EdgeInsetsGeometry? fieldPadding})
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
- contentAlign → TextAlign?
-
controls how the widget in the content area of the field is aligned
final
- enabled → bool
-
If false the field is grayed out and unresponsive
final
- falseLabel → String
-
The text to show if the switch if "off"
final
- fieldPadding → EdgeInsetsGeometry?
-
provides padding to wrap the entire field
final
- forceErrorText → String?
-
An optional property that forces the FormFieldState into an error state
by directly setting the FormFieldState.errorText property without
running the validator function.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- icon → Icon?
-
The icon to display to the left of the field content
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
- label → String
-
The text to identify the field to the user
final
- labelAlign → TextAlign?
-
The alignment of the label paret of the field. Default is left.
final
- labelWidth → double?
-
The width of the field label. If provided overrides the global setting.
final
-
onChanged
→ ValueChanged<
bool> ? -
Fires when the switch state is changed
final
-
onSaved
→ FormFieldSetter<
bool> ? -
An optional method to call with the final value when the form is saved via
FormState.save.
finalinherited
- requiredIndicator → Widget?
-
A widget to show next to the label if the field is required
final
- 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
- showMaterialonIOS → bool?
-
Force the widget to use Material style on an iOS device
final
- trueLabel → String
-
The text to show if the switch is "on"
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
- visible → bool
-
If false hides the widget on the card setting panel
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _CardSettingsSwitchState -
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