ArnaReorderableList class
A list whose items the user can interactively reorder by dragging.
All list items must have a key.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ArnaReorderableList
Constructors
-
ArnaReorderableList({Key? key, required List<
Widget> children, required ReorderCallback onReorder, void onReorderStart(int index)?, void onReorderEnd(int index)?, double? itemExtent, Widget? prototypeItem, ReorderItemProxyDecorator? proxyDecorator, bool buildDefaultDragHandles = true, EdgeInsets? padding, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? scrollController, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, double anchor = 0.0, double? cacheExtent, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, bool showBackground = false}) - Creates a reorderable list from a pre-built list of widgets.
- ArnaReorderableList.builder({Key? key, required IndexedWidgetBuilder itemBuilder, required int itemCount, required ReorderCallback onReorder, void onReorderStart(int index)?, void onReorderEnd(int index)?, double? itemExtent, Widget? prototypeItem, ReorderItemProxyDecorator? proxyDecorator, bool buildDefaultDragHandles = true, EdgeInsets? padding, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? scrollController, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, double anchor = 0.0, double? cacheExtent, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, bool showBackground = false})
-
Creates a reorderable list from widget items that are created on demand.
const
Properties
- anchor → double
-
The relative position of the zero scroll offset.
final
- buildDefaultDragHandles → bool
-
If true: on desktop platforms, a drag handle is stacked over the center of each item's trailing edge; on mobile
platforms, a long press anywhere on the item starts a drag.
final
- cacheExtent → double?
-
The viewport has an area before and after the visible area to cache items
that are about to become visible when the user scrolls.
final
- dragStartBehavior → DragStartBehavior
-
Determines the way that drag start behavior is handled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- itemBuilder → IndexedWidgetBuilder
-
Called, as needed, to build list item widgets.
final
- itemCount → int
-
The number of items in the list.
final
- itemExtent → double?
-
If non-null, forces the children to have the given extent in the scroll
direction.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior
-
ScrollViewKeyboardDismissBehavior the defines how this ScrollView will
dismiss the keyboard automatically.
final
- onReorder → ReorderCallback
-
A callback used by the list to report that a list item has been dragged
to a new location in the list and the application should update the order
of the items.
final
- onReorderEnd → (void Function(int index)?)
-
A callback that is called when the dragged item is dropped.
final
- onReorderStart → (void Function(int index)?)
-
A callback that is called when an item drag has started.
final
- padding → EdgeInsets?
-
The amount of space by which to inset the list contents.
final
- physics → ScrollPhysics?
-
How the scroll view should respond to user input.
final
- primary → bool?
-
Whether this is the primary scroll view associated with the parent
PrimaryScrollController.
final
- prototypeItem → Widget?
-
If non-null, forces the children to have the same extent as the given
widget in the scroll direction.
final
- proxyDecorator → ReorderItemProxyDecorator?
-
A callback that allows the app to add an animated decoration around
an item when it is being dragged.
final
- restorationId → String?
-
Restoration ID to save and restore the scroll offset of the scrollable.
final
- reverse → bool
-
Whether the scroll view scrolls in the reading direction.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollController → ScrollController?
-
An object that can be used to control the position to which this scroll
view is scrolled.
final
- scrollDirection → Axis
-
The Axis along which the scroll view's offset increases.
final
- showBackground → bool
-
Whether to show background or not.
final
- shrinkWrap → bool
-
Whether the extent of the scroll view in the scrollDirection should be
determined by the contents being viewed.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ArnaReorderableList> -
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