lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey
added in version 22.1.0
belongs to Maven artifact com.android.support:recyclerview-v7:28.0.0-alpha1

RecyclerView.SmoothScroller.Action

public static class RecyclerView.SmoothScroller.Action
extends Object

java.lang.Object
   ↳ android.support.v7.widget.RecyclerView.SmoothScroller.Action


Holds information about a smooth scroll request by a RecyclerView.SmoothScroller.

Summary

Constants

int UNDEFINED_DURATION

Public constructors

RecyclerView.SmoothScroller.Action(int dx, int dy)
RecyclerView.SmoothScroller.Action(int dx, int dy, int duration)
RecyclerView.SmoothScroller.Action(int dx, int dy, int duration, Interpolator interpolator)

Public methods

int getDuration()
int getDx()
int getDy()
Interpolator getInterpolator()
void jumpTo(int targetPosition)

Instead of specifying pixels to scroll, use the target position to jump using scrollToPosition(int).

void setDuration(int duration)
void setDx(int dx)
void setDy(int dy)
void setInterpolator(Interpolator interpolator)

Sets the interpolator to calculate scroll steps

void update(int dx, int dy, int duration, Interpolator interpolator)

Updates the action with given parameters.

Inherited methods

From class java.lang.Object

Constants

UNDEFINED_DURATION

added in version 22.1.0
int UNDEFINED_DURATION

Constant Value: -2147483648 (0x80000000)

Public constructors

RecyclerView.SmoothScroller.Action

added in version 22.1.0
RecyclerView.SmoothScroller.Action (int dx, 
                int dy)

Parameters
dx int: Pixels to scroll horizontally

dy int: Pixels to scroll vertically

RecyclerView.SmoothScroller.Action

added in version 22.1.0
RecyclerView.SmoothScroller.Action (int dx, 
                int dy, 
                int duration)

Parameters
dx int: Pixels to scroll horizontally

dy int: Pixels to scroll vertically

duration int: Duration of the animation in milliseconds

RecyclerView.SmoothScroller.Action

added in version 22.1.0
RecyclerView.SmoothScroller.Action (int dx, 
                int dy, 
                int duration, 
                Interpolator interpolator)

Parameters
dx int: Pixels to scroll horizontally

dy int: Pixels to scroll vertically

duration int: Duration of the animation in milliseconds

interpolator Interpolator: Interpolator to be used when calculating scroll position in each animation step

Public methods

getDuration

added in version 22.1.0
int getDuration ()

Returns
int

getDx

added in version 22.1.0
int getDx ()

Returns
int

getDy

added in version 22.1.0
int getDy ()

Returns
int

getInterpolator

added in version 22.1.0
Interpolator getInterpolator ()

Returns
Interpolator

jumpTo

added in version 24.1.0
void jumpTo (int targetPosition)

Instead of specifying pixels to scroll, use the target position to jump using scrollToPosition(int).

You may prefer using this method if scroll target is really far away and you prefer to jump to a location and smooth scroll afterwards.

Note that calling this method takes priority over other update methods such as update(int, int, int, Interpolator), setX(float), setY(float) and #setInterpolator(Interpolator). If you call jumpTo(int), the other changes will not be considered for this animation frame.

Parameters
targetPosition int: The target item position to scroll to using instant scrolling.

setDuration

added in version 22.1.0
void setDuration (int duration)

Parameters
duration int

setDx

added in version 22.1.0
void setDx (int dx)

Parameters
dx int

setDy

added in version 22.1.0
void setDy (int dy)

Parameters
dy int

setInterpolator

added in version 22.1.0
void setInterpolator (Interpolator interpolator)

Sets the interpolator to calculate scroll steps

Parameters
interpolator Interpolator: The interpolator to use. If you specify an interpolator, you must also set the duration.

See also:

update

added in version 22.1.0
void update (int dx, 
                int dy, 
                int duration, 
                Interpolator interpolator)

Updates the action with given parameters.

Parameters
dx int: Pixels to scroll horizontally

dy int: Pixels to scroll vertically

duration int: Duration of the animation in milliseconds

interpolator Interpolator: Interpolator to be used when calculating scroll position in each animation step