M3ECarouselController class

A controller for the carousel and M3ECarouselView.

next, previous, animateToItem, and jumpToItem move by the same step as a swipe. showAll opens the carousel list. currentItem is the item that step is aiming at.

Inheritance

Constructors

M3ECarouselController({int initialItem = 0})
Creates a carousel controller.

Properties

currentItem → int
Item the next swipe or next call continues from.
no setter
debugLabel → String?
A label that is used in the toString output. Intended to aid with identifying scroll controller instances in debug output.
finalinherited
hasClients → bool
Whether any ScrollPosition objects have attached themselves to the ScrollController using the attach method.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
initialItem → int
The item that expands to the maximum size when first creating the M3ECarouselView.
final
initialScrollOffset → double
The initial value to use for offset.
no setterinherited
keepScrollOffset → bool
Each time a scroll completes, save the current scroll offset with PageStorage and restore it if this controller's scrollable is recreated.
finalinherited
leadingItem → int
The current leading item index in the M3ECarouselView.
no setter
offset → double
The current scroll offset of the scrollable widget.
no setterinherited
onAttach → ScrollControllerCallback?
Called when a ScrollPosition is attached to the scroll controller.
finalinherited
onDetach → ScrollControllerCallback?
Called when a ScrollPosition is detached from the scroll controller.
finalinherited
position → ScrollPosition
Returns the attached ScrollPosition, from which the actual scroll offset of the ScrollView can be obtained.
no setterinherited
positions → Iterable<ScrollPosition>
The currently attached positions.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
variedItemExtents ↔ List<double>?
Main-axis extents for a multi-aspect carousel.
getter/setter pair
variedLeadingGap ↔ double
Space before the first multi-aspect item. Later items sit flush.
getter/setter pair

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
animateTo(double offset, {required Duration duration, required Curve curve}) → Future<void>
Animates the position from its current value to the given value.
inherited
animateToItem(int index, {Duration duration = const Duration(milliseconds: 300), Curve curve = Curves.ease}) → Future<void>
Animates the controlled carousel to the given item index.
attach(ScrollPosition position) → void
Register the given position with this controller.
override
attachActions({required int currentItem(), required Future<void> step(int direction), required Future<void> moveTo(int index, {required Curve curve, required Duration duration, required bool jump}), required void showAll()}) → void
Binds the carousel that this controller drives.
createScrollPosition(ScrollPhysics physics, ScrollContext context, ScrollPosition? oldPosition) → ScrollPosition
Creates a ScrollPosition for use by a Scrollable widget.
override
debugFillDescription(List<String> description) → void
Add additional information to the given description for use by toString.
inherited
detach(ScrollPosition position) → void
Unregister the given position with this controller.
inherited
detachActions() → void
Drops the actions bound by attachActions.
dispose() → void
Discards any resources used by the object.
inherited
jumpTo(double value) → void
Jumps the scroll position from its current value to the given value, without animation, and without checking if the new value is in range.
inherited
jumpToItem(int index) → void
Jumps to index without animating.
next() → Future<void>
Scrolls one item forward, the same way a swipe does.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
previous() → Future<void>
Scrolls one item back, the same way a swipe does.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
showAll() → void
Opens the show-all list.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited