GridLayoutManager

Artifact: androidx.recyclerview:recyclerview

Added in 1.0.0

Kotlin |Java

public class GridLayoutManager extends LinearLayoutManager

java.lang.Object
↳	androidx.recyclerview.widget.RecyclerView.LayoutManager
	↳	androidx.recyclerview.widget.LinearLayoutManager
		↳	androidx.recyclerview.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 SpanSizeLookup instance via setSpanSizeLookup.

Summary

Nested types
`public final class GridLayoutManager.DefaultSpanSizeLookup extends GridLayoutManager.SpanSizeLookup` Default implementation for `SpanSizeLookup`.
`public class GridLayoutManager.LayoutParams extends RecyclerView.LayoutParams` LayoutParams used by GridLayoutManager.
`public abstract class GridLayoutManager.SpanSizeLookup` A helper class to provide the number of spans each item occupies.

Constants
`static final int`	`DEFAULT_SPAN_COUNT = -1`

Public constructors
`GridLayoutManager(Context context, int spanCount)` Creates a vertical GridLayoutManager
`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, int orientation, boolean reverseLayout )`

Public methods
`boolean`	`checkLayoutParams(RecyclerView.LayoutParams lp)` Determines the validity of the supplied LayoutParams object.
`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`	`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.
`RecyclerView.LayoutParams`	`generateDefaultLayoutParams()` Create a default `LayoutParams` object for a child of the RecyclerView.
`RecyclerView.LayoutParams`	`generateLayoutParams(ViewGroup.LayoutParams lp)` Create a LayoutParams object suitable for this LayoutManager, copying relevant values from the supplied LayoutParams object if possible.
`RecyclerView.LayoutParams`	`generateLayoutParams(Context c, AttributeSet attrs)` Create a LayoutParams object suitable for this LayoutManager from an inflated layout resource.
`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 `SpanSizeLookup` used by the GridLayoutManager.
`boolean`	`isUsingSpansToEstimateScrollbarDimensions()` Returns true if the scroll offset and scroll range calculations take account of span information.
`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`	`onInitializeAccessibilityNodeInfo( @NonNull RecyclerView.Recycler recycler, @NonNull RecyclerView.State state, @NonNull 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.
`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` ()} 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`.
`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.
`void`	`setUsingSpansToEstimateScrollbarDimensions( boolean useSpansToEstimateScrollBarDimensions )` When this flag is set, the scroll offset and scroll range calculations will take account of span information.
`boolean`	`supportsPredictiveItemAnimations()` Returns whether this LayoutManager supports "predictive item animations".

Inherited Constants

From androidx.recyclerview.widget.LinearLayoutManager

`static final int`	`HORIZONTAL = 0`
`static final int`	`INVALID_OFFSET = -2147483648`
`static final int`	`VERTICAL = 1`

Inherited methods

From androidx.recyclerview.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.
`void`	`calculateExtraLayoutSpace( @NonNull RecyclerView.State state, @NonNull int[] extraLayoutSpace )` Calculates the amount of extra space (in pixels) that should be laid out by and stores the result in `extraLayoutSpace`.
`boolean`	`canScrollHorizontally()`
`boolean`	`canScrollVertically()`
`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.
`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`	`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.
`int`	`getExtraLayoutSpace(RecyclerView.State state)` This method is deprecated. Use `calculateExtraLayoutSpace` instead.
`int`	`getInitialPrefetchItemCount()` Gets the number of items to prefetch in `collectInitialPrefetchPositions`, 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`.
`boolean`	`isLayoutRTL()`
`boolean`	`isLayoutReversed()` Query if the layout is in reverse order.
`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.
`void`	`onInitializeAccessibilityEvent(AccessibilityEvent event)`
`void`	`onRestoreInstanceState(Parcelable state)` Called when the RecyclerView is ready to restore the state based on a previous RecyclerView.
`Parcelable`	`onSaveInstanceState()` Called when the LayoutManager should save its state.
`void`	`prepareForDrop(@NonNull View view, @NonNull View target, int x, int y)` Called by the after a View is dropped over another View.
`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.
`void`	`setInitialPrefetchItemCount(int itemCount)` Sets the number of items to prefetch in `collectInitialPrefetchPositions`, 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`	`smoothScrollToPosition( RecyclerView recyclerView, RecyclerView.State state, int position )` Smooth scroll to the specified adapter position.

From androidx.recyclerview.widget.RecyclerView.LayoutManager

`void`	`addDisappearingView(View child)` To be called only during `onLayoutChildren` 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, int index)` To be called only during `onLayoutChildren` 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)` Add a view to the currently attached RecyclerView if needed.
`void`	`addView(View child, int index)` 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`	`attachView(@NonNull View child)` Reattach a previously `detached` view.
`void`	`attachView(@NonNull View child, int index)` Reattach a previously `detached` view.
`void`	`attachView(@NonNull View child, int index, RecyclerView.LayoutParams lp)` Reattach a previously `detached` view.
`void`	`calculateItemDecorationsForChild( @NonNull View child, @NonNull Rect outRect )` Calculates the item decor insets applied to the given child and updates the provided Rect instance with the inset values.
`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(@NonNull RecyclerView.State state)` Override this method if you want to support scroll bars.
`int`	`computeHorizontalScrollOffset(@NonNull RecyclerView.State state)` Override this method if you want to support scroll bars.
`int`	`computeHorizontalScrollRange(@NonNull RecyclerView.State state)` Override this method if you want to support scroll bars.
`int`	`computeVerticalScrollExtent(@NonNull RecyclerView.State state)` Override this method if you want to support scroll bars.
`int`	`computeVerticalScrollOffset(@NonNull`

GridLayoutManager

Summary

Nested types

Constants

Public constructors

Public methods

Inherited Constants

Inherited methods