YaruCarouselController class
A controller that can be used to enable the auto-scroll behavior of a YaruCarousel. It can also be used to navigate to a specific page.
- Inheritance
-
- Object
- ChangeNotifier
- ScrollController
- PageController
- YaruCarouselController
Constructors
- YaruCarouselController({int initialPage = 0, bool keepPage = true, double viewportFraction = 0.8, Duration scrollAnimationDuration = const Duration(milliseconds: 500), Curve scrollAnimationCurve = Curves.easeInOutCubic, bool autoScroll = false, Duration autoScrollDuration = const Duration(seconds: 3)})
- Creates a YaruCarousel.
Properties
- autoScroll → bool
-
Enable an auto scrolling loop of all children.
final
- autoScrollDuration → Duration
-
If autoScroll is enabled, this value determine the time spent on each carousel child.
final
- 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
- initialPage → int
-
The page to show when first creating the PageView.
finalinherited
- initialScrollOffset → double
-
The initial value to use for offset.
no setterinherited
- keepPage → bool
-
Save the current page with PageStorage and restore it if
this controller's scrollable is recreated.
finalinherited
- 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
- page → double?
-
The current page displayed in the controlled PageView.
no setterinherited
- 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
- scrollAnimationCurve → Curve
-
Default curve used in a transition between two page.
final
- scrollAnimationDuration → Duration
-
Default duration of a transition between two pages.
final
- viewportFraction → double
-
The fraction of the viewport that each page should occupy.
finalinherited
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
-
animateToPage(
int page, {Duration? duration, Curve? curve}) → Future< void> -
Animates the controlled PageView from the current page to the given page.
override
-
attach(
ScrollPosition position) → void -
Register the given position with this controller.
override
-
cancelTimer(
) → void - Cancel the auto-scroll timer.
-
createScrollPosition(
ScrollPhysics physics, ScrollContext context, ScrollPosition? oldPosition) → ScrollPosition -
Creates a ScrollPosition for use by a Scrollable widget.
inherited
-
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.
override
-
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
-
jumpToPage(
int page) → void -
Changes which page is displayed in the controlled PageView.
override
-
nextPage(
{Duration? duration, Curve? curve}) → Future< void> -
Animates the controlled PageView to the next page.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
previousPage(
{Duration? duration, Curve? curve}) → Future< void> -
Animates the controlled PageView to the previous page.
override
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
startTimer(
) → void - Start the auto-scroll timer.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited