public class

RecyclerView.LayoutParams

extends android.view.ViewGroup.MarginLayoutParams

 java.lang.Object

↳android.view.ViewGroup.MarginLayoutParams

↳androidx.recyclerview.widget.RecyclerView.LayoutParams

Subclasses:

StaggeredGridLayoutManager.LayoutParams, GridLayoutManager.LayoutParams

Overview

subclass for children of RecyclerView. Custom layout managers are encouraged to create their own subclass of this LayoutParams class to store any additional required per-child view metadata about the layout.

Summary

Constructors
publicLayoutParams(Context c, AttributeSet attrs)

publicLayoutParams(MarginLayoutParams source)

publicLayoutParams(ViewGroup.LayoutParams source)

Methods
public intgetAbsoluteAdapterPosition()

Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to in the RecyclerView.

public intgetBindingAdapterPosition()

Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to with respect to the RecyclerView.Adapter that bound this View.

public intgetViewAdapterPosition()

public intgetViewLayoutPosition()

Returns the adapter position that the view this LayoutParams is attached to corresponds to as of latest layout calculation.

public intgetViewPosition()

public booleanisItemChanged()

Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been changed in the data set.

public booleanisItemRemoved()

Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been removed from the data set.

public booleanisViewInvalid()

Returns true if the view this LayoutParams is attached to is now representing potentially invalid data.

public booleanviewNeedsUpdate()

Returns true if the view this LayoutParams is attached to needs to have its content updated from the corresponding adapter.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public LayoutParams(Context c, AttributeSet attrs)

public LayoutParams(MarginLayoutParams source)

public LayoutParams(ViewGroup.LayoutParams source)

Methods

public boolean viewNeedsUpdate()

Returns true if the view this LayoutParams is attached to needs to have its content updated from the corresponding adapter.

Returns:

true if the view should have its content updated

public boolean isViewInvalid()

Returns true if the view this LayoutParams is attached to is now representing potentially invalid data. A LayoutManager should scrap/recycle it.

Returns:

true if the view is invalid

public boolean isItemRemoved()

Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been removed from the data set. A LayoutManager may choose to treat it differently in order to animate its outgoing or disappearing state.

Returns:

true if the item the view corresponds to was removed from the data set

public boolean isItemChanged()

Returns true if the adapter data item corresponding to the view this LayoutParams is attached to has been changed in the data set. A LayoutManager may choose to treat it differently in order to animate its changing state.

Returns:

true if the item the view corresponds to was changed in the data set

public int getViewPosition()

Deprecated: use RecyclerView.LayoutParams.getViewLayoutPosition() or RecyclerView.LayoutParams.getViewAdapterPosition()

public int getViewLayoutPosition()

Returns the adapter position that the view this LayoutParams is attached to corresponds to as of latest layout calculation.

Returns:

the adapter position this view as of latest layout pass

public int getViewAdapterPosition()

Deprecated: This method is confusing when nested adapters are used. If you are calling from the context of an RecyclerView.Adapter, use RecyclerView.LayoutParams.getBindingAdapterPosition(). If you need the position that RecyclerView sees, use RecyclerView.LayoutParams.getAbsoluteAdapterPosition().

public int getAbsoluteAdapterPosition()

Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to in the RecyclerView. If the RecyclerView has an RecyclerView.Adapter that merges other adapters, this position will be with respect to the adapter that is assigned to the RecyclerView.

Returns:

the up-to-date adapter position this view with respect to the RecyclerView. It may return RecyclerView.NO_POSITION if item represented by this View has been removed or its up-to-date position cannot be calculated.

public int getBindingAdapterPosition()

Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to with respect to the RecyclerView.Adapter that bound this View.

Returns:

the up-to-date adapter position this view relative to the RecyclerView.Adapter that bound this View. It may return RecyclerView.NO_POSITION if item represented by this View has been removed or its up-to-date position cannot be calculated.