FSelectTileGroup<T> class
A set of tiles that are treated as a single selection.
A FSelectTileGroup is internally a FormField, therefore it can be used in a Form.
For desktop, a FSelectGroup is generally recommended over this.
See:
- https://forui.dev/docs/tile/select-tile-group for working examples.
- FSelectTile for a single select tile.
- FTileGroupStyle for customizing a select group's appearance.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FSelectTileGroup
- Mixed-in types
Constructors
-
FSelectTileGroup({required List<
FSelectTile< children, FMultiValueControl<T> >T> ? control, ScrollController? scrollController, FTileGroupStyle? style, double? cacheExtent, double maxHeight = .infinity, DragStartBehavior dragStartBehavior = .start, ScrollPhysics physics = const ClampingScrollPhysics(), FItemDivider divider = .indented, Widget? label, Widget? description, String? semanticsLabel, Widget errorBuilder(BuildContext context, String message) = FFormFieldProperties.defaultErrorBuilder, FormFieldSetter<Set< ? onSaved, VoidCallback? onReset, FormFieldValidator<T> >Set< ? validator, String? forceErrorText, bool enabled = true, AutovalidateMode autovalidateMode = .disabled, Key? key})T> > - Creates a FSelectTileGroup.
-
FSelectTileGroup.builder({required FSelectTile<
T> ? tileBuilder(BuildContext context, int index), int? count, FMultiValueControl<T> ? control, ScrollController? scrollController, FTileGroupStyle? style, double? cacheExtent, double maxHeight = .infinity, DragStartBehavior dragStartBehavior = .start, ScrollPhysics physics = const ClampingScrollPhysics(), FItemDivider divider = .indented, Widget? label, Widget? description, String? semanticsLabel, Widget errorBuilder(BuildContext context, String message) = FFormFieldProperties.defaultErrorBuilder, FormFieldSetter<Set< ? onSaved, VoidCallback? onReset, FormFieldValidator<T> >Set< ? validator, String? forceErrorText, bool enabled = true, AutovalidateMode autovalidateMode = .disabled, Key? key})T> > - Creates a FSelectTileGroup that lazily builds its children.
Properties
- autovalidateMode → AutovalidateMode
-
If AutovalidateMode.onUserInteraction, this FormField will only
auto-validate after its content changes. If AutovalidateMode.always, it
will auto-validate even without user interaction. If
AutovalidateMode.disabled, auto-validation will be disabled.
final
- cacheExtent → double?
-
The scrollable area's cache extent in logical pixels.
final
-
control
→ FMultiValueControl<
T> ? -
Defines how the select tile group's value is controlled.
final
- description → Widget?
-
The description displayed below the group.
final
- divider → FItemDivider
-
The divider between tiles.
final
- dragStartBehavior → DragStartBehavior
-
Determines the way that drag start behavior is handled. Defaults to DragStartBehavior.start.
final
- enabled → bool
-
Whether the form field is enabled. Defaults to true.
final
- errorBuilder → Widget Function(BuildContext context, String message)
-
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.
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 above the group.
final
- maxHeight → double
-
The max height, in logical pixels. Defaults to infinity.
final
- onReset → VoidCallback?
-
An optional method to call when the form field is reset via FormFieldState.reset.
final
-
onSaved
→ FormFieldSetter<
Set< ?T> > -
An optional method to call with the final value when the form is saved via FormState.save.
final
- physics → ScrollPhysics
-
The scroll physics of the group. Defaults to ClampingScrollPhysics.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollController → ScrollController?
-
The scroll controller used to control the position to which this group is scrolled.
final
- semanticsLabel → String?
-
The semantic label used by accessibility frameworks.
final
- style → FTileGroupStyle?
-
The style. Defaults to FThemeData.tileGroupStyle.
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.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< FSelectTileGroup< 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, int wrapWidth = 65}) → 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