RecyclerView.SmoothScroller.Action
public
static
class
RecyclerView.SmoothScroller.Action
extends Object
java.lang.Object | |
↳ | androidx.recyclerview.widget.RecyclerView.SmoothScroller.Action |
Holds information about a smooth scroll request by a RecyclerView.SmoothScroller
.
Summary
Constants | |
---|---|
int |
UNDEFINED_DURATION
|
Public constructors | |
---|---|
Action(int dx, int dy)
|
|
Action(int dx, int dy, int duration)
|
|
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
|
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 | |
---|---|
Constants
UNDEFINED_DURATION
public static final int UNDEFINED_DURATION
Constant Value: -2147483648 (0x80000000)
Public constructors
Action
public Action (int dx, int dy)
Parameters | |
---|---|
dx |
int : Pixels to scroll horizontally |
dy |
int : Pixels to scroll vertically
|
Action
public 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
|
Action
public 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
public int getDuration ()
Returns | |
---|---|
int |
getDx
public int getDx ()
Returns | |
---|---|
int |
getDy
public int getDy ()
Returns | |
---|---|
int |
jumpTo
public void jumpTo (int targetPosition)
Instead of specifying pixels to scroll, use the target position to jump using
RecyclerView.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)
, View.setX(float)
,
View.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
public void setDuration (int duration)
Parameters | |
---|---|
duration |
int |
setDx
public void setDx (int dx)
Parameters | |
---|---|
dx |
int |
setDy
public void setDy (int dy)
Parameters | |
---|---|
dy |
int |
setInterpolator
public 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
public 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
|