StaggeredGridLayoutManager

class StaggeredGridLayoutManager : RecyclerView.LayoutManager, RecyclerView.SmoothScroller.ScrollVectorProvider


A LayoutManager that lays out children in a staggered grid formation. It supports horizontal &vertical layout as well as an ability to layout children in reverse.

Staggered grids are likely to have gaps at the edges of the layout. To avoid these gaps, StaggeredGridLayoutManager can offset spans independently or move items between spans. You can control this behavior via setGapStrategy.

Summary

Nested types

LayoutParams used by StaggeredGridLayoutManager.

Constants

const Int

This property is deprecated.

No longer supported.

const Int

When scroll state is changed to SCROLL_STATE_IDLE, StaggeredGrid will check if there are gaps in the because of full span items.

const Int

Does not do anything to hide gaps.

const Int
const Int

Public constructors

StaggeredGridLayoutManager(spanCount: Int, orientation: Int)

Creates a StaggeredGridLayoutManager with given parameters.

StaggeredGridLayoutManager(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int,
    defStyleRes: Int
)

Constructor used when layout manager is set in XML by RecyclerView attribute "layoutManager".

Public functions

Unit

Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is.

Boolean

Query if horizontal scrolling is currently supported.

Boolean

Query if vertical scrolling is currently supported.

Boolean

Determines the validity of the supplied LayoutParams object.

Int

Override this method if you want to support scroll bars.

Int

Override this method if you want to support scroll bars.

Int

Override this method if you want to support scroll bars.

PointF!

Should calculate the vector that points to the direction where the target position can be found.

Int

Override this method if you want to support scroll bars.

Int

Override this method if you want to support scroll bars.

Int

Override this method if you want to support scroll bars.

IntArray<Int>!

Returns the adapter position of the first completely visible view for each span.

IntArray<Int>!

Returns the adapter position of the first visible view for each span.

IntArray<Int>!

Returns the adapter position of the last completely visible view for each span.

IntArray<Int>!

Returns the adapter position of the last visible view for each span.

RecyclerView.LayoutParams!

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

RecyclerView.LayoutParams!

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

RecyclerView.LayoutParams!

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

Int

Returns the number of columns for accessibility.

Int

Returns the current gap handling strategy for StaggeredGridLayoutManager.

Int
Boolean

Returns whether views are laid out in reverse order or not.

Int

Returns the number of rows for accessibility.

Int

Returns the number of spans laid out by StaggeredGridLayoutManager.

Unit

For consistency, StaggeredGridLayoutManager keeps a mapping between spans and items.

Boolean

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

Query if the layout is in reverse order.

Unit

Offset all child views attached to the parent RecyclerView by dx pixels along the horizontal axis.

Unit

Offset all child views attached to the parent RecyclerView by dy pixels along the vertical axis.

Unit
onAdapterChanged(
    oldAdapter: RecyclerView.Adapter?,
    newAdapter: RecyclerView.Adapter?
)

Called if the RecyclerView this LayoutManager is bound to has a different adapter set via setAdapter or swapAdapter.

Unit

Called when this LayoutManager is detached from its parent RecyclerView or when its parent RecyclerView is detached from its window.

View?
onFocusSearchFailed(
    focused: View!,
    direction: Int,
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
)

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

Unit
Unit

Called by the AccessibilityDelegate when the information about the current layout should be populated.

Unit

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

Unit
onItemsAdded(
    recyclerView: RecyclerView!,
    positionStart: Int,
    itemCount: Int
)

Called when items have been added to the adapter.

Unit
onItemsChanged(recyclerView: RecyclerView!)

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

Unit
onItemsMoved(recyclerView: RecyclerView!, from: Int, to: Int, itemCount: Int)

Called when an item is moved withing the adapter.

Unit
onItemsRemoved(
    recyclerView: RecyclerView!,
    positionStart: Int,
    itemCount: Int
)

Called when items have been removed from the adapter.

Unit
onItemsUpdated(
    recyclerView: RecyclerView!,
    positionStart: Int,
    itemCount: Int,
    payload: Any!
)

Called when items have been changed in the adapter and with optional payload.

Unit
onLayoutChildren(
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
)

Lay out all relevant child views from the given adapter.

Unit

Called after a full layout calculation is finished.

Unit

Called when the RecyclerView is ready to restore the state based on a previous RecyclerView.

Parcelable!

Called when the LayoutManager should save its state.

Unit

RecyclerView calls this method to notify LayoutManager that scroll state has changed.

Int
scrollHorizontallyBy(
    dx: Int,
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
)

Scroll horizontally by dx pixels in screen coordinates and return the distance traveled.

Unit
scrollToPosition(position: Int)

Scroll to the specified adapter position.

Unit
scrollToPositionWithOffset(position: Int, offset: Int)

Scroll to the specified adapter position with the given offset from layout start.

Int
scrollVerticallyBy(
    dy: Int,
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
)

Scroll vertically by dy pixels in screen coordinates and return the distance traveled.

Unit
setGapStrategy(gapStrategy: Int)

Sets the gap handling strategy for StaggeredGridLayoutManager.

Unit
setMeasuredDimension(childrenBounds: Rect!, wSpec: Int, hSpec: Int)

Sets the measured dimensions from the given bounding box of the children and the measurement specs that were passed into onMeasure.

Unit
setOrientation(orientation: Int)

Sets the orientation of the layout.

Unit
setReverseLayout(reverseLayout: Boolean)

Sets whether LayoutManager should start laying out items from the end of the UI.

Unit
setSpanCount(spanCount: Int)

Sets the number of spans for the layout.

Unit
smoothScrollToPosition(
    recyclerView: RecyclerView!,
    state: RecyclerView.State!,
    position: Int
)

Smooth scroll to the specified adapter position.

Boolean

Returns whether this LayoutManager supports "predictive item animations".

Inherited functions

From androidx.recyclerview.widget.RecyclerView.LayoutManager
Unit

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.

Unit
addDisappearingView(child: View!, index: Int)

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.

Unit
addView(child: View!)

Add a view to the currently attached RecyclerView if needed.

Unit
addView(child: View!, index: Int)

Add a view to the currently attached RecyclerView if needed.

Unit

Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is not.

Unit
attachView(child: View)

Reattach a previously detached view.

Unit
attachView(child: View, index: Int)

Reattach a previously detached view.

Unit
attachView(child: View, index: Int, lp: RecyclerView.LayoutParams!)

Reattach a previously detached view.

Unit

Calculates the item decor insets applied to the given child and updates the provided Rect instance with the inset values.

java-static Int
chooseSize(spec: Int, desired: Int, min: Int)

Chooses a size from the given specs and parameters that is closest to the desired size and also complies with the spec.

Unit
collectInitialPrefetchPositions(
    adapterItemCount: Int,
    layoutPrefetchRegistry: RecyclerView.LayoutManager.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.

Unit

Temporarily detach and scrap all currently attached child views.

Unit

Detach a child view and add it to a Recycler's scrap heap.

Unit

Detach a child view and add it to a Recycler's scrap heap.

Unit
detachView(child: View)

Temporarily detach a child view.

Unit
detachViewAt(index: Int)

Temporarily detach a child view.

Unit

Ends all animations on the view created by the ItemAnimator.

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?

Finds the view which represents the given adapter position.

Int

Returns offset of the RecyclerView's text baseline from the its top boundary.

Int

Returns the total height of item decorations applied to child's bottom.

View?
getChildAt(index: Int)

Return the child view at the given index

Int

Return the current number of child views attached to the parent RecyclerView.

java-static Int
getChildMeasureSpec(
    parentSize: Int,
    padding: Int,
    childDimension: Int,
    canScroll: Boolean
)

This function is deprecated.

use getChildMeasureSpec

java-static Int
getChildMeasureSpec(
    parentSize: Int,
    parentMode: Int,
    padding: Int,
    childDimension: Int,
    canScroll: Boolean
)

Calculate a MeasureSpec value for measuring a child view in one dimension.

Boolean

Check if the RecyclerView is configured to clip child views to its padding.

Int

Returns the bottom edge of the given child view within its parent, offset by any applied ItemDecorations.

Unit

Returns the bounds of the view including its decoration and margins.

Int

Returns the left edge of the given child view within its parent, offset by any applied ItemDecorations.

Int

Returns the measured height of the given child, plus the additional size of any insets applied by ItemDecorations.

Int

Returns the measured width of the given child, plus the additional size of any insets applied by ItemDecorations.

Int

Returns the right edge of the given child view within its parent, offset by any applied ItemDecorations.

Int

Returns the top edge of the given child view within its parent, offset by any applied ItemDecorations.

View?

Returns the item View which has or contains focus.

@Px Int

Returns the height that is currently relevant to the LayoutManager.

Int

Return the height measurement spec mode that is currently relevant to the LayoutManager.

Int

Returns the number of items in the adapter bound to the parent RecyclerView.

Int

Returns the View type defined by the adapter.

Int

Returns the resolved layout direction for this RecyclerView.

Int

Returns the total width of item decorations applied to child's left.

@Px Int
@Px Int
@Px Int

Return the bottom padding of the parent RecyclerView

@Px Int

Return the end padding of the parent RecyclerView

@Px Int

Return the left padding of the parent RecyclerView

@Px Int

Return the right padding of the parent RecyclerView

@Px Int

Return the start padding of the parent RecyclerView

@Px Int

Return the top padding of the parent RecyclerView

Int

Returns the adapter position of the item represented by the given View.

java-static RecyclerView.LayoutManager.Properties!
getProperties(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int
)

Parse the xml attributes to get the most common properties used by layout managers.

Int

Returns the total width of item decorations applied to child's right.

Int

Returns the selection mode for accessibility.

Int

Returns the total height of item decorations applied to child's top.

Unit
getTransformedBoundingBox(
    child: View,
    includeDecorInsets: Boolean,
    out: Rect
)

Calculates the bounding box of the View while taking into account its matrix changes (translation, scale etc) with respect to the RecyclerView.

@Px Int

Returns the width that is currently relevant to the LayoutManager.

Int

Return the width measurement spec mode that is currently relevant to the LayoutManager.

Boolean

Returns true if the RecyclerView this LayoutManager is bound to has or contains focus.

Unit

Flags a view so that it will not be scrapped or recycled.

Boolean

Returns whether LayoutManager is currently attached to a RecyclerView which is attached to a window.

Boolean

Returns true if the RecyclerView this LayoutManager is bound to has focus.

Boolean

Sets whether the LayoutManager should be queried for views outside of its viewport while the UI thread is idle between frames.

Boolean

Returns whether layout is hierarchical or not to be used for accessibility.

Boolean

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
Boolean
isViewPartiallyVisible(
    child: View,
    completelyVisible: Boolean,
    acceptEndPointInclusion: Boolean
)

Returns whether the given child view is partially or fully visible within the padded bounded area of RecyclerView, depending on the input parameters.

Unit
layoutDecorated(child: View, left: Int, top: Int, right: Int, bottom: Int)

Lay out the given child view within the RecyclerView using coordinates that include any current ItemDecorations.

Unit
layoutDecoratedWithMargins(
    child: View,
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
)

Lay out the given child view within the RecyclerView using coordinates that include any current ItemDecorations and margins.

Unit
measureChild(child: View, widthUsed: Int, heightUsed: Int)

Measure a child view using standard measurement policy, taking the padding of the parent RecyclerView and any added item decorations into account.

Unit
measureChildWithMargins(child: View, widthUsed: Int, heightUsed: Int)

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.

Unit
moveView(fromIndex: Int, toIndex: Int)

Moves a View from one position to another.

Boolean
onAddFocusables(
    recyclerView: RecyclerView,
    views: ArrayList<View!>,
    direction: Int,
    focusableMode: Int
)

Called to populate focusable views within the RecyclerView.

Unit

Called when this LayoutManager is both attached to a RecyclerView and that RecyclerView is attached to a window.

Unit

This function is deprecated.

override onDetachedFromWindow

Unit

Called by the accessibility delegate to initialize an accessibility event.

View?
onInterceptFocusSearch(focused: View, direction: Int)

This method gives a LayoutManager an opportunity to intercept the initial focus search before the default behavior of FocusFinder is used.

Unit
onItemsUpdated(
    recyclerView: RecyclerView,
    positionStart: Int,
    itemCount: Int
)

Called when items have been changed in the adapter.

Unit
onMeasure(
    recycler: RecyclerView.Recycler,
    state: RecyclerView.State,
    widthSpec: Int,
    heightSpec: Int
)

Measure the attached RecyclerView.

Boolean
onRequestChildFocus(parent: RecyclerView, child: View, focused: View?)

This function is deprecated.

Use onRequestChildFocus

Boolean
onRequestChildFocus(
    parent: RecyclerView,
    state: RecyclerView.State,
    child: View,
    focused: View?
)

Called when a descendant view of the RecyclerView requests focus.

Boolean
performAccessibilityAction(
    recycler: RecyclerView.Recycler,
    state: RecyclerView.State,
    action: Int,
    args: Bundle?
)

Called by AccessibilityDelegate when an action is requested from the RecyclerView.

Boolean
performAccessibilityActionForItem(
    recycler: RecyclerView.Recycler,
    state: RecyclerView.State,
    view: View,
    action: Int,
    args: Bundle?
)

Called by AccessibilityDelegate when an accessibility action is requested on one of the children of LayoutManager.

Unit

Causes the Runnable to execute on the next animation time step.

Unit

Remove all views from the currently attached RecyclerView.

Unit

Removes all views and recycles them using the given recycler.

Unit

Remove a child view and recycle it using the given Recycler.

Unit

Remove a child view and recycle it using the given Recycler.

Boolean

Removes the specified Runnable from the message queue.

Unit

Finish removing a view that was previously temporarily detached.

Unit
removeView(child: View!)

Remove a view from the currently attached RecyclerView if needed.

Unit
removeViewAt(index: Int)

Remove a view from the currently attached RecyclerView if needed.

Boolean
requestChildRectangleOnScreen(
    parent: RecyclerView,
    child: View,
    rect: Rect,
    immediate: Boolean
)

Called when a child of the RecyclerView wants a particular rectangle to be positioned onto the screen.

Boolean
requestChildRectangleOnScreen(
    parent: RecyclerView,
    child: View,
    rect: Rect,
    immediate: Boolean,
    focusedChildVisible: Boolean
)

Requests that the given child of the RecyclerView be positioned onto the screen.

Unit

Calls RecyclerView#requestLayout on the underlying RecyclerView

Unit

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.

Unit

This function is deprecated.

Implementors of LayoutManager should define whether or not it uses AutoMeasure by overriding isAutoMeasureEnabled.

Unit

Sets whether the LayoutManager should be queried for views outside of its viewport while the UI thread is idle between frames.

Unit
setMeasuredDimension(widthSize: Int, heightSize: Int)

Set the measured dimensions of the host RecyclerView.

Unit
setMeasurementCacheEnabled(measurementCacheEnabled: Boolean)

Sets whether RecyclerView should use its own measurement cache for the children.

Unit

Starts a smooth scroll using the provided SmoothScroller.

Unit

View can be scrapped and recycled again.

Constants

GAP_HANDLING_LAZY

Added in 1.0.0
Deprecated in 1.0.0
const val GAP_HANDLING_LAZY = 1: Int

GAP_HANDLING_MOVE_ITEMS_BETWEEN_SPANS

Added in 1.0.0
const val GAP_HANDLING_MOVE_ITEMS_BETWEEN_SPANS = 2: Int

When scroll state is changed to SCROLL_STATE_IDLE, StaggeredGrid will check if there are gaps in the because of full span items. If it finds, it will re-layout and move items to correct positions with animations.

For example, if LayoutManager ends up with the following layout due to adapter changes:

AAA
_BC
DDD

It will animate to the following state:

AAA
BC_
DDD

GAP_HANDLING_NONE

Added in 1.0.0
const val GAP_HANDLING_NONE = 0: Int

Does not do anything to hide gaps.

HORIZONTAL

Added in 1.0.0
const val HORIZONTAL = 0: Int

VERTICAL

Added in 1.0.0
const val VERTICAL = 1: Int

Public constructors

StaggeredGridLayoutManager

Added in 1.0.0
StaggeredGridLayoutManager(spanCount: Int, orientation: Int)

Creates a StaggeredGridLayoutManager with given parameters.

Parameters
spanCount: Int

If orientation is vertical, spanCount is number of columns. If orientation is horizontal, spanCount is number of rows.

orientation: Int

VERTICAL or HORIZONTAL

StaggeredGridLayoutManager

Added in 1.0.0
StaggeredGridLayoutManager(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int,
    defStyleRes: Int
)

Constructor used when layout manager is set in XML by RecyclerView attribute "layoutManager". Defaults to single column and vertical.

Public functions

assertNotInLayoutOrScroll

fun assertNotInLayoutOrScroll(message: String!): Unit

Checks if RecyclerView is in the middle of a layout or scroll and throws an IllegalStateException if it is.

Parameters
message: String!

The message for the exception. Can be null.

canScrollHorizontally

fun canScrollHorizontally(): Boolean

Query if horizontal scrolling is currently supported. The default implementation returns false.

Returns
Boolean

True if this LayoutManager can scroll the current contents horizontally

canScrollVertically

fun canScrollVertically(): Boolean

Query if vertical scrolling is currently supported. The default implementation returns false.

Returns
Boolean

True if this LayoutManager can scroll the current contents vertically

checkLayoutParams

fun checkLayoutParams(lp: RecyclerView.LayoutParams!): Boolean

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

computeHorizontalScrollExtent

fun computeHorizontalScrollExtent(state: RecyclerView.State!): Int

Override this method if you want to support scroll bars.

Read computeHorizontalScrollExtent for details.

Default implementation returns 0.

Parameters
state: RecyclerView.State!

Current state of RecyclerView

Returns
Int

The horizontal extent of the scrollbar's thumb

computeHorizontalScrollOffset

fun computeHorizontalScrollOffset(state: RecyclerView.State!): Int

Override this method if you want to support scroll bars.

Read computeHorizontalScrollOffset for details.

Default implementation returns 0.

Parameters
state: RecyclerView.State!

Current State of RecyclerView where you can find total item count

Returns
Int

The horizontal offset of the scrollbar's thumb

computeHorizontalScrollRange

fun computeHorizontalScrollRange(state: RecyclerView.State!): Int

Override this method if you want to support scroll bars.

Read computeHorizontalScrollRange for details.

Default implementation returns 0.

Parameters
state: RecyclerView.State!

Current State of RecyclerView where you can find total item count

Returns
Int

The total horizontal range represented by the horizontal scrollbar

computeScrollVectorForPosition

Added in 1.4.0-alpha01
fun computeScrollVectorForPosition(targetPosition: Int): PointF!

Should calculate the vector that points to the direction where the target position can be found.

This method is used by the LinearSmoothScroller to initiate a scroll towards the target position.

The magnitude of the vector is not important. It is always normalized before being used by the LinearSmoothScroller.

LayoutManager should not check whether the position exists in the adapter or not.

Parameters
targetPosition: Int

the target position to which the returned vector should point

Returns
PointF!

the scroll vector for a given position.

computeVerticalScrollExtent

fun computeVerticalScrollExtent(state: RecyclerView.State!): Int

Override this method if you want to support scroll bars.

Read computeVerticalScrollExtent for details.

Default implementation returns 0.

Parameters
state: RecyclerView.State!

Current state of RecyclerView

Returns
Int

The vertical extent of the scrollbar's thumb

computeVerticalScrollOffset

fun computeVerticalScrollOffset(state: RecyclerView.State!): Int

Override this method if you want to support scroll bars.

Read computeVerticalScrollOffset for details.

Default implementation returns 0.

Parameters
state: RecyclerView.State!

Current State of RecyclerView where you can find total item count

Returns
Int

The vertical offset of the scrollbar's thumb

computeVerticalScrollRange

fun computeVerticalScrollRange(state: RecyclerView.State!): Int

Override this method if you want to support scroll bars.

Read computeVerticalScrollRange for details.

Default implementation returns 0.

Parameters
state: RecyclerView.State!

Current State of RecyclerView where you can find total item count

Returns
Int

The total vertical range represented by the vertical scrollbar

findFirstCompletelyVisibleItemPositions

Added in 1.0.0
fun findFirstCompletelyVisibleItemPositions(into: IntArray!): IntArray<Int>!

Returns the adapter position of the first completely visible view for each span.

Note that, this value is not affected by layout orientation or item order traversal. (setReverseLayout). Views are sorted by their positions in the adapter, not in the layout.

If RecyclerView has item decorators, they will be considered in calculations as well.

StaggeredGridLayoutManager may pre-cache some views that are not necessarily visible. Those views are ignored in this method.

Parameters
into: IntArray!

An array to put the results into. If you don't provide any, LayoutManager will create a new one.

Returns
IntArray<Int>!

The adapter position of the first fully visible item in each span. If a span does not have any items, NO_POSITION is returned for that span.

findFirstVisibleItemPositions

Added in 1.0.0
fun findFirstVisibleItemPositions(into: IntArray!): IntArray<Int>!

Returns the adapter position of the first visible view for each span.

Note that, this value is not affected by layout orientation or item order traversal. (setReverseLayout). Views are sorted by their positions in the adapter, not in the layout.

If RecyclerView has item decorators, they will be considered in calculations as well.

StaggeredGridLayoutManager may pre-cache some views that are not necessarily visible. Those views are ignored in this method.

Parameters
into: IntArray!

An array to put the results into. If you don't provide any, LayoutManager will create a new one.

Returns
IntArray<Int>!

The adapter position of the first visible item in each span. If a span does not have any items, NO_POSITION is returned for that span.

findLastCompletelyVisibleItemPositions

Added in 1.0.0
fun findLastCompletelyVisibleItemPositions(into: IntArray!): IntArray<Int>!

Returns the adapter position of the last completely visible view for each span.

Note that, this value is not affected by layout orientation or item order traversal. (setReverseLayout). Views are sorted by their positions in the adapter, not in the layout.

If RecyclerView has item decorators, they will be considered in calculations as well.

StaggeredGridLayoutManager may pre-cache some views that are not necessarily visible. Those views are ignored in this method.

Parameters
into: IntArray!

An array to put the results into. If you don't provide any, LayoutManager will create a new one.

Returns
IntArray<Int>!

The adapter position of the last fully visible item in each span. If a span does not have any items, NO_POSITION is returned for that span.

findLastVisibleItemPositions

Added in 1.0.0
fun findLastVisibleItemPositions(into: IntArray!): IntArray<Int>!

Returns the adapter position of the last visible view for each span.

Note that, this value is not affected by layout orientation or item order traversal. (setReverseLayout). Views are sorted by their positions in the adapter, not in the layout.

If RecyclerView has item decorators, they will be considered in calculations as well.

StaggeredGridLayoutManager may pre-cache some views that are not necessarily visible. Those views are ignored in this method.

Parameters
into: IntArray!

An array to put the results into. If you don't provide any, LayoutManager will create a new one.

Returns
IntArray<Int>!

The adapter position of the last visible item in each span. If a span does not have any items, NO_POSITION is returned for that span.

generateDefaultLayoutParams

Added in 1.4.0-alpha01
fun generateDefaultLayoutParams(): RecyclerView.LayoutParams!

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, generateLayoutParams and generateLayoutParams.

Returns
RecyclerView.LayoutParams!

A new LayoutParams for a child view

generateLayoutParams

fun generateLayoutParams(lp: ViewGroup.LayoutParams!): RecyclerView.LayoutParams!

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, generateLayoutParams and generateLayoutParams.

Parameters
lp: ViewGroup.LayoutParams!

Source LayoutParams object to copy values from

Returns
RecyclerView.LayoutParams!

a new LayoutParams object

generateLayoutParams

fun generateLayoutParams(c: Context!, attrs: AttributeSet!): RecyclerView.LayoutParams!

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, generateLayoutParams and generateLayoutParams.

Parameters
c: Context!

Context for obtaining styled attributes

attrs: AttributeSet!

AttributeSet describing the supplied arguments

Returns
RecyclerView.LayoutParams!

a new LayoutParams object

getColumnCountForAccessibility

fun getColumnCountForAccessibility(
    recycler: RecyclerView.Recycler,
    state: RecyclerView.State
): Int

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.

getGapStrategy

Added in 1.0.0
fun getGapStrategy(): Int

Returns the current gap handling strategy for StaggeredGridLayoutManager.

Staggered grid may have gaps in the layout due to changes in the adapter. To avoid gaps, StaggeredGridLayoutManager provides 2 options. Check GAP_HANDLING_NONE and GAP_HANDLING_MOVE_ITEMS_BETWEEN_SPANS for details.

By default, StaggeredGridLayoutManager uses GAP_HANDLING_MOVE_ITEMS_BETWEEN_SPANS.

Returns
Int

Current gap handling strategy.

getOrientation

Added in 1.0.0
fun getOrientation(): Int

getReverseLayout

Added in 1.0.0
fun getReverseLayout(): Boolean

Returns whether views are laid out in reverse order or not.

Not that this value is not affected by RecyclerView's layout direction.

Returns
Boolean

True if layout is reversed, false otherwise

See also
setReverseLayout

getRowCountForAccessibility

fun getRowCountForAccessibility(
    recycler: RecyclerView.Recycler,
    state: RecyclerView.State
): Int

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 1.0.0
fun getSpanCount(): Int

Returns the number of spans laid out by StaggeredGridLayoutManager.

Returns
Int

Number of spans in the layout

invalidateSpanAssignments

Added in 1.0.0
fun invalidateSpanAssignments(): Unit

For consistency, StaggeredGridLayoutManager keeps a mapping between spans and items.

If you need to cancel current assignments, you can call this method which will clear all assignments and request a new layout.

isAutoMeasureEnabled

fun isAutoMeasureEnabled(): Boolean

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.

This method returns false by default (it actually returns the value passed to the deprecated setAutoMeasureEnabled) and should be overridden to return true if a LayoutManager wants to be auto measured by the RecyclerView.

If this method is overridden to return true, onMeasure should not be overridden.

AutoMeasure is a RecyclerView mechanism that handles the measuring pass of layout in a simple and contract satisfying way, including the wrapping of children laid out by LayoutManager. Simply put, it handles wrapping children by calling onLayoutChildren during a call to onMeasure, and then calculating desired dimensions based on children's dimensions and positions. It does this while supporting all existing animation capabilities of the RecyclerView.

More specifically:

  1. When onMeasure is called, if the provided measure specs both have a mode of EXACTLY, RecyclerView will set its measured dimensions accordingly and return, allowing layout to continue as normal (Actually, RecyclerView will call onMeasure for backwards compatibility reasons but it should not be overridden if AutoMeasure is being used).
  2. If one of the layout specs is not EXACT, the RecyclerView will start the layout process. It will first process all pending Adapter updates and then decide whether to run a predictive layout. If it decides to do so, it will first call onLayoutChildren with isPreLayout set to true. At this stage, getWidth and getHeight will still return the width and height of the RecyclerView as of the last layout calculation.

    After handling the predictive case, RecyclerView will call onLayoutChildren with isMeasuring set to true and isPreLayout set to false. The LayoutManager can access the measurement specs via getHeight, getHeightMode, getWidth and getWidthMode.

  3. After the layout calculation, RecyclerView sets the measured width &height by calculating the bounding box for the children (+ RecyclerView's padding). The LayoutManagers can override setMeasuredDimension to choose different values. For instance, GridLayoutManager overrides this value to handle the case where if it is vertical and has 3 columns but only 2 items, it should still measure its width to fit 3 items, not 2.
  4. Any following calls to onMeasure will run onLayoutChildren with isMeasuring set to true and isPreLayout set to false. RecyclerView will take care of which views are actually added / removed / moved / changed for animations so that the LayoutManager should not worry about them and handle each onLayoutChildren call as if it is the last one.
  5. When measure is complete and RecyclerView's onLayout method is called, RecyclerView checks whether it already did layout calculations during the measure pass and if so, it re-uses that information. It may still decide to call onLayoutChildren if the last measure spec was different from the final dimensions or adapter contents have changed between the measure call and the layout call.
  6. Finally, animations are calculated and run as usual.
Returns
Boolean

True if the measuring pass of layout should use the AutoMeasure mechanism of RecyclerView or False if it should be done by the LayoutManager's implementation of onMeasure.

isLayoutReversed

fun isLayoutReversed(): Boolean

Query if the layout is in reverse order. This will affect, for example, keyboard navigation via page up/page down. The default implementation returns false.

Returns
Boolean

true if this LayoutManager is currently in reverse order.

offsetChildrenHorizontal

fun offsetChildrenHorizontal(dx: Int): Unit

Offset all child views attached to the parent RecyclerView by dx pixels along the horizontal axis.

Parameters
dx: Int

Pixels to offset by

offsetChildrenVertical

fun offsetChildrenVertical(dy: Int): Unit

Offset all child views attached to the parent RecyclerView by dy pixels along the vertical axis.

Parameters
dy: Int

Pixels to offset by

onAdapterChanged

fun onAdapterChanged(
    oldAdapter: RecyclerView.Adapter?,
    newAdapter: RecyclerView.Adapter?
): Unit

Called if the RecyclerView this LayoutManager is bound to has a different adapter set via setAdapter or swapAdapter. The LayoutManager may use this opportunity to clear caches and configure state such that it can relayout appropriately with the new data and potentially new view types.

The default implementation removes all currently attached views.

Parameters
oldAdapter: RecyclerView.Adapter?

The previous adapter instance. Will be null if there was previously no adapter.

newAdapter: RecyclerView.Adapter?

The new adapter instance. Might be null if setAdapter is called with null.

onDetachedFromWindow

fun onDetachedFromWindow(view: RecyclerView!, recycler: RecyclerView.Recycler!): Unit

Called when this LayoutManager is detached from its parent RecyclerView or when its parent RecyclerView is detached from its window.

LayoutManager should clear all of its View references as another LayoutManager might be assigned to the RecyclerView.

If the RecyclerView is re-attached with the same LayoutManager and Adapter, it may not call onLayoutChildren if nothing has changed and a layout was not requested on the RecyclerView while it was detached.

If your LayoutManager has View references that it cleans in on-detach, it should also call requestLayout to ensure that it is re-laid out when RecyclerView is re-attached.

Subclass implementations should always call through to the superclass implementation.

Parameters
view: RecyclerView!

The RecyclerView this LayoutManager is bound to

recycler: RecyclerView.Recycler!

The recycler to use if you prefer to recycle your children instead of keeping them around.

onFocusSearchFailed

fun onFocusSearchFailed(
    focused: View!,
    direction: Int,
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
): View?

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

direction: 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.

onInitializeAccessibilityEvent

fun onInitializeAccessibilityEvent(event: AccessibilityEvent!): Unit

onInitializeAccessibilityNodeInfo

fun onInitializeAccessibilityNodeInfo(
    recycler: RecyclerView.Recycler,
    state: RecyclerView.State,
    info: AccessibilityNodeInfoCompat
): Unit

Called by the AccessibilityDelegate when the information about the current layout should be populated.

Default implementation adds a .

You should override getRowCountForAccessibility, getColumnCountForAccessibility, isLayoutHierarchical and getSelectionModeForAccessibility for more accurate accessibility information.

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

info: AccessibilityNodeInfoCompat

The info that should be filled by the LayoutManager

onInitializeAccessibilityNodeInfoForItem

fun onInitializeAccessibilityNodeInfoForItem(
    recycler: RecyclerView.Recycler,
    state: RecyclerView.State,
    host: View,
    info: AccessibilityNodeInfoCompat
): Unit

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

fun onItemsAdded(
    recyclerView: RecyclerView!,
    positionStart: Int,
    itemCount: Int
): Unit

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

fun onItemsChanged(recyclerView: RecyclerView!): Unit

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

onItemsMoved

fun onItemsMoved(recyclerView: RecyclerView!, from: Int, to: Int, itemCount: Int): Unit

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 is called.

onItemsRemoved

fun onItemsRemoved(
    recyclerView: RecyclerView!,
    positionStart: Int,
    itemCount: Int
): Unit

Called when items have been removed from the adapter.

onItemsUpdated

fun onItemsUpdated(
    recyclerView: RecyclerView!,
    positionStart: Int,
    itemCount: Int,
    payload: Any!
): Unit

Called when items have been changed in the adapter and with optional payload. Default implementation calls onItemsUpdated.

onLayoutChildren

fun onLayoutChildren(
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
): Unit

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, 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. Supporting predictive animations means that onLayoutChildren 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

fun onLayoutCompleted(state: RecyclerView.State!): Unit

Called after a full layout calculation is finished. The layout calculation may include multiple onLayoutChildren calls due to animations or layout measurement but it will include only one onLayoutCompleted call. This method will be called at the end of layout 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

onRestoreInstanceState

fun onRestoreInstanceState(state: Parcelable!): Unit

Called when the RecyclerView is ready to restore the state based on a previous RecyclerView. Notice that this might happen after an actual layout, based on how Adapter prefers to restore State. See getStateRestorationPolicy for more information.

Parameters
state: Parcelable!

The parcelable that was returned by the previous LayoutManager's onSaveInstanceState method.

onSaveInstanceState

fun onSaveInstanceState(): Parcelable!

Called when the LayoutManager should save its state. This is a good time to save your scroll position, configuration and anything else that may be required to restore the same layout state if the LayoutManager is recreated.

RecyclerView does NOT verify if the LayoutManager has changed between state save and restore. This will let you share information between your LayoutManagers but it is also your responsibility to make sure they use the same parcelable class.

Returns
Parcelable!

Necessary information for LayoutManager to be able to restore its state

onScrollStateChanged

fun onScrollStateChanged(state: Int): Unit

RecyclerView calls this method to notify LayoutManager that scroll state has changed.

Parameters
state: Int

The new scroll state for RecyclerView

scrollHorizontallyBy

fun scrollHorizontallyBy(
    dx: Int,
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
): Int

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.

scrollToPosition

fun scrollToPosition(position: Int): Unit

Scroll to the specified adapter position. Actual position of the item on the screen depends on the LayoutManager implementation.

Parameters
position: Int

Scroll to this adapter position.

scrollToPositionWithOffset

Added in 1.0.0
fun scrollToPositionWithOffset(position: Int, offset: Int): Unit

Scroll to the specified adapter position with the given offset from layout start.

Note that scroll position change will not be reflected until the next layout call.

If you are just trying to make a position visible, use scrollToPosition.

Parameters
position: Int

Index (starting at 0) of the reference item.

offset: Int

The distance (in pixels) between the start edge of the item view and start edge of the RecyclerView.

scrollVerticallyBy

fun scrollVerticallyBy(
    dy: Int,
    recycler: RecyclerView.Recycler!,
    state: RecyclerView.State!
): Int

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.

setGapStrategy

Added in 1.0.0
fun setGapStrategy(gapStrategy: Int): Unit

Sets the gap handling strategy for StaggeredGridLayoutManager. If the gapStrategy parameter is different than the current strategy, calling this method will trigger a layout request.

Parameters
gapStrategy: Int

The new gap handling strategy. Should be GAP_HANDLING_MOVE_ITEMS_BETWEEN_SPANS or GAP_HANDLING_NONE.

See also
getGapStrategy

setMeasuredDimension

fun setMeasuredDimension(childrenBounds: Rect!, wSpec: Int, hSpec: Int): Unit

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

This method must call setMeasuredDimension.

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.

setOrientation

Added in 1.0.0
fun setOrientation(orientation: Int): Unit

Sets the orientation of the layout. StaggeredGridLayoutManager will do its best to keep scroll position if this method is called after views are laid out.

Parameters
orientation: Int

HORIZONTAL or VERTICAL

setReverseLayout

Added in 1.0.0
fun setReverseLayout(reverseLayout: Boolean): Unit

Sets whether LayoutManager should start laying out items from the end of the UI. The order items are traversed is not affected by this call.

For vertical layout, if it is set to true, first item will be at the bottom of the list.

For horizontal layouts, it depends on the layout direction. When set to true, If RecyclerView is LTR, than it will layout from RTL, if RecyclerView} is RTL, it will layout from LTR.

Parameters
reverseLayout: Boolean

Whether layout should be in reverse or not

setSpanCount

Added in 1.0.0
fun setSpanCount(spanCount: Int): Unit

Sets the number of spans for the layout. This will invalidate all of the span assignments for Views.

Calling this method will automatically result in a new layout request unless the spanCount parameter is equal to current span count.

Parameters
spanCount: Int

Number of spans to layout

smoothScrollToPosition

fun smoothScrollToPosition(
    recyclerView: RecyclerView!,
    state: RecyclerView.State!,
    position: Int
): Unit

Smooth scroll to the specified adapter position.

To support smooth scrolling, override this method, create your SmoothScroller instance and call startSmoothScroll.

Parameters
recyclerView: RecyclerView!

The RecyclerView to which this layout manager is attached

state: RecyclerView.State!

Current State of RecyclerView

position: Int

Scroll to this adapter position.

supportsPredictiveItemAnimations

fun supportsPredictiveItemAnimations(): Boolean

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.

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.