added in version 22.1.0
belongs to Maven artifact com.android.support:recyclerview-v7:28.0.0-alpha1

Summary: Nested Classes | XML Attrs | Inherited XML Attrs | Constants | Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

GridLayoutManager

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class GridLayoutManager
extends LinearLayoutManager

java.lang.Object
↳	android.support.v7.widget.RecyclerView.LayoutManager
	↳	android.support.v7.widget.LinearLayoutManager
		↳	android.support.v7.widget.GridLayoutManager

---

A RecyclerView.LayoutManager implementations that lays out items in a grid.

By default, each item occupies 1 span. You can change it by providing a custom GridLayoutManager.SpanSizeLookup instance via setSpanSizeLookup(SpanSizeLookup).

Summary

Nested classes
class	GridLayoutManager.DefaultSpanSizeLookup Default implementation for GridLayoutManager.SpanSizeLookup.
class	GridLayoutManager.LayoutParams LayoutParams used by GridLayoutManager.
class	GridLayoutManager.SpanSizeLookup A helper class to provide the number of spans each item occupies.

XML attributes
RecyclerView_spanCount

Inherited XML attributes
From class android.support.v7.widget.LinearLayoutManager RecyclerView_android_orientation   RecyclerView_reverseLayout   RecyclerView_stackFromEnd
From class android.support.v7.widget.RecyclerView.LayoutManager RecyclerView_android_orientation   RecyclerView_reverseLayout   RecyclerView_spanCount   RecyclerView_stackFromEnd

Constants
int	DEFAULT_SPAN_COUNT

Inherited constants
From class android.support.v7.widget.LinearLayoutManager int HORIZONTAL int INVALID_OFFSET int VERTICAL

Public constructors
GridLayoutManager(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) Constructor used when layout manager is set in XML by RecyclerView attribute "layoutManager".
GridLayoutManager(Context context, int spanCount) Creates a vertical GridLayoutManager
GridLayoutManager(Context context, int spanCount, int orientation, boolean reverseLayout)

Public methods
boolean	checkLayoutParams(RecyclerView.LayoutParams lp) Determines the validity of the supplied LayoutParams object.
RecyclerView.LayoutParams	generateDefaultLayoutParams() Create a default LayoutParams object for a child of the RecyclerView.
RecyclerView.LayoutParams	generateLayoutParams(Context c, AttributeSet attrs) Create a LayoutParams object suitable for this LayoutManager from an inflated layout resource.
RecyclerView.LayoutParams	generateLayoutParams(ViewGroup.LayoutParams lp) Create a LayoutParams object suitable for this LayoutManager, copying relevant values from the supplied LayoutParams object if possible.
int	getColumnCountForAccessibility(RecyclerView.Recycler recycler, RecyclerView.State state) Returns the number of columns for accessibility.
int	getRowCountForAccessibility(RecyclerView.Recycler recycler, RecyclerView.State state) Returns the number of rows for accessibility.
int	getSpanCount() Returns the number of spans laid out by this grid.
GridLayoutManager.SpanSizeLookup	getSpanSizeLookup() Returns the current GridLayoutManager.SpanSizeLookup used by the GridLayoutManager.
View	onFocusSearchFailed(View focused, int focusDirection, RecyclerView.Recycler recycler, RecyclerView.State state) Called when searching for a focusable view in the given direction has failed for the current content of the RecyclerView.
void	onInitializeAccessibilityNodeInfoForItem(RecyclerView.Recycler recycler, RecyclerView.State state, View host, AccessibilityNodeInfoCompat info) Called by the AccessibilityDelegate when the accessibility information for a specific item should be populated.
void	onItemsAdded(RecyclerView recyclerView, int positionStart, int itemCount) Called when items have been added to the adapter.
void	onItemsChanged(RecyclerView recyclerView) Called in response to a call to notifyDataSetChanged() or swapAdapter(Adapter, boolean) ()} and signals that the the entire data set has changed.
void	onItemsMoved(RecyclerView recyclerView, int from, int to, int itemCount) Called when an item is moved withing the adapter.
void	onItemsRemoved(RecyclerView recyclerView, int positionStart, int itemCount) Called when items have been removed from the adapter.
void	onItemsUpdated(RecyclerView recyclerView, int positionStart, int itemCount, Object payload) Called when items have been changed in the adapter and with optional payload.
void	onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) Lay out all relevant child views from the given adapter.
void	onLayoutCompleted(RecyclerView.State state) Called after a full layout calculation is finished.
int	scrollHorizontallyBy(int dx, RecyclerView.Recycler recycler, RecyclerView.State state) Scroll horizontally by dx pixels in screen coordinates and return the distance traveled.
int	scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) Scroll vertically by dy pixels in screen coordinates and return the distance traveled.
void	setMeasuredDimension(Rect childrenBounds, int wSpec, int hSpec) Sets the measured dimensions from the given bounding box of the children and the measurement specs that were passed into onMeasure(int, int).
void	setSpanCount(int spanCount) Sets the number of spans to be laid out.
void	setSpanSizeLookup(GridLayoutManager.SpanSizeLookup spanSizeLookup) Sets the source to get the number of spans occupied by each item in the adapter.
void	setStackFromEnd(boolean stackFromEnd) stackFromEnd is not supported by GridLayoutManager.
boolean	supportsPredictiveItemAnimations() Returns whether this LayoutManager supports "predictive item animations".

Inherited methods
From class android.support.v7.widget.LinearLayoutManager void assertNotInLayoutOrScroll(String message) Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is. boolean canScrollHorizontally() Query if horizontal scrolling is currently supported. boolean canScrollVertically() Query if vertical scrolling is currently supported. void collectAdjacentPrefetchPositions(int dx, int dy, RecyclerView.State state, RecyclerView.LayoutManager.LayoutPrefetchRegistry layoutPrefetchRegistry) Gather all positions from the LayoutManager to be prefetched, given specified momentum. void collectInitialPrefetchPositions(int adapterItemCount, RecyclerView.LayoutManager.LayoutPrefetchRegistry layoutPrefetchRegistry) Gather all positions from the LayoutManager to be prefetched in preperation for its RecyclerView to come on screen, due to the movement of another, containing RecyclerView. int computeHorizontalScrollExtent(RecyclerView.State state) Override this method if you want to support scroll bars. int computeHorizontalScrollOffset(RecyclerView.State state) Override this method if you want to support scroll bars. int computeHorizontalScrollRange(RecyclerView.State state) Override this method if you want to support scroll bars. PointF computeScrollVectorForPosition(int targetPosition) Should calculate the vector that points to the direction where the target position can be found. int computeVerticalScrollExtent(RecyclerView.State state) Override this method if you want to support scroll bars. int computeVerticalScrollOffset(RecyclerView.State state) Override this method if you want to support scroll bars. int computeVerticalScrollRange(RecyclerView.State state) Override this method if you want to support scroll bars. int findFirstCompletelyVisibleItemPosition() Returns the adapter position of the first fully visible view. int findFirstVisibleItemPosition() Returns the adapter position of the first visible view. int findLastCompletelyVisibleItemPosition() Returns the adapter position of the last fully visible view. int findLastVisibleItemPosition() Returns the adapter position of the last visible view. View findViewByPosition(int position) Finds the view which represents the given adapter position. RecyclerView.LayoutParams generateDefaultLayoutParams() Create a default LayoutParams object for a child of the RecyclerView. int getExtraLayoutSpace(RecyclerView.State state) Returns the amount of extra space that should be laid out by LayoutManager. int getInitialPrefetchItemCount() Gets the number of items to prefetch in collectInitialPrefetchPositions(int, LayoutPrefetchRegistry), which defines how many inner items should be prefetched when this LayoutManager's RecyclerView is nested inside another RecyclerView. int getOrientation() Returns the current orientation of the layout. boolean getRecycleChildrenOnDetach() Returns whether LayoutManager will recycle its children when it is detached from RecyclerView. boolean getReverseLayout() Returns if views are laid out from the opposite direction of the layout. boolean getStackFromEnd() boolean isAutoMeasureEnabled() Returns whether the measuring pass of layout should use the AutoMeasure mechanism of RecyclerView or if it should be done by the LayoutManager's implementation of onMeasure(Recycler, State, int, int). boolean isLayoutRTL() boolean isSmoothScrollbarEnabled() Returns the current state of the smooth scrollbar feature. void onDetachedFromWindow(RecyclerView view, RecyclerView.Recycler recycler) Called when this LayoutManager is detached from its parent RecyclerView or when its parent RecyclerView is detached from its window. View onFocusSearchFailed(View focused, int focusDirection, RecyclerView.Recycler recycler, RecyclerView.State state) Called when searching for a focusable view in the given direction has failed for the current content of the RecyclerView. void onInitializeAccessibilityEvent(AccessibilityEvent event) void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) Lay out all relevant child views from the given adapter. void onLayoutCompleted(RecyclerView.State state) Called after a full layout calculation is finished. void onRestoreInstanceState(Parcelable state) Parcelable onSaveInstanceState() Called when the LayoutManager should save its state. int scrollHorizontallyBy(int dx, RecyclerView.Recycler recycler, RecyclerView.State state) Scroll horizontally by dx pixels in screen coordinates and return the distance traveled. void scrollToPosition(int position) Scroll the RecyclerView to make the position visible. void scrollToPositionWithOffset(int position, int offset) Scroll to the specified adapter position with the given offset from resolved layout start. int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) Scroll vertically by dy pixels in screen coordinates and return the distance traveled. void setInitialPrefetchItemCount(int itemCount) Sets the number of items to prefetch in collectInitialPrefetchPositions(int, LayoutPrefetchRegistry), which defines how many inner items should be prefetched when this LayoutManager's RecyclerView is nested inside another RecyclerView. void setOrientation(int orientation) Sets the orientation of the layout. void setRecycleChildrenOnDetach(boolean recycleChildrenOnDetach) Set whether LayoutManager will recycle its children when it is detached from RecyclerView. void setReverseLayout(boolean reverseLayout) Used to reverse item traversal and layout order. void setSmoothScrollbarEnabled(boolean enabled) When smooth scrollbar is enabled, the position and size of the scrollbar thumb is computed based on the number of visible pixels in the visible items. void setStackFromEnd(boolean stackFromEnd) Compatibility support for setStackFromBottom(boolean) void smoothScrollToPosition(RecyclerView recyclerView, RecyclerView.State state, int position) Smooth scroll to the specified adapter position. boolean supportsPredictiveItemAnimations() Returns whether this LayoutManager supports "predictive item animations".
From class android.support.v7.widget.RecyclerView.LayoutManager void addDisappearingView(View child, int index) To be called only during onLayoutChildren(Recycler, State) to add a view to the layout that is known to be going away, either because it has been removed or because it is actually not in the visible portion of the container but is being laid out in order to inform RecyclerView in how to animate the item out of view. void addDisappearingView(View child) To be called only during onLayoutChildren(Recycler, State) to add a view to the layout that is known to be going away, either because it has been removed or because it is actually not in the visible portion of the container but is being laid out in order to inform RecyclerView in how to animate the item out of view. void addView(View child, int index) Add a view to the currently attached RecyclerView if needed. void addView(View child) Add a view to the currently attached RecyclerView if needed. void assertInLayoutOrScroll(String message) Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is not. void assertNotInLayoutOrScroll(String message) Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is. void attachView(View child) Reattach a previously detached view. void attachView(View child, int index) Reattach a previously detached view. void attachView(View child, int index, RecyclerView.LayoutParams lp) Reattach a previously detached view. void calculateItemDecorationsForChild(View child, Rect outRect) Calculates the item decor insets applied to the given child and updates the provided Rect instance with the inset values. boolean canScrollHorizontally() Query if horizontal scrolling is currently supported. boolean canScrollVertically() Query if vertical scrolling is currently supported. boolean checkLayoutParams(RecyclerView.LayoutParams lp) Determines the validity of the supplied LayoutParams object. static int chooseSize(int spec, int desired, int min) Chooses a size from the given specs and parameters that is closest to the desired size and also complies with the spec. void collectAdjacentPrefetchPositions(int dx, int dy, RecyclerView.State state, RecyclerView.LayoutManager.LayoutPrefetchRegistry layoutPrefetchRegistry) Gather all positions from the LayoutManager to be prefetched, given specified momentum. void collectInitialPrefetchPositions(int adapterItemCount, RecyclerView.LayoutManager.LayoutPrefetchRegistry layoutPrefetchRegistry) Gather all positions from the LayoutManager to be prefetched in preperation for its RecyclerView to come on screen, due to the movement of another, containing RecyclerView. int computeHorizontalScrollExtent(RecyclerView.State state) Override this method if you want to support scroll bars. int computeHorizontalScrollOffset(RecyclerView.State state) Override this method if you want to support scroll bars. int computeHorizontalScrollRange(RecyclerView.State state) Override this method if you want to support scroll bars. int computeVerticalScrollExtent(RecyclerView.State state) Override this method if you want to support scroll bars. int computeVerticalScrollOffset(RecyclerView.State state) Override this method if you want to support scroll bars. int computeVerticalScrollRange(RecyclerView.State state) Override this method if you want to support scroll bars. void detachAndScrapAttachedViews(RecyclerView.Recycler recycler) Temporarily detach and scrap all currently attached child views. void detachAndScrapView(View child, RecyclerView.Recycler recycler) Detach a child view and add it to a Recycler's scrap heap. void detachAndScrapViewAt(int index, RecyclerView.Recycler recycler) Detach a child view and add it to a Recycler's scrap heap. void detachView(View child) Temporarily detach a child view. void detachViewAt(int index) Temporarily detach a child view. void endAnimation(View view) Ends all animations on the view created by the RecyclerView.ItemAnimator. View findContainingItemView(View view) Traverses the ancestors of the given view and returns the item view that contains it and also a direct child of the LayoutManager. View findViewByPosition(int position) Finds the view which represents the given adapter position. abstract RecyclerView.LayoutParams generateDefaultLayoutParams() Create a default LayoutParams object for a child of the RecyclerView. RecyclerView.LayoutParams generateLayoutParams(Context c, AttributeSet attrs) Create a LayoutParams object suitable for this LayoutManager from an inflated layout resource. RecyclerView.LayoutParams generateLayoutParams(ViewGroup.LayoutParams lp) Create a LayoutParams object suitable for this LayoutManager, copying relevant values from the supplied LayoutParams object if possible. int getBaseline() Returns offset of the RecyclerView's text baseline from the its top boundary. int getBottomDecorationHeight(View child) Returns the total height of item decorations applied to child's bottom. View getChildAt(int index) Return the child view at the given index int getChildCount() Return the current number of child views attached to the parent RecyclerView. static int getChildMeasureSpec(int parentSize, int parentMode, int padding, int childDimension, boolean canScroll) Calculate a MeasureSpec value for measuring a child view in one dimension. static int getChildMeasureSpec(int parentSize, int padding, int childDimension, boolean canScroll) This method was deprecated in API level 24.1.0. use getChildMeasureSpec(int, int, int, int, boolean) boolean getClipToPadding() Check if the RecyclerView is configured to clip child views to its padding. int getColumnCountForAccessibility(RecyclerView.Recycler recycler, RecyclerView.State state) Returns the number of columns for accessibility. int getDecoratedBottom(View child) Returns the bottom edge of the given child view within its parent, offset by any applied ItemDecorations. void getDecoratedBoundsWithMargins(View view, Rect outBounds) Returns the bounds of the view including its decoration and margins. int getDecoratedLeft(View child) Returns the left edge of the given child view within its parent, offset by any applied ItemDecorations. int getDecoratedMeasuredHeight(View child) Returns the measured height of the given child, plus the additional size of any insets applied by ItemDecorations. int getDecoratedMeasuredWidth(View child) Returns the measured width of the given child, plus the additional size of any insets applied by ItemDecorations. int getDecoratedRight(View child) Returns the right edge of the given child view within its parent, offset by any applied ItemDecorations. int getDecoratedTop(View child) Returns the top edge of the given child view within its parent, offset by any applied ItemDecorations. View getFocusedChild() Returns the item View which has or contains focus. int getHeight() Returns the height that is currently relevant to the LayoutManager. int getHeightMode() Return the height measurement spec mode that is currently relevant to the LayoutManager. int getItemCount() Returns the number of items in the adapter bound to the parent RecyclerView. int getItemViewType(View view) Returns the View type defined by the adapter. int getLayoutDirection() Returns the resolved layout direction for this RecyclerView. int getLeftDecorationWidth(View child) Returns the total width of item decorations applied to child's left. int getMinimumHeight() int getMinimumWidth() int getPaddingBottom() Return the bottom padding of the parent RecyclerView int getPaddingEnd() Return the end padding of the parent RecyclerView int getPaddingLeft() Return the left padding of the parent RecyclerView int getPaddingRight() Return the right padding of the parent RecyclerView int getPaddingStart() Return the start padding of the parent RecyclerView int getPaddingTop() Return the top padding of the parent RecyclerView int getPosition(View view) Returns the adapter position of the item represented by the given View. static RecyclerView.LayoutManager.Properties getProperties(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) Parse the xml attributes to get the most common properties used by layout managers. int getRightDecorationWidth(View child) Returns the total width of item decorations applied to child's right. int getRowCountForAccessibility(RecyclerView.Recycler recycler, RecyclerView.State state) Returns the number of rows for accessibility. int getSelectionModeForAccessibility(RecyclerView.Recycler recycler, RecyclerView.State state) Returns the selection mode for accessibility. int getTopDecorationHeight(View child) Returns the total height of item decorations applied to child's top. void getTransformedBoundingBox(View child, boolean includeDecorInsets, Rect out) Calculates the bounding box of the View while taking into account its matrix changes (translation, scale etc) with respect to the RecyclerView. int getWidth() Returns the width that is currently relevant to the LayoutManager. int getWidthMode() Return the width measurement spec mode that is currently relevant to the LayoutManager. boolean hasFocus() Returns true if the RecyclerView this LayoutManager is bound to has or contains focus. void ignoreView(View view) Flags a view so that it will not be scrapped or recycled. boolean isAttachedToWindow() Returns whether LayoutManager is currently attached to a RecyclerView which is attached to a window. boolean isAutoMeasureEnabled() Returns whether the measuring pass of layout should use the AutoMeasure mechanism of RecyclerView or if it should be done by the LayoutManager's implementation of onMeasure(Recycler, State, int, int). boolean isFocused() Returns true if the RecyclerView this LayoutManager is bound to has focus. final boolean isItemPrefetchEnabled() Sets whether the LayoutManager should be queried for views outside of its viewport while the UI thread is idle between frames. boolean isLayoutHierarchical(RecyclerView.Recycler recycler, RecyclerView.State state) Returns whether layout is hierarchical or not to be used for accessibility. boolean isMeasurementCacheEnabled() In addition to the View Framework's measurement cache, RecyclerView uses its own additional measurement cache for its children to avoid re-measuring them when not necessary. boolean isSmoothScrolling() boolean isViewPartiallyVisible(View child, boolean completelyVisible, boolean acceptEndPointInclusion) Returns whether the given child view is partially or fully visible within the padded bounded area of RecyclerView, depending on the input parameters. void layoutDecorated(View child, int left, int top, int right, int bottom) Lay out the given child view within the RecyclerView using coordinates that include any current ItemDecorations. void layoutDecoratedWithMargins(View child, int left, int top, int right, int bottom) Lay out the given child view within the RecyclerView using coordinates that include any current ItemDecorations and margins. void measureChild(View child, int widthUsed, int heightUsed) Measure a child view using standard measurement policy, taking the padding of the parent RecyclerView and any added item decorations into account. void measureChildWithMargins(View child, int widthUsed, int heightUsed) Measure a child view using standard measurement policy, taking the padding of the parent RecyclerView, any added item decorations and the child margins into account. void moveView(int fromIndex, int toIndex) Moves a View from one position to another. void offsetChildrenHorizontal(int dx) Offset all child views attached to the parent RecyclerView by dx pixels along the horizontal axis. void offsetChildrenVertical(int dy) Offset all child views attached to the parent RecyclerView by dy pixels along the vertical axis. void onAdapterChanged(Adapter oldAdapter, Adapter newAdapter) Called if the RecyclerView this LayoutManager is bound to has a different adapter set via setAdapter(Adapter) or swapAdapter(Adapter, boolean). boolean onAddFocusables(RecyclerView recyclerView, ArrayList<View> views, int direction, int focusableMode) Called to populate focusable views within the RecyclerView. void onAttachedToWindow(RecyclerView view) Called when this LayoutManager is both attached to a RecyclerView and that RecyclerView is attached to a window. void onDetachedFromWindow(RecyclerView view, RecyclerView.Recycler recycler) Called when this LayoutManager is detached from its parent RecyclerView or when its parent RecyclerView is detached from its window. void onDetachedFromWindow(RecyclerView view) This method was deprecated in API level 22.1.0. override onDetachedFromWindow(RecyclerView, Recycler) View onFocusSearchFailed(View focused, int direction, RecyclerView.Recycler recycler, RecyclerView.State state) Called when searching for a focusable view in the given direction has failed for the current content of the RecyclerView. void onInitializeAccessibilityEvent(AccessibilityEvent event) void onInitializeAccessibilityEvent(RecyclerView.Recycler recycler, RecyclerView.State state, AccessibilityEvent event) Called by the accessibility delegate to initialize an accessibility event. void onInitializeAccessibilityNodeInfo(RecyclerView.Recycler recycler, RecyclerView.State state, AccessibilityNodeInfoCompat info) Called by the AccessibilityDelegate when the information about the current layout should be populated. void onInitializeAccessibilityNodeInfoForItem(RecyclerView.Recycler recycler, RecyclerView.State state, View host, AccessibilityNodeInfoCompat info) Called by the AccessibilityDelegate when the accessibility information for a specific item should be populated. View onInterceptFocusSearch(View focused, int direction) This method gives a LayoutManager an opportunity to intercept the initial focus search before the default behavior of FocusFinder is used. void onItemsAdded(RecyclerView recyclerView, int positionStart, int itemCount) Called when items have been added to the adapter. void onItemsChanged(RecyclerView recyclerView) Called in response to a call to notifyDataSetChanged() or swapAdapter(Adapter, boolean) ()} and signals that the the entire data set has changed. void onItemsMoved(RecyclerView recyclerView, int from, int to, int itemCount) Called when an item is moved withing the adapter. void onItemsRemoved(RecyclerView recyclerView, int positionStart, int itemCount) Called when items have been removed from the adapter. void onItemsUpdated(RecyclerView recyclerView, int positionStart, int itemCount) Called when items have been changed in the adapter. void onItemsUpdated(RecyclerView recyclerView, int positionStart, int itemCount, Object payload) Called when items have been changed in the adapter and with optional payload. void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) Lay out all relevant child views from the given adapter. void onLayoutCompleted(RecyclerView.State state) Called after a full layout calculation is finished. void onMeasure(RecyclerView.Recycler recycler, RecyclerView.State state, int widthSpec, int heightSpec) Measure the attached RecyclerView. boolean onRequestChildFocus(RecyclerView parent, View child, View focused) This method was deprecated in API level 22.1.0. Use onRequestChildFocus(RecyclerView, State, View, View) boolean onRequestChildFocus(RecyclerView parent, RecyclerView.State state, View child, View focused) Called when a descendant view of the RecyclerView requests focus. void onRestoreInstanceState(Parcelable state) Parcelable onSaveInstanceState() Called when the LayoutManager should save its state. void onScrollStateChanged(int state) RecyclerView calls this method to notify LayoutManager that scroll state has changed. boolean performAccessibilityAction(RecyclerView.Recycler recycler, RecyclerView.State state, int action, Bundle args) Called by AccessibilityDelegate when an action is requested from the RecyclerView. boolean performAccessibilityActionForItem(RecyclerView.Recycler recycler, RecyclerView.State state, View view, int action, Bundle args) Called by AccessibilityDelegate when an accessibility action is requested on one of the children of LayoutManager. void postOnAnimation(Runnable action) Causes the Runnable to execute on the next animation time step. void removeAllViews() Remove all views from the currently attached RecyclerView. void removeAndRecycleAllViews(RecyclerView.Recycler recycler) Removes all views and recycles them using the given recycler. void removeAndRecycleView(View child, RecyclerView.Recycler recycler) Remove a child view and recycle it using the given Recycler. void removeAndRecycleViewAt(int index, RecyclerView.Recycler recycler) Remove a child view and recycle it using the given Recycler. boolean removeCallbacks(Runnable action) Removes the specified Runnable from the message queue. void removeDetachedView(View child) Finish removing a view that was previously temporarily detached. void removeView(View child) Remove a view from the currently attached RecyclerView if needed. void removeViewAt(int index) Remove a view from the currently attached RecyclerView if needed. boolean requestChildRectangleOnScreen(RecyclerView parent, View child, Rect rect, boolean immediate, boolean focusedChildVisible) Requests that the given child of the RecyclerView be positioned onto the screen. boolean requestChildRectangleOnScreen(RecyclerView parent, View child, Rect rect, boolean immediate) Called when a child of the RecyclerView wants a particular rectangle to be positioned onto the screen. void requestLayout() Calls RecyclerView#requestLayout on the underlying RecyclerView void requestSimpleAnimationsInNextLayout() A LayoutManager can call this method to force RecyclerView to run simple animations in the next layout pass, even if there is not any trigger to do so. int scrollHorizontallyBy(int dx, RecyclerView.Recycler recycler, RecyclerView.State state) Scroll horizontally by dx pixels in screen coordinates and return the distance traveled. void scrollToPosition(int position) Scroll to the specified adapter position. int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) Scroll vertically by dy pixels in screen coordinates and return the distance traveled. void setAutoMeasureEnabled(boolean enabled) This method was deprecated in API level 27.1.0. Implementors of LayoutManager should define whether or not it uses AutoMeasure by overriding isAutoMeasureEnabled(). final void setItemPrefetchEnabled(boolean enabled) Sets whether the LayoutManager should be queried for views outside of its viewport while the UI thread is idle between frames. void setMeasuredDimension(int widthSize, int heightSize) Set the measured dimensions of the host RecyclerView. void setMeasuredDimension(Rect childrenBounds, int wSpec, int hSpec) Sets the measured dimensions from the given bounding box of the children and the measurement specs that were passed into onMeasure(int, int). void setMeasurementCacheEnabled(boolean measurementCacheEnabled) Sets whether RecyclerView should use its own measurement cache for the children. void smoothScrollToPosition(RecyclerView recyclerView, RecyclerView.State state, int position) Smooth scroll to the specified adapter position. void startSmoothScroll(RecyclerView.SmoothScroller smoothScroller) Starts a smooth scroll using the provided SmoothScroller. void stopIgnoringView(View view) View can be scrapped and recycled again. boolean supportsPredictiveItemAnimations() Returns whether this LayoutManager supports "predictive item animations".
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.support.v7.widget.helper.ItemTouchHelper.ViewDropHandler abstract void prepareForDrop(View view, View target, int x, int y) Called by the ItemTouchHelper after a View is dropped over another View.
From interface android.support.v7.widget.RecyclerView.SmoothScroller.ScrollVectorProvider abstract PointF computeScrollVectorForPosition(int targetPosition) Should calculate the vector that points to the direction where the target position can be found.

XML attributes

RecyclerView_spanCount

Related methods:

• GridLayoutManager(Context,AttributeSet,int,int)

Constants

DEFAULT_SPAN_COUNT

added in version 22.1.0

int DEFAULT_SPAN_COUNT

Constant Value: -1 (0xffffffff)

Public constructors

GridLayoutManager

added in version 24.1.0

GridLayoutManager (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Constructor used when layout manager is set in XML by RecyclerView attribute "layoutManager". If spanCount is not specified in the XML, it defaults to a single column.

Related XML Attributes:

• RecyclerView_spanCount

Parameters
context	Context
attrs	AttributeSet
defStyleAttr	int
defStyleRes	int

GridLayoutManager

added in version 22.1.0

GridLayoutManager (Context context, 
                int spanCount)

Creates a vertical GridLayoutManager

Parameters
context	Context: Current context, will be used to access resources.
spanCount	int: The number of columns in the grid

GridLayoutManager

added in version 22.1.0

GridLayoutManager (Context context, 
                int spanCount, 
                int orientation, 
                boolean reverseLayout)

Parameters
context	Context: Current context, will be used to access resources.
spanCount	int: The number of columns or rows in the grid
orientation	int: Layout orientation. Should be HORIZONTAL or VERTICAL.
reverseLayout	boolean: When set to true, layouts from end to start.

Public methods

checkLayoutParams

added in version 22.1.0

boolean checkLayoutParams (RecyclerView.LayoutParams lp)

Determines the validity of the supplied LayoutParams object.

This should check to make sure that the object is of the correct type and all values are within acceptable ranges. The default implementation returns true for non-null params.

Parameters
lp	RecyclerView.LayoutParams: LayoutParams object to check

Returns
boolean	true if this LayoutParams object is valid, false otherwise

generateDefaultLayoutParams

added in version 22.1.0

RecyclerView.LayoutParams generateDefaultLayoutParams ()

Create a default LayoutParams object for a child of the RecyclerView.

LayoutManagers will often want to use a custom LayoutParams type to store extra information specific to the layout. Client code should subclass RecyclerView.LayoutParams for this purpose.

Important: if you use your own custom LayoutParams type you must also override checkLayoutParams(LayoutParams), generateLayoutParams(android.view.ViewGroup.LayoutParams) and generateLayoutParams(android.content.Context, android.util.AttributeSet).

Returns
RecyclerView.LayoutParams	A new LayoutParams for a child view

generateLayoutParams

added in version 22.1.0

RecyclerView.LayoutParams generateLayoutParams (Context c, 
                AttributeSet attrs)

Create a LayoutParams object suitable for this LayoutManager from an inflated layout resource.

Important: if you use your own custom LayoutParams type you must also override checkLayoutParams(LayoutParams), generateLayoutParams(android.view.ViewGroup.LayoutParams) and generateLayoutParams(android.content.Context, android.util.AttributeSet).

Parameters
c	Context: Context for obtaining styled attributes
attrs	AttributeSet: AttributeSet describing the supplied arguments

Returns
RecyclerView.LayoutParams	a new LayoutParams object

generateLayoutParams

added in version 22.1.0

RecyclerView.LayoutParams generateLayoutParams (ViewGroup.LayoutParams lp)

Create a LayoutParams object suitable for this LayoutManager, copying relevant values from the supplied LayoutParams object if possible.

Important: if you use your own custom LayoutParams type you must also override checkLayoutParams(LayoutParams), generateLayoutParams(android.view.ViewGroup.LayoutParams) and generateLayoutParams(android.content.Context, android.util.AttributeSet).

Parameters
lp	ViewGroup.LayoutParams: Source LayoutParams object to copy values from

Returns
RecyclerView.LayoutParams	a new LayoutParams object

getColumnCountForAccessibility

added in version 22.1.0

int getColumnCountForAccessibility (RecyclerView.Recycler recycler, 
                RecyclerView.State state)

Returns the number of columns for accessibility.

Default implementation returns the number of items in the adapter if LayoutManager supports horizontal scrolling or 1 if LayoutManager does not support horizontal scrolling.

Parameters
recycler	RecyclerView.Recycler: The Recycler that can be used to convert view positions into adapter positions
state	RecyclerView.State: The current state of RecyclerView

Returns
int	The number of rows in LayoutManager for accessibility.

getRowCountForAccessibility

added in version 22.1.0

int getRowCountForAccessibility (RecyclerView.Recycler recycler, 
                RecyclerView.State state)

Returns the number of rows for accessibility.

Default implementation returns the number of items in the adapter if LayoutManager supports vertical scrolling or 1 if LayoutManager does not support vertical scrolling.

Parameters
recycler	RecyclerView.Recycler: The Recycler that can be used to convert view positions into adapter positions
state	RecyclerView.State: The current state of RecyclerView

Returns
int	The number of rows in LayoutManager for accessibility.

getSpanCount

added in version 22.1.0

int getSpanCount ()

Returns the number of spans laid out by this grid.

Returns
int	The number of spans

See also:

• setSpanCount(int)

getSpanSizeLookup

added in version 22.1.0

GridLayoutManager.SpanSizeLookup getSpanSizeLookup ()

Returns the current GridLayoutManager.SpanSizeLookup used by the GridLayoutManager.

Returns
GridLayoutManager.SpanSizeLookup	The current GridLayoutManager.SpanSizeLookup used by the GridLayoutManager.

onFocusSearchFailed

added in version 22.1.0

View onFocusSearchFailed (View focused, 
                int focusDirection, 
                RecyclerView.Recycler recycler, 
                RecyclerView.State state)

Called when searching for a focusable view in the given direction has failed for the current content of the RecyclerView.

This is the LayoutManager's opportunity to populate views in the given direction to fulfill the request if it can. The LayoutManager should attach and return the view to be focused, if a focusable view in the given direction is found. Otherwise, if all the existing (or the newly populated views) are unfocusable, it returns the next unfocusable view to become visible on the screen. This unfocusable view is typically the first view that's either partially or fully out of RV's padded bounded area in the given direction. The default implementation returns null.

Parameters
focused	View: The currently focused view
focusDirection	int: One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_BACKWARD, FOCUS_FORWARD or 0 for not applicable
recycler	RecyclerView.Recycler: The recycler to use for obtaining views for currently offscreen items
state	RecyclerView.State: Transient state of RecyclerView

Returns
View	The chosen view to be focused if a focusable view is found, otherwise an unfocusable view to become visible onto the screen, else null.

onInitializeAccessibilityNodeInfoForItem

added in version 22.1.0

void onInitializeAccessibilityNodeInfoForItem (RecyclerView.Recycler recycler, 
                RecyclerView.State state, 
                View host, 
                AccessibilityNodeInfoCompat info)

Called by the AccessibilityDelegate when the accessibility information for a specific item should be populated.

Default implementation adds basic positioning information about the item.

Parameters
recycler	RecyclerView.Recycler: The Recycler that can be used to convert view positions into adapter positions
state	RecyclerView.State: The current state of RecyclerView
host	View: The child for which accessibility node info should be populated
info	AccessibilityNodeInfoCompat: The info to fill out about the item

onItemsAdded

added in version 22.1.0

void onItemsAdded (RecyclerView recyclerView, 
                int positionStart, 
                int itemCount)

Called when items have been added to the adapter. The LayoutManager may choose to requestLayout if the inserted items would require refreshing the currently visible set of child views. (e.g. currently empty space would be filled by appended items, etc.)

onItemsChanged

added in version 22.1.0

void onItemsChanged (RecyclerView recyclerView)

Called in response to a call to notifyDataSetChanged() or swapAdapter(Adapter, boolean) ()} and signals that the the entire data set has changed.

onItemsMoved

added in version 22.1.0

void onItemsMoved (RecyclerView recyclerView, 
                int from, 
                int to, 
                int itemCount)

Called when an item is moved withing the adapter.

Note that, an item may also change position in response to another ADD/REMOVE/MOVE operation. This callback is only called if and only if notifyItemMoved(int, int) is called.

onItemsRemoved

added in version 22.1.0

void onItemsRemoved (RecyclerView recyclerView, 
                int positionStart, 
                int itemCount)

Called when items have been removed from the adapter.

onItemsUpdated

added in version 24.1.0

void onItemsUpdated (RecyclerView recyclerView, 
                int positionStart, 
                int itemCount, 
                Object payload)

Called when items have been changed in the adapter and with optional payload. Default implementation calls onItemsUpdated(RecyclerView, int, int).

onLayoutChildren

added in version 22.1.0

void onLayoutChildren (RecyclerView.Recycler recycler, 
                RecyclerView.State state)

Lay out all relevant child views from the given adapter. The LayoutManager is in charge of the behavior of item animations. By default, RecyclerView has a non-null ItemAnimator, and simple item animations are enabled. This means that add/remove operations on the adapter will result in animations to add new or appearing items, removed or disappearing items, and moved items. If a LayoutManager returns false from supportsPredictiveItemAnimations(), which is the default, and runs a normal layout operation during onLayoutChildren(Recycler, State), the RecyclerView will have enough information to run those animations in a simple way. For example, the default ItemAnimator, DefaultItemAnimator, will simply fade views in and out, whether they are actually added/removed or whether they are moved on or off the screen due to other add/remove operations.

A LayoutManager wanting a better item animation experience, where items can be animated onto and off of the screen according to where the items exist when they are not on screen, then the LayoutManager should return true from supportsPredictiveItemAnimations() and add additional logic to onLayoutChildren(Recycler, State). Supporting predictive animations means that onLayoutChildren(Recycler, State) will be called twice; once as a "pre" layout step to determine where items would have been prior to a real layout, and again to do the "real" layout. In the pre-layout phase, items will remember their pre-layout positions to allow them to be laid out appropriately. Also, removed items will be returned from the scrap to help determine correct placement of other items. These removed items should not be added to the child list, but should be used to help calculate correct positioning of other views, including views that were not previously onscreen (referred to as APPEARING views), but whose pre-layout offscreen position can be determined given the extra information about the pre-layout removed views.

The second layout pass is the real layout in which only non-removed views will be used. The only additional requirement during this pass is, if supportsPredictiveItemAnimations() returns true, to note which views exist in the child list prior to layout and which are not there after layout (referred to as DISAPPEARING views), and to position/layout those views appropriately, without regard to the actual bounds of the RecyclerView. This allows the animation system to know the location to which to animate these disappearing views.

The default LayoutManager implementations for RecyclerView handle all of these requirements for animations already. Clients of RecyclerView can either use one of these layout managers directly or look at their implementations of onLayoutChildren() to see how they account for the APPEARING and DISAPPEARING views.

Parameters
recycler	RecyclerView.Recycler: Recycler to use for fetching potentially cached views for a position
state	RecyclerView.State: Transient state of RecyclerView

onLayoutCompleted

added in version 24.1.0

void onLayoutCompleted (RecyclerView.State state)

Called after a full layout calculation is finished. The layout calculation may include multiple onLayoutChildren(Recycler, State) calls due to animations or layout measurement but it will include only one onLayoutCompleted(State) call. This method will be called at the end of layout(int, int, int, int) call.

This is a good place for the LayoutManager to do some cleanup like pending scroll position, saved state etc.

Parameters
state	RecyclerView.State: Transient state of RecyclerView

scrollHorizontallyBy

added in version 22.1.0

int scrollHorizontallyBy (int dx, 
                RecyclerView.Recycler recycler, 
                RecyclerView.State state)

Scroll horizontally by dx pixels in screen coordinates and return the distance traveled. The default implementation does nothing and returns 0.

Parameters
dx	int: distance to scroll by in pixels. X increases as scroll position approaches the right.
recycler	RecyclerView.Recycler: Recycler to use for fetching potentially cached views for a position
state	RecyclerView.State: Transient state of RecyclerView

Returns
int	The actual distance scrolled. The return value will be negative if dx was negative and scrolling proceeeded in that direction. Math.abs(result) may be less than dx if a boundary was reached.

scrollVerticallyBy

added in version 22.1.0

int scrollVerticallyBy (int dy, 
                RecyclerView.Recycler recycler, 
                RecyclerView.State state)

Scroll vertically by dy pixels in screen coordinates and return the distance traveled. The default implementation does nothing and returns 0.

Parameters
dy	int: distance to scroll in pixels. Y increases as scroll position approaches the bottom.
recycler	RecyclerView.Recycler: Recycler to use for fetching potentially cached views for a position
state	RecyclerView.State: Transient state of RecyclerView

Returns
int	The actual distance scrolled. The return value will be negative if dy was negative and scrolling proceeeded in that direction. Math.abs(result) may be less than dy if a boundary was reached.

setMeasuredDimension

added in version 24.1.0

void setMeasuredDimension (Rect childrenBounds, 
                int wSpec, 
                int hSpec)

Sets the measured dimensions from the given bounding box of the children and the measurement specs that were passed into onMeasure(int, int). It is only called if a LayoutManager returns true from isAutoMeasureEnabled() and it is called after the RecyclerView calls onLayoutChildren(Recycler, State) in the execution of onMeasure(int, int).

This method must call setMeasuredDimension(int, int).

The default implementation adds the RecyclerView's padding to the given bounding box then caps the value to be within the given measurement specs.

Parameters
childrenBounds	Rect: The bounding box of all children
wSpec	int: The widthMeasureSpec that was passed into the RecyclerView.
hSpec	int: The heightMeasureSpec that was passed into the RecyclerView.

setSpanCount

added in version 22.1.0

void setSpanCount (int spanCount)

Sets the number of spans to be laid out.

If getOrientation() is VERTICAL, this is the number of columns. If getOrientation() is HORIZONTAL, this is the number of rows.

Parameters
spanCount	int: The total number of spans in the grid

See also:

• getSpanCount()

setSpanSizeLookup

added in version 22.1.0

void setSpanSizeLookup (GridLayoutManager.SpanSizeLookup spanSizeLookup)

Sets the source to get the number of spans occupied by each item in the adapter.

Parameters
spanSizeLookup	GridLayoutManager.SpanSizeLookup: GridLayoutManager.SpanSizeLookup instance to be used to query number of spans occupied by each item

setStackFromEnd

added in version 22.1.0

void setStackFromEnd (boolean stackFromEnd)

stackFromEnd is not supported by GridLayoutManager. Consider using setReverseLayout(boolean).

Parameters
stackFromEnd	boolean

supportsPredictiveItemAnimations

added in version 22.1.0

boolean supportsPredictiveItemAnimations ()

Returns whether this LayoutManager supports "predictive item animations".

"Predictive item animations" are automatically created animations that show where items came from, and where they are going to, as items are added, removed, or moved within a layout.

A LayoutManager wishing to support predictive item animations must override this method to return true (the default implementation returns false) and must obey certain behavioral contracts outlined in onLayoutChildren(Recycler, State).

Whether item animations actually occur in a RecyclerView is actually determined by both the return value from this method and the ItemAnimator set on the RecyclerView itself. If the RecyclerView has a non-null ItemAnimator but this method returns false, then only "simple item animations" will be enabled in the RecyclerView, in which views whose position are changing are simply faded in/out. If the RecyclerView has a non-null ItemAnimator and this method returns true, then predictive item animations will be enabled in the RecyclerView.

Returns
boolean	true if this LayoutManager supports predictive item animations, false otherwise.

• Annotations

  • RecyclerView.EdgeEffectFactory.EdgeDirection
  • RecyclerView.ItemAnimator.AdapterChanges

• Interfaces

  • ActionMenuView.OnMenuItemClickListener
  • PopupMenu.OnDismissListener
  • PopupMenu.OnMenuItemClickListener
  • RecyclerView.ChildDrawingOrderCallback
  • RecyclerView.ItemAnimator.ItemAnimatorFinishedListener
  • RecyclerView.LayoutManager.LayoutPrefetchRegistry
  • RecyclerView.OnChildAttachStateChangeListener
  • RecyclerView.OnItemTouchListener
  • RecyclerView.RecyclerListener
  • RecyclerView.SmoothScroller.ScrollVectorProvider
  • SearchView.OnCloseListener
  • SearchView.OnQueryTextListener
  • SearchView.OnSuggestionListener
  • ShareActionProvider.OnShareTargetSelectedListener
  • ThemedSpinnerAdapter
  • Toolbar.OnMenuItemClickListener

• Classes

  • ActionMenuView
  • ActionMenuView.LayoutParams
  • AppCompatAutoCompleteTextView
  • AppCompatButton
  • AppCompatCheckBox
  • AppCompatCheckedTextView
  • AppCompatEditText
  • AppCompatImageButton
  • AppCompatImageView
  • AppCompatMultiAutoCompleteTextView
  • AppCompatRadioButton
  • AppCompatRatingBar
  • AppCompatSeekBar
  • AppCompatSpinner
  • AppCompatTextView
  • CardView
  • DefaultItemAnimator
  • DividerItemDecoration
  • GridLayout
  • GridLayout.Alignment
  • GridLayout.LayoutParams
  • GridLayout.Spec
  • GridLayoutManager
  • GridLayoutManager.DefaultSpanSizeLookup
  • GridLayoutManager.LayoutParams
  • GridLayoutManager.SpanSizeLookup
  • LinearLayoutCompat
  • LinearLayoutCompat.LayoutParams
  • LinearLayoutManager
  • LinearLayoutManager.LayoutChunkResult
  • LinearSmoothScroller
  • LinearSnapHelper
  • ListPopupWindow
  • OrientationHelper
  • PagerSnapHelper
  • PopupMenu
  • RecyclerView
  • RecyclerView.Adapter
  • RecyclerView.AdapterDataObserver
  • RecyclerView.EdgeEffectFactory
  • RecyclerView.ItemAnimator
  • RecyclerView.ItemAnimator.ItemHolderInfo
  • RecyclerView.ItemDecoration
  • RecyclerView.LayoutManager
  • RecyclerView.LayoutManager.Properties
  • RecyclerView.LayoutParams
  • RecyclerView.OnFlingListener
  • RecyclerView.OnScrollListener
  • RecyclerView.RecycledViewPool
  • RecyclerView.Recycler
  • RecyclerView.SimpleOnItemTouchListener
  • RecyclerView.SmoothScroller
  • RecyclerView.SmoothScroller.Action
  • RecyclerView.State
  • RecyclerView.ViewCacheExtension
  • RecyclerView.ViewHolder
  • RecyclerViewAccessibilityDelegate
  • RecyclerViewAccessibilityDelegate.ItemDelegate
  • SearchView
  • ShareActionProvider
  • SimpleItemAnimator
  • SnapHelper
  • StaggeredGridLayoutManager
  • StaggeredGridLayoutManager.LayoutParams
  • SwitchCompat
  • ThemedSpinnerAdapter.Helper
  • Toolbar
  • Toolbar.LayoutParams
  • Toolbar.SavedState
  • TooltipCompat