YaruRadio<T> class

A Yaru radio.

Used to select between a number of mutually exclusive values. When one radio button in a group is selected, the other radio buttons in the group cease to be selected. The values are of type T, the type parameter of the YaruRadio class. Enums are commonly used for this purpose.

The radio button itself does not maintain any state. Instead, selecting the radio invokes the onChanged callback, passing value as a parameter. If groupValue and value match, this radio will be selected. Most widgets will respond to onChanged by calling State.setState to update the radio button's groupValue.

See also:

Inheritance
Implemented types

Constructors

YaruRadio({Key? key, required T value, required T? groupValue, bool toggleable = false, required ValueChanged<T?>? onChanged, Color? selectedColor, Color? checkmarkColor, FocusNode? focusNode, bool autofocus = false, MouseCursor? mouseCursor, MaterialStatesController? statesController})
Create a Yaru radio.
const

Properties

autofocus bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
checked bool
Getter used to link T to a bool value. If true, the YaruTogglable will be considered as checked.
no setter
checkmarkColor Color?
The color to use for the checkmark when this radio is checked.
final
focusNode FocusNode?
An optional focus node to use as the focus node for this widget.
final
groupValue → T?
The currently selected value for a group of radio buttons.
final
hashCode int
The hash code for this object.
no setterinherited
interactive bool
Determine if this YaruTogglable can handle events.
no setter
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mouseCursor MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
final
onChanged ValueChanged<T?>?
Called when the user selects this radio button.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectedColor Color?
The color to use when this radio is checked.
final
statesController MaterialStatesController?
Controls the states of the YaruTogglable.
final
toggleable bool
Set to true if this radio button is allowed to be returned to an indeterminate state by selecting it again when selected.
final
tristate bool
By default, a YaruTogglable widget can only handle two state. If true, it will be able to display tree values.
no setter
value → T
The value represented by this radio button.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → YaruTogglableState<YaruRadio<T?>>
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.
override
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