PageIndicatorController class Null safety

A PageController for a PageView that uses a PageIndicator.

The PageController can infer the page as well as the pageCount for a PageIndicator.

Inheritance

Constructors

PageIndicatorController({int initialPage = 0, bool keepPage = true, double viewportFraction = 1.0})

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.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
hasListeners bool
Whether any listeners are currently registered.
@protectedread-onlyinherited
initialPage int
The page to show when first creating the PageView.
finalinherited
initialScrollOffset double
The initial value to use for offset.
read-onlyinherited
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.
read-onlyinherited
onAnimateToPage ↔ (void Function?(int page, Duration duration)?)
read / write
page double?
The current page displayed in the controlled PageView.
read-onlyinherited
pageCount int
read-only
position ScrollPosition
Returns the attached ScrollPosition, from which the actual scroll offset of the ScrollView can be obtained.
read-onlyinherited
positions Iterable<ScrollPosition>
The currently attached positions.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
viewportFraction double
The fraction of the viewport that each page should occupy.
finalinherited
viewportSize double
read-only

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 = const Duration(milliseconds: 400), Curve curve = Curves.linear}) 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.
inherited
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.
@mustCallSuperinherited
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).
override
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.
inherited
nextPage({required Duration duration, required Curve curve}) Future<void>
Animates the controlled PageView to the next page.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
previousPage({required Duration duration, required Curve curve}) Future<void>
Animates the controlled PageView to the previous page.
inherited
registerIndicator(PageIndicatorState<PageIndicator, IndicatorData> indicator) → void
Registers the current indicator to listen for events of this PageIndicatorController.
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
unregisterIndicator(PageIndicatorState<PageIndicator, IndicatorData> indicator) → void
Unregisters the current indicator to listen for events of this PageIndicatorController.

Operators

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