Most visited

Recently visited

Results for

RecyclerView.SmoothScroller

public static abstract class RecyclerView.SmoothScroller
extends Object

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

Known Direct Subclasses

LinearSmoothScroller

Base class for smooth scrolling. Handles basic tracking of the target view position and provides methods to trigger a programmatic scroll.

See also:

LinearSmoothScroller

Summary

Nested classes
`class`	`RecyclerView.SmoothScroller.Action` Holds information about a smooth scroll request by a `RecyclerView.SmoothScroller`.

Public constructors
`RecyclerView.SmoothScroller()`

Public methods
`View`	`findViewByPosition(int position)`
`int`	`getChildCount()`
`int`	`getChildPosition(View view)`
`RecyclerView.LayoutManager`	`getLayoutManager()`
`int`	`getTargetPosition()` Returns the adapter position of the target item
`void`	`instantScrollToPosition(int position)` This method is deprecated. Use `jumpTo(int)`.
`boolean`	`isPendingInitialRun()` Returns true if SmoothScroller has been started but has not received the first animation callback yet.
`boolean`	`isRunning()`
`void`	`setTargetPosition(int targetPosition)`

Protected methods
`void`	`normalize(PointF scrollVector)` Normalizes the vector.
`void`	`onChildAttachedToWindow(View child)`
`abstract void`	`onSeekTargetStep(int dx, int dy, RecyclerView.State state, RecyclerView.SmoothScroller.Action action)` RecyclerView will call this method each time it scrolls until it can find the target position in the layout.
`abstract void`	`onStart()` Called when smooth scroll is started.
`abstract void`	`onStop()` Called when smooth scroller is stopped.
`abstract void`	`onTargetFound(View targetView, RecyclerView.State state, RecyclerView.SmoothScroller.Action action)` Called when the target position is laid out.
`final void`	`stop()` Stops running the SmoothScroller in each animation callback.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

RecyclerView.SmoothScroller

RecyclerView.SmoothScroller ()

Public methods

findViewByPosition

View findViewByPosition (int position)

Parameters
`position`	`int`

Returns
`View`

See also:

findViewByPosition(int)

getChildCount

int getChildCount ()

Returns
`int`

See also:

getChildCount()

getChildPosition

int getChildPosition (View view)

Parameters
`view`	`View`

Returns
`int`

See also:

getChildLayoutPosition(android.view.View)

getLayoutManager

RecyclerView.LayoutManager getLayoutManager ()

Returns
`RecyclerView.LayoutManager`	The LayoutManager to which this SmoothScroller is attached. Will return `null` after the SmoothScroller is stopped.

getTargetPosition

int getTargetPosition ()

Returns the adapter position of the target item

Returns
`int`	Adapter position of the target item or `NO_POSITION` if no target view is set.

instantScrollToPosition

void instantScrollToPosition (int position)

This method is deprecated.
Use jumpTo(int).

Parameters
`position`	`int`

See also:

scrollToPosition(int)

isPendingInitialRun

boolean isPendingInitialRun ()

Returns true if SmoothScroller has been started but has not received the first animation callback yet.

Returns
`boolean`	True if this SmoothScroller is waiting to start

isRunning

boolean isRunning ()

Returns
`boolean`	True if SmoothScroller is currently active

setTargetPosition

void setTargetPosition (int targetPosition)

Parameters
`targetPosition`	`int`

Protected methods

normalize

void normalize (PointF scrollVector)

Normalizes the vector.

Parameters
`scrollVector`	`PointF`: The vector that points to the target scroll position

onChildAttachedToWindow

void onChildAttachedToWindow (View child)

Parameters
`child`	`View`

onSeekTargetStep

void onSeekTargetStep (int dx, 
                int dy, 
                RecyclerView.State state, 
                RecyclerView.SmoothScroller.Action action)

RecyclerView will call this method each time it scrolls until it can find the target position in the layout.

SmoothScroller should check dx, dy and if scroll should be changed, update the provided RecyclerView.SmoothScroller.Action to define the next scroll.

Parameters
`dx`	`int`: Last scroll amount horizontally
`dy`	`int`: Last scroll amount verticaully
`state`	`RecyclerView.State`: Transient state of RecyclerView
`action`	`RecyclerView.SmoothScroller.Action`: If you want to trigger a new smooth scroll and cancel the previous one, update this object.

onStart

void onStart ()

Called when smooth scroll is started. This might be a good time to do setup.

onStop

void onStop ()

Called when smooth scroller is stopped. This is a good place to cleanup your state etc.

See also:

stop()

onTargetFound

void onTargetFound (View targetView, 
                RecyclerView.State state, 
                RecyclerView.SmoothScroller.Action action)

Called when the target position is laid out. This is the last callback SmoothScroller will receive and it should update the provided RecyclerView.SmoothScroller.Action to define the scroll details towards the target view.

Parameters
`targetView`	`View`: The view element which render the target position.
`state`	`RecyclerView.State`: Transient state of RecyclerView
`action`	`RecyclerView.SmoothScroller.Action`: Action instance that you should update to define final scroll action towards the targetView

stop

void stop ()

Stops running the SmoothScroller in each animation callback. Note that this does not cancel any existing RecyclerView.SmoothScroller.Action updated by onTargetFound(android.view.View, RecyclerView.State, SmoothScroller.Action) or onSeekTargetStep(int, int, RecyclerView.State, SmoothScroller.Action).

Annotations

Interfaces

Classes

Most visited

Recently visited

Results for

RecyclerView.SmoothScroller

Summary

Nested classes

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

RecyclerView.SmoothScroller

Public methods

findViewByPosition

getChildCount

getChildPosition

getLayoutManager

getTargetPosition

instantScrollToPosition

isPendingInitialRun

isRunning

setTargetPosition

Protected methods

normalize

onChildAttachedToWindow

onSeekTargetStep

onStart

onStop

onTargetFound

stop