HoldScrollActivity class

A scroll activity that does nothing but can be released to resume normal idle behavior.

This is used while the user is touching the Scrollable but before the touch has become a Drag.

For the purposes of ScrollNotifications, this activity does not constitute scrolling, and does not prevent the user from interacting with the contents of the Scrollable (unlike when a drag has begun or there is a scroll animation underway).

Inheritance
Implemented types

Constructors

HoldScrollActivity({required ScrollActivityDelegate delegate, VoidCallback? onHoldCanceled})
Creates a scroll activity that does nothing.

Properties

delegate ScrollActivityDelegate
The delegate that this activity will use to actuate the scroll view.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
isScrolling bool
Whether performing this activity constitutes scrolling.
no setteroverride
onHoldCanceled VoidCallback?
Called when dispose is called.
final
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

applyNewDimensions() → void
Called when the scroll view that is performing this activity changes its metrics.
inherited
cancel() → void
Release the Scrollable, potentially letting it go ballistic if necessary.
override
dispatchOverscrollNotification(ScrollMetrics metrics, BuildContext context, double overscroll) → void
Dispatch an OverscrollNotification with the given metrics and overscroll.
inherited
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.
inherited
updateDelegate(ScrollActivityDelegate value) → void
Updates the activity's link to the ScrollActivityDelegate.
inherited

Operators

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