FixedExtentScrollController class
A controller for scroll views whose items have the same size.
Similar to a standard ScrollController but with the added convenience mechanisms to read and go to item indices rather than a raw pixel scroll offset.
See also:
- ListWheelScrollView, a scrollable view widget with fixed size items that this widget controls.
- FixedExtentMetrics, the
metrics
property exposed by ScrollNotification from ListWheelScrollView which can be used to listen to the current item index on a push basis rather than polling the FixedExtentScrollController.
- Inheritance
- Object
- ChangeNotifier
- ScrollController
- FixedExtentScrollController
Constructors
- FixedExtentScrollController({int initialItem: 0 })
- Creates a scroll controller for scrollables whose items have the same size. [...]
Properties
- initialItem → int
-
The page to show when first creating the scroll view. [...]
final
- selectedItem → int
-
The currently selected item index that's closest to the center of the viewport. [...]
read-only
- 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
-
animateToItem(
int itemIndex, { Duration duration, Curve curve }) → Future< void> - Animates the controlled scroll view to the given item index. [...]
-
createScrollPosition(
ScrollPhysics physics, ScrollContext context, ScrollPosition oldPosition) → ScrollPosition -
Creates a ScrollPosition for use by a Scrollable widget. [...]
override
-
jumpToItem(
int itemIndex) → void - Changes which item index is centered in the controlled scroll view. [...]
-
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. [...]
inherited
-
attach(
ScrollPosition position) → void -
Register the given position with this controller. [...]
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(
VoidCallback 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