Methods
absorb (ScrollPosition other → void
Take any current applicable state from the given ScrollPosition .
inherited
addListener (VoidCallback listener → void
Register a closure to be called when the object changes.
inherited
animateTo (double to , {required Duration duration , required Curve curve }→ Future <void >
Animates the position from its current value to the given value.
inherited
applyBoundaryConditions (double value → double
Returns the overscroll by applying the boundary conditions.
applyContentDimensions (double minScrollExtent , double maxScrollExtent → bool
Called when the viewport's content extents are established.
inherited
applyNewDimensions ()
→ void
Notifies the activity that the dimensions of the underlying viewport or
contents have changed.
inherited
applyUserOffset (double delta → void
Updates the scroll position by the given amount.
override
applyViewportDimension (double viewportDimension → bool
Called when the viewport's extents are established.
inherited
beginActivity (ScrollActivity ?newActivity → void
Change the current activity , disposing of the old one and
sending scroll notifications as necessary.
inherited
copyWith ({double ?minScrollExtent , double ?maxScrollExtent , double ?pixels , double ?viewportDimension , AxisDirection ?axisDirection }→ ScrollMetrics
Creates a ScrollMetrics that has the same properties as this object.
inherited
correctBy (double correction → void
Apply a layout-time correction to the scroll offset.
inherited
correctForNewDimensions (ScrollMetrics oldPosition , ScrollMetrics newPosition → bool
Verifies that the new content and viewport dimensions are acceptable.
correctPixels (double value → void
Change the value of pixels to the new value, without notifying any
customers.
inherited
debugFillDescription (List <String description → void
Add additional information to the given description for use by toString .
inherited
didEndScroll ()
→ void
Called by beginActivity to report when an activity has ended.
inherited
didOverscrollBy (double value → void
Called by setPixels to report overscroll when an attempt is made to
change the pixels position. Overscroll is the amount of change that was
not applied to the pixels value.
inherited
didStartScroll ()
→ void
Called by beginActivity to report when an activity has started.
inherited
didUpdateScrollDirection (ScrollDirection direction → void
Dispatches a notification that the userScrollDirection has changed.
inherited
didUpdateScrollMetrics ()
→ void
Dispatches a notification that the ScrollMetrics have changed.
inherited
didUpdateScrollPositionBy (double delta → void
Called by setPixels to report a change to the pixels position.
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 will throw after the object is disposed).
inherited
drag (DragStartDetails details , VoidCallback dragCancelCallback → Drag
Start a drag activity corresponding to the given DragStartDetails .
inherited
ensureVisible (RenderObject object , {double alignment = 0.0 , Duration duration = Duration.zero , Curve curve = Curves.ease , ScrollPositionAlignmentPolicy alignmentPolicy = ScrollPositionAlignmentPolicy.explicit , RenderObject ?targetRenderObject }→ Future <void >
Animates the position such that the given object is as visible as possible
by just scrolling this position.
inherited
forcePixels (double value → void
Change the value of pixels to the new value, and notify any customers,
but without honoring normal conventions for changing the scroll offset.
goBallistic (double velocity → void
Start a physics-driven simulation that settles the pixels position,
starting at a particular velocity.
override
goIdle ()
→ void
Terminate the current activity and start an idle activity.
inherited
hold (VoidCallback holdCancelCallback → ScrollHoldController
Stop the current activity and start a HoldScrollActivity .
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
jumpToWithoutSettling (double value → void
Deprecated. Use jumpTo or a custom ScrollPosition instead.
moveTo (double to , {Duration ?duration , Curve ?curve , bool ?clamp = true }→ Future <void >
Calls jumpTo if duration is null or Duration.zero , otherwise
animateTo is called.
inherited
noSuchMethod (Invocation invocation → dynamic
Invoked when a non-existent method or property is accessed.
inherited
notifyListeners ()
→ void
Call all the registered listeners.
inherited
pointerScroll (double delta → void
Changes the scrolling position based on a pointer signal from current
value to delta without animation and without checking if new value is in
range, taking min/max scroll extent into account.
inherited
recommendDeferredLoading (BuildContext context → bool
Provides a heuristic to determine if expensive frame-bound tasks should be
deferred.
inherited
removeListener (VoidCallback listener → void
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
restoreOffset (double offset , {bool initialRestore = false } )
→ void
Called by context to restore the scroll offset to the provided value.
inherited
restoreScrollOffset ()
→ void
Called whenever the ScrollPosition is created, to restore the scroll
offset if possible.
saveOffset ()
→ void
Called whenever scrolling ends, to persist the current scroll offset for
state restoration purposes.
saveScrollOffset ()
→ void
Called whenever scrolling ends, to store the current scroll offset in a
storage mechanism with a lifetime that matches the app's lifetime.
setPixels (double newPixels → double
Update the scroll position (pixels ) to a given pixel value.
inherited
toString ()
→ String
A string representation of this object.
inherited
updateUserScrollDirection (ScrollDirection value → void
Set userScrollDirection to the given value.
