AnimatedReorderableState<T extends AnimatedReorderable> class
abstract
The AnimatedReorderableState for AnimatedReorderable, a wrapper for list or grid that animates items when they are inserted, removed or reordered.
When an item is inserted with insertItem an animation begins running. The
animation is passed to the insertItem builder parameter.
When an item is removed with removeItem its animation is reversed.
The removed item's animation is passed to the removeItem builder
parameter.
When an item is reordered with reorderItem its motion animation is handled by the underlying controller.
An app that needs to insert, remove or reorder items in response to an event can refer to the AnimatedReorderable's state with a global key:
// (e.g. in a stateful widget)
GlobalKey<AnimatedReorderableState> animatedReorderableKey = GlobalKey<AnimatedReorderableState>();
// ...
@override
Widget build(BuildContext context) {
return AnimatedReorderable(
key: animatedReorderableKey,
keyGetter: (index) => ValueKey(_items[index]),
listView: ListView.builder(
// ...
),
);
}
// ...
void _updateList() {
_items.insert(123, newItem);
animatedReorderableKey.currentState!.insertItem(123, builder: (context, index, animation) {
// ...
});
}
AnimatedReorderable item input handlers can also refer to their AnimatedReorderableState with the static AnimatedReorderable.of method.
- Inheritance
- Mixed in types
Constructors
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- widget → T
-
The current configuration.
no setterinherited
Methods
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
buildCollectionView(
BuildContext context) → Widget -
createTicker(
TickerCallback onTick) → Ticker -
Creates a ticker with the given callback.
inherited
-
deactivate(
) → void -
Called when this object is removed from the tree.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes.
inherited
-
didUpdateWidget(
covariant T oldWidget) → void -
Called whenever the widget configuration changes.
inherited
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
override
-
initState(
) → void -
Called when this object is inserted into the tree.
override
-
insertItem(
int index, AnimatedItemBuilder builder, {Duration duration = defaultInsertItemAnimationDuration}) → void -
Insert an item at
indexand start an animation that will be passed tobuilder. -
isItemRendered(
int index) → bool - Check if an item is rendered in the viewport or cache extent area of the list or grid.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
removeItem(
int index, AnimatedRemovedItemBuilder builder, {Duration duration = defaultRemoveItemAnimationDuration, int? zIndex}) → void -
Remove the item at
indexand start an animation that will be passed tobuilderwhen the item is visible. -
reorderItem(
int index, {required int destIndex}) → void -
Reorders the item at the specified
indexto a new position in the list or grid. -
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
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
-
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