Skip to content

Most visited

Recently visited

navigation

ScrollerCompat

public final class ScrollerCompat
extends Object

java.lang.Object
   ↳ android.support.v4.widget.ScrollerCompat


Provides access to new Scroller APIs when available.

This class provides a platform version-independent mechanism for obeying the current device's preferred scroll physics and fling behavior. It offers a subset of the APIs from Scroller or OverScroller.

Summary

Public methods

void abortAnimation()

Stops the animation.

boolean computeScrollOffset()

Call this when you want to know the new location.

static ScrollerCompat create(Context context, Interpolator interpolator)
static ScrollerCompat create(Context context)
void fling(int startX, int startY, int velocityX, int velocityY, int minX, int maxX, int minY, int maxY)

Start scrolling based on a fling gesture.

void fling(int startX, int startY, int velocityX, int velocityY, int minX, int maxX, int minY, int maxY, int overX, int overY)

Start scrolling based on a fling gesture.

float getCurrVelocity()

Returns the current velocity on platform versions that support it.

int getCurrX()

Returns the current X offset in the scroll.

int getCurrY()

Returns the current Y offset in the scroll.

int getFinalX()
int getFinalY()
boolean isFinished()

Returns whether the scroller has finished scrolling.

boolean isOverScrolled()

Returns whether the current Scroller is currently returning to a valid position.

void notifyHorizontalEdgeReached(int startX, int finalX, int overX)

Notify the scroller that we've reached a horizontal boundary.

void notifyVerticalEdgeReached(int startY, int finalY, int overY)

Notify the scroller that we've reached a vertical boundary.

boolean springBack(int startX, int startY, int minX, int maxX, int minY, int maxY)

Call this when you want to 'spring back' into a valid coordinate range.

void startScroll(int startX, int startY, int dx, int dy, int duration)

Start scrolling by providing a starting point and the distance to travel.

void startScroll(int startX, int startY, int dx, int dy)

Start scrolling by providing a starting point and the distance to travel.

Inherited methods

From class java.lang.Object

Public methods

abortAnimation

void abortAnimation ()

Stops the animation. Aborting the animation causes the scroller to move to the final x and y position.

computeScrollOffset

boolean computeScrollOffset ()

Call this when you want to know the new location. If it returns true, the animation is not yet finished. loc will be altered to provide the new location.

Returns
boolean

create

ScrollerCompat create (Context context, 
                Interpolator interpolator)

Parameters
context Context
interpolator Interpolator
Returns
ScrollerCompat

create

ScrollerCompat create (Context context)

Parameters
context Context
Returns
ScrollerCompat

fling

void fling (int startX, 
                int startY, 
                int velocityX, 
                int velocityY, 
                int minX, 
                int maxX, 
                int minY, 
                int maxY)

Start scrolling based on a fling gesture. The distance travelled will depend on the initial velocity of the fling.

Parameters
startX int: Starting point of the scroll (X)
startY int: Starting point of the scroll (Y)
velocityX int: Initial velocity of the fling (X) measured in pixels per second.
velocityY int: Initial velocity of the fling (Y) measured in pixels per second
minX int: Minimum X value. The scroller will not scroll past this point.
maxX int: Maximum X value. The scroller will not scroll past this point.
minY int: Minimum Y value. The scroller will not scroll past this point.
maxY int: Maximum Y value. The scroller will not scroll past this point.

fling

void fling (int startX, 
                int startY, 
                int velocityX, 
                int velocityY, 
                int minX, 
                int maxX, 
                int minY, 
                int maxY, 
                int overX, 
                int overY)

Start scrolling based on a fling gesture. The distance travelled will depend on the initial velocity of the fling.

Parameters
startX int: Starting point of the scroll (X)
startY int: Starting point of the scroll (Y)
velocityX int: Initial velocity of the fling (X) measured in pixels per second.
velocityY int: Initial velocity of the fling (Y) measured in pixels per second
minX int: Minimum X value. The scroller will not scroll past this point.
maxX int: Maximum X value. The scroller will not scroll past this point.
minY int: Minimum Y value. The scroller will not scroll past this point.
maxY int: Maximum Y value. The scroller will not scroll past this point.
overX int: Overfling range. If > 0, horizontal overfling in either direction will be possible.
overY int: Overfling range. If > 0, vertical overfling in either direction will be possible.

getCurrVelocity

float getCurrVelocity ()

Returns the current velocity on platform versions that support it.

The device must support at least API level 14 (Ice Cream Sandwich). On older platform versions this method will return 0. This method should only be used as input for nonessential visual effects such as EdgeEffectCompat.

Returns
float The original velocity less the deceleration. Result may be negative.

getCurrX

int getCurrX ()

Returns the current X offset in the scroll.

Returns
int The new X offset as an absolute distance from the origin.

getCurrY

int getCurrY ()

Returns the current Y offset in the scroll.

Returns
int The new Y offset as an absolute distance from the origin.

getFinalX

int getFinalX ()

Returns
int The final X position for the scroll in progress, if known.

getFinalY

int getFinalY ()

Returns
int The final Y position for the scroll in progress, if known.

isFinished

boolean isFinished ()

Returns whether the scroller has finished scrolling.

Returns
boolean True if the scroller has finished scrolling, false otherwise.

isOverScrolled

boolean isOverScrolled ()

Returns whether the current Scroller is currently returning to a valid position. Valid bounds were provided by the fling(int, int, int, int, int, int, int, int, int, int) method. One should check this value before calling startScroll(int, int, int, int) as the interpolation currently in progress to restore a valid position will then be stopped. The caller has to take into account the fact that the started scroll will start from an overscrolled position.

Returns
boolean true when the current position is overscrolled and in the process of interpolating back to a valid value.

notifyHorizontalEdgeReached

void notifyHorizontalEdgeReached (int startX, 
                int finalX, 
                int overX)

Notify the scroller that we've reached a horizontal boundary. Normally the information to handle this will already be known when the animation is started, such as in a call to one of the fling functions. However there are cases where this cannot be known in advance. This function will transition the current motion and animate from startX to finalX as appropriate.

Parameters
startX int: Starting/current X position
finalX int: Desired final X position
overX int: Magnitude of overscroll allowed. This should be the maximum desired distance from finalX. Absolute value - must be positive.

notifyVerticalEdgeReached

void notifyVerticalEdgeReached (int startY, 
                int finalY, 
                int overY)

Notify the scroller that we've reached a vertical boundary. Normally the information to handle this will already be known when the animation is started, such as in a call to one of the fling functions. However there are cases where this cannot be known in advance. This function will animate a parabolic motion from startY to finalY.

Parameters
startY int: Starting/current Y position
finalY int: Desired final Y position
overY int: Magnitude of overscroll allowed. This should be the maximum desired distance from finalY. Absolute value - must be positive.

springBack

boolean springBack (int startX, 
                int startY, 
                int minX, 
                int maxX, 
                int minY, 
                int maxY)

Call this when you want to 'spring back' into a valid coordinate range.

Parameters
startX int: Starting X coordinate
startY int: Starting Y coordinate
minX int: Minimum valid X value
maxX int: Maximum valid X value
minY int: Minimum valid Y value
maxY int: Maximum valid Y value
Returns
boolean true if a springback was initiated, false if startX and startY were already within the valid range.

startScroll

void startScroll (int startX, 
                int startY, 
                int dx, 
                int dy, 
                int duration)

Start scrolling by providing a starting point and the distance to travel.

Parameters
startX int: Starting horizontal scroll offset in pixels. Positive numbers will scroll the content to the left.
startY int: Starting vertical scroll offset in pixels. Positive numbers will scroll the content up.
dx int: Horizontal distance to travel. Positive numbers will scroll the content to the left.
dy int: Vertical distance to travel. Positive numbers will scroll the content up.
duration int: Duration of the scroll in milliseconds.

startScroll

void startScroll (int startX, 
                int startY, 
                int dx, 
                int dy)

Start scrolling by providing a starting point and the distance to travel. The scroll will use the default value of 250 milliseconds for the duration.

Parameters
startX int: Starting horizontal scroll offset in pixels. Positive numbers will scroll the content to the left.
startY int: Starting vertical scroll offset in pixels. Positive numbers will scroll the content up.
dx int: Horizontal distance to travel. Positive numbers will scroll the content to the left.
dy int: Vertical distance to travel. Positive numbers will scroll the content up.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.