RecyclerView.SmoothScroller.Action - Android SDK

Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]

public static class

RecyclerView.SmoothScroller.Action

extends Object

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

Class Overview

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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Constants

public static final int UNDEFINED_DURATION

Constant Value: -2147483648 (0x80000000)

Public Constructors

public RecyclerView.SmoothScroller.Action (int dx, int dy)

Parameters

dx	Pixels to scroll horizontally
dy	Pixels to scroll vertically

public RecyclerView.SmoothScroller.Action (int dx, int dy, int duration)

Parameters

dx	Pixels to scroll horizontally
dy	Pixels to scroll vertically
duration	Duration of the animation in milliseconds

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

Parameters

dx	Pixels to scroll horizontally
dy	Pixels to scroll vertically
duration	Duration of the animation in milliseconds
interpolator	Interpolator to be used when calculating scroll position in each animation step

Public Methods

public int getDuration ()

public int getDx ()

public int getDy ()

public Interpolator getInterpolator ()

public 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	The target item position to scroll to using instant scrolling.

public void setDuration (int duration)

public void setDx (int dx)

public void setDy (int dy)

public void setInterpolator (Interpolator interpolator)

Sets the interpolator to calculate scroll steps

Parameters

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

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

Updates the action with given parameters.

Parameters

dx	Pixels to scroll horizontally
dy	Pixels to scroll vertically
duration	Duration of the animation in milliseconds
interpolator	Interpolator to be used when calculating scroll position in each animation step

Results

Interfaces

Classes

RecyclerView.SmoothScroller.Action

Class Overview

Summary

Constants

public static final int UNDEFINED_DURATION

Public Constructors

public RecyclerView.SmoothScroller.Action (int dx, int dy)

Parameters

public RecyclerView.SmoothScroller.Action (int dx, int dy, int duration)

Parameters

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

Parameters

Public Methods

public int getDuration ()

public int getDx ()

public int getDy ()

public Interpolator getInterpolator ()

public void jumpTo (int targetPosition)

Parameters

public void setDuration (int duration)

public void setDx (int dx)

public void setDy (int dy)

public void setInterpolator (Interpolator interpolator)

Parameters

See Also

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

Parameters