SwitchSettingsTile class

SwitchSettingsTile is a widget that has a Switch with given title, subtitle and default value/status of the switch

This widget supports an additional list of widgets to display when the switch is enabled. These optional list of widgets is accessed through childrenIfEnabled property of this widget.

This widget works similar to CheckboxSettingsTile.

Example:

 SwitchSettingsTile(
  leading: Icon(Icons.developer_mode),
  settingKey: 'key-switch-dev-mode',
  title: 'Developer Settings',
  onChange: (value) {
    debugPrint('key-switch-dev-mod: $value');
  },
  childrenIfEnabled: <Widget>[
    CheckboxSettingsTile(
      leading: Icon(Icons.adb),
      settingKey: 'key-is-developer',
      title: 'Developer Mode',
      onChange: (value) {
        debugPrint('key-is-developer: $value');
      },
    ),
    SwitchSettingsTile(
      leading: Icon(Icons.usb),
      settingKey: 'key-is-usb-debugging',
      title: 'USB Debugging',
      onChange: (value) {
        debugPrint('key-is-usb-debugging: $value');
      },
    ),
    SimpleSettingsTile(
      title: 'Root Settings',
      subtitle: 'These settings is not accessible',
      enabled: false,
    )
  ],
 );
Inheritance

Constructors

SwitchSettingsTile({@required String title, @required String settingKey, bool defaultValue = false, bool enabled = true, OnChanged<bool> onChange, Widget leading, String enabledLabel = '', String disabledLabel = '', List<Widget> childrenIfEnabled, String subtitle = ''})

Properties

childrenIfEnabled List<Widget>
A List of widgets that will be displayed when the switch is set to enable state, Any flutter widget can be added in this list
final
defaultValue bool
initial value to be used as state of the switch, default = false
final
disabledLabel String
A specific text that will be displayed as subtitle when switch is set to disable state if provided, default = ''
final
enabled bool
flag which represents the state of the settings, if false the the tile will ignore all the user inputs, default = true
final
enabledLabel String
A specific text that will be displayed as subtitle when switch is set to enable state if provided, default = ''
final
hashCode int
The hash code for this object.
@nonVirtualread-onlyinherited
key Key
Controls how one widget replaces another widget in the tree.
finalinherited
leading Widget
A Widget that will be displayed in the front of the tile
final
onChange OnChanged<bool>
on change callback for handling the value change
final
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
settingKey String
Settings Key string for storing the state of switch in cache (assumed to be unique)
final
subtitle String
subtitle for the settings tile, default = ''
final
title String
title for the settings tile
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
getFinalWidget(BuildContext context, Widget mainWidget, bool currentValue, List<Widget> childrenIfEnabled) Widget
getSubtitle(bool currentStatus) String
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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.
@nonVirtualinherited