ScrollStreamController class

A ScrollController with ChangeNotifierStream.

Mixed in types


ScrollStreamController({double initialScrollOffset, bool keepScrollOffset, String debugLabel})


controllers Set<MultiStreamController<ScrollController>>
@visibleForTesting, read / write, inherited
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
stream Stream<ScrollController>
Stream of T extending ChangeNotifier, on a change notification. [...]
read-only, inherited


addListener(VoidCallback listener) → void
Register a closure to be called when the object changes. [...]
animateTo(double offset, {required Duration duration, required Curve curve}) Future<void>
Animates the position from its current value to the given value. [...]
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. [...]
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. [...]
dispose() Future<void>
Do super.dispose and close all the streams. [...]
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. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
notifyListeners() → void
Call all the registered listeners. [...]
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes. [...]
toString() String
A string representation of this object. [...]


operator ==(Object other) bool
The equality operator. [...]