RadioListTile< T> class
A ListTile with a Radio. In other words, a radio button with a label.
The entire list tile is interactive: tapping anywhere in the tile selects the radio button.
The value, groupValue, onChanged, and activeColor properties of this
widget are identical to the similarly-named properties on the Radio
widget. The type parameter T
serves the same purpose as that of the
Radio class' type parameter.
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 checked state; to have the list tile appear selected when the radio button is the selected radio button, set selected to true when value matches groupValue.
The radio button is shown on the left by default in left-to-right languages (i.e. the leading 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 RadioListTile as disabled, pass null as the onChanged callback.
_character
field. The field is of the type SingingCharacter
, an enum.
// At the top level:
enum SingingCharacter { lafayette, jefferson }
// In the State of a stateful widget:
SingingCharacter _character = SingingCharacter.lafayette;
// In the build function of that State:
Column(
children: <Widget>[
RadioListTile<SingingCharacter>(
title: const Text('Lafayette'),
value: SingingCharacter.lafayette,
groupValue: _character,
onChanged: (SingingCharacter value) { setState(() { _character = value; }); },
),
RadioListTile<SingingCharacter>(
title: const Text('Thomas Jefferson'),
value: SingingCharacter.jefferson,
groupValue: _character,
onChanged: (SingingCharacter value) { setState(() { _character = value; }); },
),
],
)
See also:
- ListTileTheme, which can be used to affect the style of list tiles, including radio list tiles.
- CheckboxListTile, a similar widget for checkboxes.
- SwitchListTile, a similar widget for switches.
- ListTile and Radio, the widgets from which this widget is made.
- Inheritance
- Object
- Diagnosticable
- DiagnosticableTree
- Widget
- StatelessWidget
- RadioListTile
Constructors
-
RadioListTile({Key key, @required T value, @required T groupValue, @required ValueChanged<
T> 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 radio button. [...]
const
Properties
- activeColor → Color
-
The color to use when this radio button is selected. [...]
final
- checked → bool
-
Whether this radio button is checked. [...]
read-only
- 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
- groupValue → T
-
The currently selected value for this group of radio buttons. [...]
final
- isThreeLine → bool
-
Whether this list tile is intended to display three lines of text. [...]
final
-
onChanged
→ ValueChanged<
T> -
Called when the user selects this radio button. [...]
final
- secondary → Widget
-
A widget to display on the opposite side of the tile from the radio button. [...]
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 → T
-
The value represented by this radio button.
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