AnimatedCyclerState<T> class

The state class for AnimatedCycler that provides manual control methods.

Access this state through a GlobalKey to manually control the cycler:

final key = GlobalKey<AnimatedCyclerState>();

// Use the key with your AnimatedCycler
AnimatedCycler(key: key, ...)

// Access control methods
key.currentState?.nextItem();
key.currentState?.togglePlayPause();
Inheritance
Mixed-in types

Constructors

AnimatedCyclerState()

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
currentIndex → int
Gets the index of the currently displayed item.
no setter
currentItem → T?
Gets the currently displayed item.
no setter
hashCode → int
The hash code for this object.
no setterinherited
isPlaying → bool
Checks if auto-play is currently active.
no setter
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 → AnimatedCycler<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
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.
override
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant AnimatedCycler<T> oldWidget) → void
Called whenever the widget configuration changes.
override
dispose() → void
Called when this object is removed from the tree permanently.
override
goToIndex(int index) → void
Jumps directly to the item at the specified index.
initState() → void
Called when this object is inserted into the tree.
override
nextItem() → void
Manually advances to the next item.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pause() → void
Pauses auto-play without affecting the autoPlay setting.
previousItem() → void
Manually goes back to the previous item.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
resume() → void
Resumes auto-play if autoPlay is true.
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
togglePlayPause() → void
Toggles auto-play between paused and playing states.
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