FSelectGroup<T> class
A set of items that are treated as a single selection.
Typically used to group multiple FSelectGroupItem.checkboxs or FSelectGroupItem.radios.
For touch devices, a FSelectTileGroup is generally recommended over this.
See:
- https://forui.dev/docs/form/select-group for working examples.
- FSelectGroupStyle for customizing a select group's appearance.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FormField<
Set< T> > - FSelectGroup
Constructors
-
FSelectGroup({required FSelectGroupController<
T> controller, required List<FSelectGroupItem< items, FSelectGroupStyle? style, Widget? label, Widget? description, Widget errorBuilder(BuildContext, String) = _errorBuilder, FormFieldSetter<T> >Set< ? onSaved, FormFieldValidator<T> >Set< ? validator, Set<T> >T> ? initialValue, String? forceErrorText, bool enabled = true, AutovalidateMode? autovalidateMode, String? restorationId, Key? key}) - Creates a FSelectGroup.
Properties
- autovalidateMode → AutovalidateMode
-
Used to enable/disable this form field auto validation and update its
error text.
finalinherited
-
builder
→ FormFieldBuilder<
Set< 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
-
controller
→ FSelectGroupController<
T> -
The controller.
final
- description → Widget?
-
The description displayed below the label.
final
- enabled → bool
-
Whether the form is able to receive user input.
finalinherited
- errorBuilder → Widget Function(BuildContext, String)
-
The builder for errors displayed below the description. Defaults to displaying the error message.
final
- forceErrorText → String?
-
An optional property that forces the FormFieldState into an error state
by directly setting the FormFieldState.errorText property without
running the validator function.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
initialValue
→ Set<
T> ? -
An optional value to initialize the form field to, or null otherwise.
finalinherited
-
items
→ List<
FSelectGroupItem< T> > -
The items.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → Widget?
-
The label displayed next to the select group.
final
-
onSaved
→ FormFieldSetter<
Set< ?T> > -
An optional method to call with the final value when the form is saved via
FormState.save.
finalinherited
- 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
- style → FSelectGroupStyle?
-
The style. Defaults to FThemeData.selectGroupStyle.
final
-
validator
→ FormFieldValidator<
Set< ?T> > -
An optional method that validates an input. Returns an error string to
display if the input is invalid, or null otherwise.
finalinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → FormFieldState< Set< 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