DrivenScrollActivity class
An activity that drives a scroll view through a given animation.
For example, a DrivenScrollActivity is used to implement ScrollController.animateTo.
The scrolling will be driven by the given animation parameters or the given Simulation.
Unlike a BallisticScrollActivity, if a DrivenScrollActivity is in progress when the scroll metrics change, the activity will continue with its original animation.
See also:
- BallisticScrollActivity, which sets into motion a scroll view.
- Inheritance
-
- Object
- ScrollActivity
- DrivenScrollActivity
Constructors
- DrivenScrollActivity(ScrollActivityDelegate delegate, {required double from, required double to, required Duration duration, required Curve curve, required TickerProvider vsync})
- Creates an activity that drives a scroll view through an animation given by animation parameters.
- DrivenScrollActivity.simulation(ScrollActivityDelegate delegate, Simulation simulation, {required TickerProvider vsync})
- Creates an activity that drives a scroll view through an animation given by a Simulation.
Properties
- delegate → ScrollActivityDelegate
-
The delegate that this activity will use to actuate the scroll view.
no setterinherited
-
done
→ Future<
void> -
A Future that completes when the activity stops.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isScrolling → bool
-
Whether performing this activity constitutes scrolling.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shouldIgnorePointer → bool
-
Whether the scroll view should ignore pointer events while performing this
activity.
no setteroverride
- velocity → double
-
If applicable, the velocity at which the scroll offset is currently
independently changing (i.e. without external stimuli such as a dragging
gestures) in logical pixels per second for this activity.
no setteroverride
Methods
-
applyMoveTo(
double value) → bool - Move the position to the given location.
-
applyNewDimensions(
) → void -
Called when the scroll view that is performing this activity changes its metrics.
inherited
-
dispatchOverscrollNotification(
ScrollMetrics metrics, BuildContext context, double overscroll) → void -
Dispatch an OverscrollNotification with the given metrics and overscroll.
override
-
dispatchScrollEndNotification(
ScrollMetrics metrics, BuildContext context) → void -
Dispatch a ScrollEndNotification with the given metrics and overscroll.
inherited
-
dispatchScrollStartNotification(
ScrollMetrics metrics, BuildContext? context) → void -
Dispatch a ScrollStartNotification with the given metrics.
inherited
-
dispatchScrollUpdateNotification(
ScrollMetrics metrics, BuildContext context, double scrollDelta) → void -
Dispatch a ScrollUpdateNotification with the given metrics and scroll delta.
inherited
-
dispose(
) → void -
Called when the scroll view stops performing this activity.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resetActivity(
) → void -
Called by the ScrollActivityDelegate when it has changed type (for
example, when changing from an Android-style scroll position to an
iOS-style scroll position). If this activity can differ between the two
modes, then it should tell the position to restart that activity
appropriately.
inherited
-
toString(
) → String -
A string representation of this object.
override
-
updateDelegate(
ScrollActivityDelegate value) → void -
Updates the activity's link to the ScrollActivityDelegate.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited