PageController class

A controller for PageView.

A page controller lets you manipulate which page is visible in a PageView. In addition to being able to control the pixel offset of the content inside the PageView, a PageController also lets you control the offset in terms of pages, which are increments of the viewport size.

See also:

  • PageView, which is the widget this object controls.
Inheritance

Constructors

PageController({int initialPage: 0, bool keepPage: true, double viewportFraction: 1.0 })
Creates a page controller. [...]

Properties

initialPage → int
The page to show when first creating the PageView.
final
keepPage → bool
Save the current page with PageStorage and restore it if this controller's scrollable is recreated. [...]
final
page → double
The current page displayed in the controlled PageView. [...]
read-only
viewportFraction → double
The fraction of the viewport that each page should occupy. [...]
final
debugLabel → String
A label that is used in the toString output. Intended to aid with identifying scroll controller instances in debug output.
final, inherited
hasClients → bool
Whether any ScrollPosition objects have attached themselves to the ScrollController using the attach method. [...]
read-only, inherited
hashCode → int
The hash code for this object. [...]
read-only, inherited
hasListeners → bool
Whether any listeners are currently registered. [...]
@protected, read-only, inherited
initialScrollOffset → double
The initial value to use for offset. [...]
read-only, inherited
keepScrollOffset → bool
Each time a scroll completes, save the current scroll offset with PageStorage and restore it if this controller's scrollable is recreated. [...]
final, inherited
offset → double
The current scroll offset of the scrollable widget. [...]
read-only, inherited
position ScrollPosition
Returns the attached ScrollPosition, from which the actual scroll offset of the ScrollView can be obtained. [...]
read-only, inherited
positions → Iterable<ScrollPosition>
The currently attached positions. [...]
@protected, read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

animateToPage(int page, { Duration duration, Curve curve }) → Future<Null>
Animates the controlled PageView from the current page to the given page. [...]
attach(ScrollPosition position) → void
Register the given position with this controller. [...]
createScrollPosition(ScrollPhysics physics, ScrollContext context, ScrollPosition oldPosition) ScrollPosition
Creates a ScrollPosition for use by a Scrollable widget. [...]
jumpToPage(int page) → void
Changes which page is displayed in the controlled PageView. [...]
nextPage({Duration duration, Curve curve }) → Future<Null>
Animates the controlled PageView to the next page. [...]
previousPage({Duration duration, Curve curve }) → Future<Null>
Animates the controlled PageView to the previous page. [...]
addListener(void listener) → void
Register a closure to be called when the object changes. [...]
inherited
animateTo(double offset, { Duration duration, Curve curve }) → Future<Null>
Animates the position from its current value to the given value. [...]
inherited
debugFillDescription(List<String> description) → void
Add additional information to the given description for use by toString. [...]
@mustCallSuper, 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 and removeListener 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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
notifyListeners() → void
Call all the registered listeners. [...]
@protected, inherited
removeListener(void listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited