public static final long NO_ID = -1

public static final int SCROLL_STATE_DRAGGING = 1

The RecyclerView is currently being dragged by outside input such as user touch input.

public static final int SCROLL_STATE_IDLE = 0

The RecyclerView is not currently scrolling.

public static final int SCROLL_STATE_SETTLING = 2

The RecyclerView is currently animating to a final position while not under outside control.

public static final int TOUCH_SLOP_DEFAULT = 0

Constant for use with setScrollingTouchSlop. Indicates that the RecyclerView should use the standard touch slop for smooth, continuous scrolling.

public static final int TOUCH_SLOP_PAGING = 1

Constant for use with setScrollingTouchSlop. Indicates that the RecyclerView should use the standard touch slop for scrolling widgets that snap to a page or other coarse-grained barrier.

public static final int UNDEFINED_DURATION = -2147483648

Constant that represents that a duration has not been defined.

public static final int VERTICAL = 1

public void addItemDecoration(@NonNull RecyclerView.ItemDecoration decor)

Add an ItemDecoration to this RecyclerView. Item decorations can affect both measurement and drawing of individual item views.

Item decorations are ordered. Decorations placed earlier in the list will be run/queried/drawn first for their effects on item views. Padding added to views will be nested; a padding added by an earlier decoration will mean further item decorations in the list will be asked to draw/pad within the previous decoration's given area.

public void addItemDecoration(@NonNull RecyclerView.ItemDecoration decor, int index)

Add an ItemDecoration to this RecyclerView. Item decorations can affect both measurement and drawing of individual item views.

Item decorations are ordered. Decorations placed earlier in the list will be run/queried/drawn first for their effects on item views. Padding added to views will be nested; a padding added by an earlier decoration will mean further item decorations in the list will be asked to draw/pad within the previous decoration's given area.

public void addOnChildAttachStateChangeListener(
    @NonNull RecyclerView.OnChildAttachStateChangeListener listener
)

Register a listener that will be notified whenever a child view is attached to or detached from RecyclerView.

This listener will be called when a LayoutManager or the RecyclerView decides that a child view is no longer needed. If an application associates expensive or heavyweight data with item views, this may be a good place to release or free those resources.

public void addRecyclerListener(@NonNull RecyclerView.RecyclerListener listener)

Register a listener that will be notified whenever a child view is recycled.

The listeners will be called when a LayoutManager or the RecyclerView decides that a child view is no longer needed. If an application associates data with the item views being recycled, this may be a good place to release or free those resources.

public void clearOnScrollListeners()

Remove all secondary listener that were notified of any changes in scroll state or position.

public int computeHorizontalScrollExtent()

Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range. This value is used to compute the length of the thumb within the scrollbar's track.

The range is expressed in arbitrary units that must be the same as the units used by computeHorizontalScrollRange and computeHorizontalScrollOffset.

Default implementation returns 0.

If you want to support scroll bars, override computeHorizontalScrollExtent in your LayoutManager.

public int computeHorizontalScrollOffset()

Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range. This value is used to compute the position of the thumb within the scrollbar's track.

The range is expressed in arbitrary units that must be the same as the units used by computeHorizontalScrollRange and computeHorizontalScrollExtent.

Default implementation returns 0.

If you want to support scroll bars, override computeHorizontalScrollOffset in your LayoutManager.

public int computeVerticalScrollExtent()

Compute the vertical extent of the vertical scrollbar's thumb within the vertical range. This value is used to compute the length of the thumb within the scrollbar's track.

The range is expressed in arbitrary units that must be the same as the units used by computeVerticalScrollRange and computeVerticalScrollOffset.

Default implementation returns 0.

If you want to support scroll bars, override computeVerticalScrollExtent in your LayoutManager.

public int computeVerticalScrollOffset()

Compute the vertical offset of the vertical scrollbar's thumb within the vertical range. This value is used to compute the position of the thumb within the scrollbar's track.

The range is expressed in arbitrary units that must be the same as the units used by computeVerticalScrollRange and computeVerticalScrollExtent.

Default implementation returns 0.

If you want to support scroll bars, override computeVerticalScrollOffset in your LayoutManager.

public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed)

public boolean dispatchNestedPreScroll(
    int dx,
    int dy,
    int[] consumed,
    int[] offsetInWindow
)

public boolean dispatchNestedPreScroll(
    int dx,
    int dy,
    int[] consumed,
    int[] offsetInWindow,
    int type
)

Dispatch one step of a nested scroll in progress before this view consumes any portion of it.

Nested pre-scroll events are to nested scroll events what touch intercept is to touch. dispatchNestedPreScroll offers an opportunity for the parent view in a nested scrolling operation to consume some or all of the scroll operation before the child view consumes it.

public boolean dispatchNestedScroll(
    int dxConsumed,
    int dyConsumed,
    int dxUnconsumed,
    int dyUnconsumed,
    int[] offsetInWindow
)

public boolean dispatchNestedScroll(
    int dxConsumed,
    int dyConsumed,
    int dxUnconsumed,
    int dyUnconsumed,
    int[] offsetInWindow,
    int type
)

Dispatch one step of a nested scroll in progress.

Implementations of views that support nested scrolling should call this to report info about a scroll in progress to the current nested scrolling parent. If a nested scroll is not currently in progress or nested scrolling is not enabled for this view this method does nothing.

Compatible View implementations should also call dispatchNestedPreScroll before consuming a component of the scroll event themselves.

public final void dispatchNestedScroll(
    int dxConsumed,
    int dyConsumed,
    int dxUnconsumed,
    int dyUnconsumed,
    int[] offsetInWindow,
    int type,
    @NonNull int[] consumed
)

Dispatch one step of a nested scroll in progress.

Implementations of views that support nested scrolling should call this to report info about a scroll in progress to the current nested scrolling parent. If a nested scroll is not currently in progress or nested scrolling is not enabled for this view this method does nothing.

Compatible View implementations should also call dispatchNestedPreScroll before consuming a component of the scroll event themselves.

The original nested scrolling child (where the input events were received to start the scroll) must provide a non-null consumed parameter with values {0, 0}.

public @Nullable View findChildViewUnder(float x, float y)

Find the topmost view under the given point.

public @Nullable View findContainingItemView(@NonNull View view)

Traverses the ancestors of the given view and returns the item view that contains it and also a direct child of the RecyclerView. This returned view can be used to get the ViewHolder by calling getChildViewHolder.

public @Nullable RecyclerView.ViewHolder findViewHolderForAdapterPosition(int position)

Return the ViewHolder for the item in the given position of the data set. Unlike findViewHolderForLayoutPosition this method takes into account any pending adapter changes that may not be reflected to the layout yet. On the other hand, if notifyDataSetChanged has been called but the new layout has not been calculated yet, this method will return null since the new positions of views are unknown until the layout is calculated.

This method checks only the children of RecyclerView. If the item at the given position is not laid out, it will not create a new one.

When the ItemAnimator is running a change animation, there might be 2 ViewHolders representing the same Item. In this case, the updated ViewHolder will be returned.

public RecyclerView.ViewHolder findViewHolderForItemId(long id)

Return the ViewHolder for the item with the given id. The RecyclerView must use an Adapter with stableIds to return a non-null value.

This method checks only the children of RecyclerView. If the item with the given id is not laid out, it will not create a new one. When the ItemAnimator is running a change animation, there might be 2 ViewHolders with the same id. In this case, the updated ViewHolder will be returned.

public @Nullable RecyclerView.ViewHolder findViewHolderForLayoutPosition(int position)

Return the ViewHolder for the item in the given position of the data set as of the latest layout pass.

This method checks only the children of RecyclerView. If the item at the given position is not laid out, it will not create a new one.

Note that when Adapter contents change, ViewHolder positions are not updated until the next layout calculation. If there are pending adapter updates, the return value of this method may not match your adapter contents. You can use #getBindingAdapterPosition to get the current adapter position of a ViewHolder. If the Adapter that is assigned to the RecyclerView is an adapter that combines other adapters (e.g. ConcatAdapter), you can use the getBindingAdapter) to find the position relative to the Adapter that bound the ViewHolder.

When the ItemAnimator is running a change animation, there might be 2 ViewHolders with the same layout position representing the same Item. In this case, the updated ViewHolder will be returned.

public boolean fling(int velocityX, int velocityY)

Begin a standard fling with an initial velocity along each axis in pixels per second. If the velocity given is below the system-defined minimum this method will return false and no fling will occur.

public View focusSearch(View focused, int direction)

Since RecyclerView is a collection ViewGroup that includes virtual children (items that are in the Adapter but not visible in the UI), it employs a more involved focus search strategy that differs from other ViewGroups.

It first does a focus search within the RecyclerView. If this search finds a View that is in the focus direction with respect to the currently focused View, RecyclerView returns that child as the next focus target. When it cannot find such child, it calls onFocusSearchFailed to layout more Views in the focus search direction. If LayoutManager adds a View that matches the focus search criteria, it will be returned as the focus search result. Otherwise, RecyclerView will call parent to handle the focus search like a regular ViewGroup.

When the direction is FOCUS_FORWARD or FOCUS_BACKWARD, a View that is not in the focus direction is still valid focus target which may not be the desired behavior if the Adapter has more children in the focus direction. To handle this case, RecyclerView converts the focus direction to an absolute direction and makes a preliminary focus search in that direction. If there are no Views to gain focus, it will call onFocusSearchFailed before running a focus search with the original (relative) direction. This allows RecyclerView to provide better candidates to the focus search while still allowing the view system to take focus from the RecyclerView and give it to a more suitable child if such child exists.

public int getBaseline()

Return the offset of the RecyclerView's text baseline from the its top boundary. If the LayoutManager of this RecyclerView does not support baseline alignment, this method returns -1.

public int getChildAdapterPosition(@NonNull View child)

Return the adapter position that the given child view corresponds to.

public long getChildItemId(@NonNull View child)

Return the stable item id that the given child view corresponds to.

public int getChildLayoutPosition(@NonNull View child)

Return the adapter position of the given child view as of the latest completed layout pass.

This position may not be equal to Item's adapter position if there are pending changes in the adapter which have not been reflected to the layout yet.

public boolean getClipToPadding()

Returns whether this RecyclerView will clip its children to its padding, and resize (but not clip) any EdgeEffect to the padded region, if padding is present.

By default, children are clipped to the padding of their parent RecyclerView. This clipping behavior is only enabled if padding is non-zero.

name android:clipToPadding

public int getItemDecorationCount()

Returns the number of ItemDecoration currently added to this RecyclerView.

public int getMaxFlingVelocity()

Returns the maximum fling velocity used by this RecyclerView.

public int getMinFlingVelocity()

Returns the minimum velocity to start a fling.

public boolean getPreserveFocusAfterLayout()

Returns true if the RecyclerView should attempt to preserve currently focused Adapter Item's focus even if the View representing the Item is replaced during a layout calculation.

By default, this value is true.

public int getScrollState()

Return the current scrolling state of the RecyclerView.

public boolean hasFixedSize()

public boolean hasNestedScrollingParent(int type)

Returns true if this view has a nested scrolling parent for the given input type.

The presence of a nested scrolling parent indicates that this view has initiated a nested scroll and it was accepted by an ancestor view further up the view hierarchy.

public boolean hasPendingAdapterUpdates()

Returns whether there are pending adapter updates which are not yet applied to the layout.

If this method returns true, it means that what user is currently seeing may not reflect them adapter contents (depending on what has changed). You may use this information to defer or cancel some operations.

This method returns true if RecyclerView has not yet calculated the first layout after it is attached to the Window or the Adapter has been replaced.

public void invalidateItemDecorations()

Invalidates all ItemDecorations. If RecyclerView has item decorations, calling this method will trigger a requestLayout call.

public boolean isAnimating()

Returns true if RecyclerView is currently running some animations.

If you want to be notified when animations are finished, use isRunning.

public boolean isAttachedToWindow()

Returns true if RecyclerView is attached to window.

public boolean isComputingLayout()

Returns whether RecyclerView is currently computing a layout.

If this method returns true, it means that RecyclerView is in a lockdown state and any attempt to update adapter contents will result in an exception because adapter contents cannot be changed while RecyclerView is trying to compute the layout.

It is very unlikely that your code will be running during this state as it is called by the framework when a layout traversal happens or RecyclerView starts to scroll in response to system events (touch, accessibility etc).

This case may happen if you have some custom logic to change adapter contents in response to a View callback (e.g. focus change callback) which might be triggered during a layout calculation. In these cases, you should just postpone the change using a Handler or a similar mechanism.

public boolean isLayoutFrozen()

public final boolean isLayoutSuppressed()

Returns whether layout and scroll calls on this container are currently being suppressed, due to an earlier call to suppressLayout.

public void nestedScrollBy(int x, int y)

Same as scrollBy, but also participates in nested scrolling.

public void offsetChildrenHorizontal(@Px int dx)

Offset the bounds of all child views by dx pixels. Useful for implementing simple scrolling in LayoutManagers.

public void offsetChildrenVertical(@Px int dy)

Offset the bounds of all child views by dy pixels. Useful for implementing simple scrolling in LayoutManagers.

public void onChildAttachedToWindow(@NonNull View child)

Called when an item view is attached to this RecyclerView.

Subclasses of RecyclerView may want to perform extra bookkeeping or modifications of child views as they become attached. This will be called before a LayoutManager measures or lays out the view and is a good time to perform these changes.

public void onChildDetachedFromWindow(@NonNull View child)

Called when an item view is detached from this RecyclerView.

Subclasses of RecyclerView may want to perform extra bookkeeping or modifications of child views as they become detached. This will be called as a LayoutManager fully detaches the child view from the parent and its window.

public void onScrollStateChanged(int state)

Called when the scroll state of this RecyclerView changes. Subclasses should use this method to respond to state changes instead of an explicit listener.

This method will always be invoked before listeners, but after the LayoutManager responds to the scroll state change.

public void onScrolled(@Px int dx, @Px int dy)

Called when the scroll position of this RecyclerView changes. Subclasses should use this method to respond to scrolling within the adapter's data set instead of an explicit listener.

This method will always be invoked before listeners. If a subclass needs to perform any additional upkeep or bookkeeping after scrolling but before listeners run, this is a good place to do so.

This differs from onScrollChanged in that it receives the distance scrolled in either direction within the adapter's data set instead of absolute scroll coordinates. Since RecyclerView cannot compute the absolute scroll position from any arbitrary point in the data set, onScrollChanged will always receive the current getScrollX and getScrollY values which do not correspond to the data set scroll position. However, some subclasses may choose to use these fields as special offsets.

public void removeItemDecorationAt(int index)

Removes the ItemDecoration associated with the supplied index position.

public void scrollBy(int x, int y)

public void scrollTo(int x, int y)

public void scrollToPosition(int position)

Convenience method to scroll to a certain position. RecyclerView does not implement scrolling logic, rather forwards the call to scrollToPosition

public void setAdapter(@Nullable RecyclerView.Adapter adapter)

Set a new adapter to provide child views on demand.

When adapter is changed, all existing views are recycled back to the pool. If the pool has only one adapter, it will be cleared.

public static void setDebugAssertionsEnabled(boolean debugAssertionsEnabled)

Enable internal assertions about RecyclerView's state and throw exceptions if the assertions are violated.

This is primarily intended to diagnose problems with RecyclerView, and should not be enabled in production unless you have a specific reason to do so.

Enabling this may negatively affect performance and/or stability.

public void setHasFixedSize(boolean hasFixedSize)

RecyclerView can perform several optimizations if it can know in advance that RecyclerView's size is not affected by the adapter contents. RecyclerView can still change its size based on other factors (e.g. its parent's size) but this size calculation cannot depend on the size of its children or contents of its adapter (except the number of items in the adapter).

If your use of RecyclerView falls into this category, set this to true. It will allow RecyclerView to avoid invalidating the whole layout when its adapter contents change.

public void setItemViewCacheSize(int size)

Set the number of offscreen views to retain before adding them to the potentially shared recycled view pool.

The offscreen view cache stays aware of changes in the attached adapter, allowing a LayoutManager to reuse those views unmodified without needing to return to the adapter to rebind them.

public void setLayoutFrozen(boolean frozen)

Enable or disable layout and scroll. After setLayoutFrozen(true) is called, Layout requests will be postponed until setLayoutFrozen(false) is called; child views are not updated when RecyclerView is frozen, smoothScrollBy, scrollBy, scrollToPosition and smoothScrollToPosition are dropped; TouchEvents and GenericMotionEvents are dropped; onFocusSearchFailed will not be called.

setLayoutFrozen(true) does not prevent app from directly calling scrollToPosition, smoothScrollToPosition.

setAdapter and swapAdapter will automatically stop frozen.

Note: Running ItemAnimator is not stopped automatically, it's caller's responsibility to call ItemAnimator.end().

public void setPreserveFocusAfterLayout(boolean preserveFocusAfterLayout)

Set whether the RecyclerView should try to keep the same Item focused after a layout calculation or not.

Usually, LayoutManagers keep focused views visible before and after layout but sometimes, views may lose focus during a layout calculation as their state changes or they are replaced with another view due to type change or animation. In these cases, RecyclerView can request focus on the new view automatically.

public void setRecyclerListener(@Nullable RecyclerView.RecyclerListener listener)

Register a listener that will be notified whenever a child view is recycled.

This listener will be called when a LayoutManager or the RecyclerView decides that a child view is no longer needed. If an application associates expensive or heavyweight data with item views, this may be a good place to release or free those resources.

public void setScrollingTouchSlop(int slopConstant)

Configure the scrolling touch slop for a specific use case. Set up the RecyclerView's scrolling motion threshold based on common usages. Valid arguments are TOUCH_SLOP_DEFAULT and TOUCH_SLOP_PAGING.

public static void setVerboseLoggingEnabled(boolean verboseLoggingEnabled)

Enable verbose logging within RecyclerView itself.

Enabling this may negatively affect performance and reduce the utility of logcat due to high-volume logging. This generally should not be enabled in production unless you have a specific reason for doing so.

public void smoothScrollBy(@Px int dx, @Px int dy)

Animate a scroll by the given amount of pixels along either axis.

public void smoothScrollBy(@Px int dx, @Px int dy, @Nullable Interpolator interpolator)

Animate a scroll by the given amount of pixels along either axis.

public void smoothScrollBy(
    @Px int dx,
    @Px int dy,
    @Nullable Interpolator interpolator,
    int duration
)

Smooth scrolls the RecyclerView by a given distance.

public boolean startNestedScroll(int axes, int type)

Begin a nestable scroll operation along the given axes, for the given input type.

A view starting a nested scroll promises to abide by the following contract:

The view will call startNestedScroll upon initiating a scroll operation. In the case of a touch scroll type this corresponds to the initial ACTION_DOWN. In the case of touch scrolling the nested scroll will be terminated automatically in the same manner as requestDisallowInterceptTouchEvent. In the event of programmatic scrolling the caller must explicitly call stopNestedScroll to indicate the end of the nested scroll.

If startNestedScroll returns true, a cooperative parent was found. If it returns false the caller may ignore the rest of this contract until the next scroll. Calling startNestedScroll while a nested scroll is already in progress will return true.

At each incremental step of the scroll the caller should invoke dispatchNestedPreScroll once it has calculated the requested scrolling delta. If it returns true the nested scrolling parent at least partially consumed the scroll and the caller should adjust the amount it scrolls by.

After applying the remainder of the scroll delta the caller should invoke dispatchNestedScroll, passing both the delta consumed and the delta unconsumed. A nested scrolling parent may treat these values differently. See onNestedScroll.

public void stopNestedScroll(int type)

Stop a nested scroll in progress for the given input type.

Calling this method when a nested scroll is not currently in progress is harmless.

public void stopScroll()

Stop any current scroll in progress, such as one started by smoothScrollBy, fling or a touch-initiated fling.

public final void suppressLayout(boolean suppress)

Tells this RecyclerView to suppress all layout and scroll calls until layout suppression is disabled with a later call to suppressLayout(false). When layout suppression is disabled, a requestLayout() call is sent if requestLayout() was attempted while layout was being suppressed.

In addition to the layout suppression smoothScrollBy, scrollBy, scrollToPosition and smoothScrollToPosition are dropped; TouchEvents and GenericMotionEvents are dropped; onFocusSearchFailed will not be called.

suppressLayout(true) does not prevent app from directly calling scrollToPosition, smoothScrollToPosition.

setAdapter and swapAdapter will automatically stop suppressing.

Note: Running ItemAnimator is not stopped automatically, it's caller's responsibility to call ItemAnimator.end().

public void swapAdapter(
    @Nullable RecyclerView.Adapter adapter,
    boolean removeAndRecycleExistingViews
)

Swaps the current adapter with the provided one. It is similar to setAdapter but assumes existing adapter and the new adapter uses the same ViewHolder and does not clear the RecycledViewPool.

Note that it still calls onAdapterChanged callbacks.

protected void onLayout(boolean changed, int l, int t, int r, int b)

protected void onMeasure(int widthSpec, int heightSpec)

protected void onSizeChanged(int w, int h, int oldw, int oldh)