CustomCarouselScrollController class
A ScrollController that provides additional capabilities for use with CustomCarousel.
It adds item oriented features such as selectedItem, animateToItem, jumpToItem,
nextItem, and previousItem. Via CustomCarouselScrollPosition, it also provides
support for CustomCarousel.loop functionality, and reasonable defaults for
duration
and curve
on scroll animations.
- Inheritance
-
- Object
- ChangeNotifier
- ScrollController
- CustomCarouselScrollController
Constructors
- CustomCarouselScrollController({int initialItem = 0})
- Creates a scroll controller for CustomCarousel.
Properties
- 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 to show when first creating the scroll view.
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
- 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 → CustomCarouselScrollPosition
-
Returns the attached ScrollPosition, from which the actual scroll offset
of the ScrollView can be obtained.
no setteroverride
-
positions
→ Iterable<
ScrollPosition> -
The currently attached positions.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedItem → int
-
The currently selected item index.
no setter
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
animateTo(
double offset, {Duration? duration, Curve? curve}) → Future< void> -
Animates the position from its current value to the given value.
override
-
animateToItem(
int itemIndex, {Duration? duration, Curve? curve}) → Future< void> - Animates the controlled scroll view to the given item index.
-
attach(
ScrollPosition position) → void -
Register the given position with this controller.
inherited
-
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
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
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 itemIndex) → void - Changes which item index is centered in the controlled scroll view.
-
nextItem(
{Duration? duration, Curve? curve}) → Future< void> - Animates the controlled scroll view to the next item.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
previousItem(
{Duration? duration, Curve? curve}) → Future< void> - Animates the controlled scroll view to the previous item.
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited