CheckboxListTile class
A ListTile with a Checkbox. In other words, a checkbox with a label.
The entire list tile is interactive: tapping anywhere in the tile toggles the checkbox.
The value, onChanged, and activeColor properties of this widget are identical to the similarly-named properties on the Checkbox widget.
The title, subtitle, isThreeLine, and dense properties are like those of the same name on ListTile.
The selected property on this widget is similar to the ListTile.selected property, but the color used is that described by activeColor, if any, defaulting to the accent color of the current Theme. No effort is made to coordinate the selected state and the value state; to have the list tile appear selected when the checkbox is checked, pass the same value to both.
The checkbox is shown on the right by default in left-to-right languages (i.e. the trailing edge). This can be changed using controlAffinity. The secondary widget is placed on the opposite side. This maps to the ListTile.leading and ListTile.trailing properties of ListTile.
To show the CheckboxListTile as disabled, pass null as the onChanged callback.
This sample requires that you also import 'package:flutter/scheduler.dart', so that you can reference timeDilation.
CheckboxListTile(
title: const Text('Animate Slowly'),
value: timeDilation != 1.0,
onChanged: (bool value) {
setState(() { timeDilation = value ? 20.0 : 1.0; });
},
secondary: const Icon(Icons.hourglass_empty),
)
See also:
- ListTileTheme, which can be used to affect the style of list tiles, including checkbox list tiles.
- RadioListTile, a similar widget for radio buttons.
- SwitchListTile, a similar widget for switches.
- ListTile and Checkbox, the widgets from which this widget is made.
- Inheritance
- Object
- Diagnosticable
- DiagnosticableTree
- Widget
- StatelessWidget
- CheckboxListTile
Constructors
-
CheckboxListTile({Key key, @required bool value, @required ValueChanged<
bool> onChanged, Color activeColor, Widget title, Widget subtitle, bool isThreeLine: false, bool dense, Widget secondary, bool selected: false, ListTileControlAffinity controlAffinity: ListTileControlAffinity.platform }) -
Creates a combination of a list tile and a checkbox. [...]
const
Properties
- activeColor → Color
-
The color to use when this checkbox is checked. [...]
final
- controlAffinity → ListTileControlAffinity
-
Where to place the control relative to the text.
final
- dense → bool
-
Whether this list tile is part of a vertically dense list. [...]
final
- isThreeLine → bool
-
Whether this list tile is intended to display three lines of text. [...]
final
-
onChanged
→ ValueChanged<
bool> -
Called when the value of the checkbox should change. [...]
final
- secondary → Widget
-
A widget to display on the opposite side of the tile from the checkbox. [...]
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
- value → bool
-
Whether this checkbox is checked. [...]
final
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- key → Key
-
Controls how one widget replaces another widget in the tree. [...]
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
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. [...]
@protected, inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node. [...]
inherited
-
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 toStringDeep. [...]
inherited
-
toString(
{DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns 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 ==(
dynamic other) → bool -
The equality operator. [...]
inherited