FCheckbox class

A checkbox control that allows the user to toggle between checked and not checked.

For touch devices, a FSwitch is generally recommended over this.

See:

Inheritance

Constructors

FCheckbox({FCheckboxStyle? style, Widget? label, Widget? description, Widget? error, String? semanticLabel, bool value = false, ValueChanged<bool>? onChange, bool enabled = true, bool autofocus = false, FocusNode? focusNode, ValueChanged<bool>? onFocusChange, Key? key})
Creates a FCheckbox.
const

Properties

autofocus bool
Whether this checkbox should focus itself if nothing else is already focused. Defaults to false.
final
description Widget?
The description displayed below the label.
final
enabled bool
Whether this checkbox is enabled. Defaults to true.
final
error Widget?
The error displayed below the description.
final
focusNode FocusNode?
Defines the FocusNode for this checkbox.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label Widget?
The label displayed next to the checkbox.
final
onChange ValueChanged<bool>?
Called when the user initiates a change to the FCheckBox's value: when they have checked or unchecked this box.
final
onFocusChange ValueChanged<bool>?
Handler called when the focus changes.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
semanticLabel String?
The semantic label used by accessibility frameworks.
final
style FCheckboxStyle?
The style. Defaults to FThemeData.checkboxStyle.
final
value bool
The current value of the checkbox.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<FCheckbox>
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