RecyclerView.LayoutParams

Artifact: androidx.recyclerview:recyclerview

Added in 1.0.0

Kotlin |Java

public class RecyclerView.LayoutParams extends ViewGroup.MarginLayoutParams

java.lang.Object
↳	android.view.ViewGroup.LayoutParams
	↳	android.view.ViewGroup.MarginLayoutParams
		↳	androidx.recyclerview.widget.RecyclerView.LayoutParams

Known direct subclasses

GridLayoutManager.LayoutParams, StaggeredGridLayoutManager.LayoutParams

`GridLayoutManager.LayoutParams`	LayoutParams used by GridLayoutManager.
`StaggeredGridLayoutManager.LayoutParams`	LayoutParams used by StaggeredGridLayoutManager.

LayoutParams 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

Public constructors
`LayoutParams(RecyclerView.LayoutParams source)`
`LayoutParams(ViewGroup.LayoutParams source)`
`LayoutParams(ViewGroup.MarginLayoutParams source)`
`LayoutParams(Context c, AttributeSet attrs)`
`LayoutParams(int width, int height)`

Public methods
`int`	`getAbsoluteAdapterPosition()` Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to in the `RecyclerView`.
`int`	`getBindingAdapterPosition()` Returns the up-to-date adapter position that the view this LayoutParams is attached to corresponds to with respect to the `Adapter` that bound this View.
`int`	`getViewAdapterPosition()` This method is deprecated. This method is confusing when nested adapters are used.
`int`	`getViewLayoutPosition()` Returns the adapter position that the view this LayoutParams is attached to corresponds to as of latest layout calculation.
`int`	`getViewPosition()` This method is deprecated. use `getViewLayoutPosition` or `getViewAdapterPosition`
`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.
`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.
`boolean`	`isViewInvalid()` Returns true if the view this LayoutParams is attached to is now representing potentially invalid data.
`boolean`	`viewNeedsUpdate()` Returns true if the view this LayoutParams is attached to needs to have its content updated from the corresponding adapter.

Inherited Constants

From android.view.ViewGroup.LayoutParams

`static final int`	`FILL_PARENT = -1` This field is deprecated.
`static final int`	`MATCH_PARENT = -1`
`static final int`	`WRAP_CONTENT = -2`

Inherited fields

From android.view.ViewGroup.LayoutParams

`int`	`height`
`LayoutAnimationController.AnimationParameters`	`layoutAnimationParameters`
`int`	`width`

From android.view.ViewGroup.MarginLayoutParams

`int`	`bottomMargin`
`int`	`leftMargin`
`int`	`rightMargin`
`int`	`topMargin`

Inherited methods

From android.view.ViewGroup.LayoutParams

void

setBaseAttributes(TypedArray a, int widthAttr, int heightAttr)

From android.view.ViewGroup.MarginLayoutParams

`int`	`getLayoutDirection()`
`int`	`getMarginEnd()`
`int`	`getMarginStart()`
`boolean`	`isMarginRelative()`
`void`	`resolveLayoutDirection(int layoutDirection)`
`void`	`setLayoutDirection(int layoutDirection)`
`void`	`setMarginEnd(int end)`
`void`	`setMarginStart(int start)`
`void`	`setMargins(int left, int top, int right, int bottom)`

Public constructors

Added in 1.0.0

public LayoutParams(RecyclerView.LayoutParams source)

LayoutParams

Added in 1.0.0

public LayoutParams(ViewGroup.LayoutParams source)

LayoutParams

Added in 1.0.0

public LayoutParams(ViewGroup.MarginLayoutParams source)

LayoutParams

Added in 1.0.0

public LayoutParams(Context c, AttributeSet attrs)

LayoutParams

Added in 1.0.0

public LayoutParams(int width, int height)

Public methods

getAbsoluteAdapterPosition

Added in 1.2.0

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 Adapter that merges other adapters, this position will be with respect to the adapter that is assigned to the RecyclerView.

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

getBindingAdapterPosition

Added in 1.2.0

public int getBindingAdapterPosition()

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

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

getViewAdapterPosition

Added in 1.0.0

Deprecated in 1.2.0

public int getViewAdapterPosition()

getViewLayoutPosition

Added in 1.0.0

public int getViewLayoutPosition()

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

Returns
`int`	the adapter position this view as of latest layout pass

getViewPosition

Added in 1.0.0

Deprecated in 1.0.0

public int getViewPosition()

isItemChanged

Added in 1.0.0

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
`boolean`	true if the item the view corresponds to was changed in the data set

isItemRemoved

Added in 1.0.0

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
`boolean`	true if the item the view corresponds to was removed from the data set

isViewInvalid

Added in 1.0.0

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
`boolean`	true if the view is invalid

viewNeedsUpdate

Added in 1.0.0

public boolean viewNeedsUpdate()

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

Returns
`boolean`	true if the view should have its content updated