TTransferList<T> class
A dual-list transfer shuttle component for moving items between source and target lists.
Ideal for admin scenarios such as role/permission assignment, user group management, column picker configurations, and batch multi-select workflows.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- TTransferList
- Available extensions
Constructors
-
TTransferList({Key? key, required List<
T> sourceItems, required List<T> targetItems, required ValueChanged<List< onTargetChanged, ValueChanged<T> >List< ? onSourceChanged, String itemLabel(T item)?, String itemSubtitle(T item)?, Widget itemBuilder(BuildContext context, T item, bool isChecked)?, bool itemDisabled(T item)?, String sourceTitle = 'Available', String targetTitle = 'Selected', bool showSearch = true, bool showSelectAll = true, bool allowReordering = false, double height = 360.0, double boxWidth = 260.0})T> > -
const
Properties
- allowReordering → bool
-
Whether to display Up / Down buttons to allow reordering the target list. Defaults to false.
final
- boxWidth → double
-
Width of each list card. Defaults to 260.0.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double
-
Fixed height of the transfer list containers. Defaults to 360.0.
final
- itemBuilder → Widget Function(BuildContext context, T item, bool isChecked)?
-
Custom builder for item rows.
final
- itemDisabled → bool Function(T item)?
-
Function to determine if an item is disabled from transfer.
final
- itemLabel → String Function(T item)?
-
Function to extract the display string for an item. Defaults to
item.toString().final - itemSubtitle → String Function(T item)?
-
Function to extract an optional secondary subtitle/description for an item.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onSourceChanged
→ ValueChanged<
List< ?T> > -
Optional callback fired when the source items list changes.
final
-
onTargetChanged
→ ValueChanged<
List< T> > -
Callback fired when the target items list changes (items transferred or reordered).
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showSearch → bool
-
Whether to show search filter fields at the top of each list. Defaults to true.
final
- showSelectAll → bool
-
Whether to show "Select All" checkboxes in the list headers. Defaults to true.
final
-
sourceItems
→ List<
T> -
The collection of available items in the source pool.
final
- sourceTitle → String
-
Title for the source list card. Defaults to "Available".
final
-
targetItems
→ List<
T> -
The collection of assigned / selected items in the target pool.
final
- targetTitle → String
-
Title for the target list card. Defaults to "Selected".
final
Methods
-
box(
{double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps this widget in a ConstrainedBox to apply layout constraints. -
center(
{bool when = true}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps this widget in a Center widget. -
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< TTransferList< 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
-
expanded(
{int flex = 1}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps this widget in an Expanded widget. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
padding(
[double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps this widget in a Padding with flexible edge control. -
paddingSymmetric(
{double h = 0.0, double v = 0.0}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps this widget in a Padding with symmetric horizontal and vertical spacing. -
size(
{double? w, double? h}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps this widget in a SizedBox to apply fixed width and/or height. -
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
-
visible(
bool visible, {bool maintainState = false}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps this widget in a Visibility widget. -
when(
bool condition) → Widget -
Available on Widget, provided by the WidgetX extension
Returns this widget ifconditionis true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited