ReorderableListState class Null safety
The state for a list that allows the user to interactively reorder the list items.
An app that needs to start a new item drag or cancel an existing one can refer to the ReorderableList's state with a global key:
GlobalKey<ReorderableListState> listKey = GlobalKey<ReorderableListState>();
...
ReorderableList(key: listKey, ...);
...
listKey.currentState.cancelReorder();
- Inheritance
-
- Object
- State<
ReorderableList> - ReorderableListState
Constructors
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
read-onlyinherited
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- mounted → bool
-
Whether this State object is currently in a tree.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- widget → ReorderableList
-
The current configuration.
read-onlyinherited
Methods
-
activate(
) → void - Called when this object is reinserted into the tree after having been removed via deactivate.
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
cancelReorder(
) → void - Cancel any item drag in progress.
-
deactivate(
) → void - Called when this object is removed from the tree.
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
didChangeDependencies(
) → void - Called when a dependency of this State object changes.
-
didUpdateWidget(
covariant ReorderableList oldWidget) → void - Called whenever the widget configuration changes.
-
dispose(
) → void - Called when this object is removed from the tree permanently.
-
initState(
) → void - Called when this object is inserted into the tree.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
reassemble(
) → void - Called whenever the application is reassembled during debugging, for example during hot reload.
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
protected">@protectedinherited
-
startItemDragReorder(
{required int index, required PointerDownEvent event, required MultiDragGestureRecognizer recognizer}) → void -
Initiate the dragging of the item at
indexthat was started with the pointer downevent. -
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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited