FormBuilderCheckboxGroup<T> class

A list of Checkboxes for selecting multiple options

Inheritance

Constructors

FormBuilderCheckboxGroup({Key? key, required String name, VisualDensity? visualDensity, FormFieldValidator<List<T>>? validator, List<T>? initialValue, InputDecoration decoration = const InputDecoration(), ValueChanged<List<T>?>? onChanged, ValueTransformer<List<T>?>? valueTransformer, bool enabled = true, FormFieldSetter<List<T>>? onSaved, AutovalidateMode? autovalidateMode = AutovalidateMode.disabled, VoidCallback? onReset, FocusNode? focusNode, String? restorationId, required List<FormBuilderFieldOption<T>> options, Color? activeColor, Color? checkColor, Color? focusColor, Color? hoverColor, List<T>? disabled, MaterialTapTargetSize? materialTapTargetSize, bool tristate = false, Axis wrapDirection = Axis.horizontal, WrapAlignment wrapAlignment = WrapAlignment.start, double wrapSpacing = 0.0, WrapAlignment wrapRunAlignment = WrapAlignment.start, double wrapRunSpacing = 0.0, WrapCrossAlignment wrapCrossAxisAlignment = WrapCrossAlignment.start, TextDirection? wrapTextDirection, VerticalDirection wrapVerticalDirection = VerticalDirection.down, Widget? separator, ControlAffinity controlAffinity = ControlAffinity.leading, OptionsOrientation orientation = OptionsOrientation.wrap, BoxDecoration? itemDecoration})
Creates a list of Checkboxes for selecting multiple options

Properties

activeColor Color?
final
autovalidateMode AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder FormFieldBuilder<List<T>>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
finalinherited
checkColor Color?
final
controlAffinity ControlAffinity
final
decoration InputDecoration
finalinherited
disabled List<T>?
final
enabled bool
Whether the form is able to receive user input.
finalinherited
focusColor Color?
final
focusNode FocusNode?
An optional focus node to use as the focus node for this widget.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
hoverColor Color?
final
initialValue List<T>?
An optional value to initialize the form field to, or null otherwise.
finalinherited
itemDecoration BoxDecoration?
Added to each item if provided. GroupedCheckbox applies the itemDecorator to each Checkbox
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
materialTapTargetSize MaterialTapTargetSize?
final
name String
Used to reference the field within the form, or to reference form data after the form is submitted.
finalinherited
onChanged ValueChanged<List<T>?>?
Called when the field value is changed.
finalinherited
onReset VoidCallback?
Called when the field value is reset.
finalinherited
onSaved FormFieldSetter<List<T>>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
options List<FormBuilderFieldOption<T>>
final
orientation OptionsOrientation
final
restorationId String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
separator Widget?
final
tristate bool
final
validator FormFieldValidator<List<T>>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited
valueTransformer ValueTransformer<List<T>?>?
Called just before field value is saved. Used to massage data just before committing the value.
finalinherited
visualDensity VisualDensity?
final
wrapAlignment WrapAlignment
final
wrapCrossAxisAlignment WrapCrossAlignment
final
wrapDirection Axis
final
wrapRunAlignment WrapAlignment
final
wrapRunSpacing double
final
wrapSpacing double
final
wrapTextDirection TextDirection?
final
wrapVerticalDirection VerticalDirection
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() FormBuilderFieldDecorationState<FormBuilderCheckboxGroup<T>, List<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.
inherited
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