ViewHolder

abstract class ViewHolder
kotlin.Any
   ↳ androidx.recyclerview.widget.RecyclerView.ViewHolder

A ViewHolder describes an item view and metadata about its place within the RecyclerView.

Adapter implementations should subclass ViewHolder and add fields for caching potentially expensive View#findViewById(int) results.

While LayoutParams belong to the LayoutManager, ViewHolders belong to the adapter. Adapters should feel free to use their own custom ViewHolder implementations to store data that makes binding view contents easier. Implementations should assume that individual item views will hold strong references to ViewHolder objects and that RecyclerView instances may hold strong references to extra off-screen item views for caching purposes

Summary

Public constructors
<init>(@NonNull itemView: View)

Public methods
Int

Returns the position of the ViewHolder in terms of the latest layout pass.

Boolean

Int

Returns the Adapter position of the item represented by this ViewHolder.

Int

When LayoutManager supports animations, RecyclerView tracks 3 positions for ViewHolders to perform animations.

Long

Returns The itemId represented by this ViewHolder.

open String

Int

Int

Unit
setIsRecyclable(recyclable: Boolean)

Informs the recycler whether this item can be recycled.

Properties
View!

Public constructors

<init>

ViewHolder(@NonNull itemView: View)

Public methods

getLayoutPosition

fun getLayoutPosition(): Int

Returns the position of the ViewHolder in terms of the latest layout pass.

This position is mostly used by RecyclerView components to be consistent while RecyclerView lazily processes adapter updates.

For performance and animation reasons, RecyclerView batches all adapter updates until the next layout pass. This may cause mismatches between the Adapter position of the item and the position it had in the latest layout calculations.

LayoutManagers should always call this method while doing calculations based on item positions. All methods in RecyclerView.LayoutManager, RecyclerView.State, RecyclerView.Recycler that receive a position expect it to be the layout position of the item.

If LayoutManager needs to call an external method that requires the adapter position of the item, it can use getAdapterPosition() or RecyclerView.Recycler#convertPreLayoutPositionToPostLayout(int).

Return
Int: Returns the adapter position of the ViewHolder in the latest layout pass.

isRecyclable

fun isRecyclable(): Boolean
Return
Boolean: true if this item is available to be recycled, false otherwise.

getAdapterPosition

fun getAdapterPosition(): Int

Returns the Adapter position of the item represented by this ViewHolder.

Note that this might be different than the getLayoutPosition() if there are pending adapter updates but a new layout pass has not happened yet.

RecyclerView does not handle any adapter updates until the next layout traversal. This may create temporary inconsistencies between what user sees on the screen and what adapter contents have. This inconsistency is not important since it will be less than 16ms but it might be a problem if you want to use ViewHolder position to access the adapter. Sometimes, you may need to get the exact adapter position to do some actions in response to user events. In that case, you should use this method which will calculate the Adapter position of the ViewHolder.

Note that if you've called RecyclerView.Adapter#notifyDataSetChanged(), until the next layout pass, the return value of this method will be NO_POSITION.

Return
Int: The adapter position of the item if it still exists in the adapter. RecyclerView#NO_POSITION if item has been removed from the adapter, RecyclerView.Adapter#notifyDataSetChanged() has been called after the last layout pass or the ViewHolder has already been recycled.

getOldPosition

fun getOldPosition(): Int

When LayoutManager supports animations, RecyclerView tracks 3 positions for ViewHolders to perform animations.

If a ViewHolder was laid out in the previous onLayout call, old position will keep its adapter index in the previous layout.

Return
Int: The previous adapter index of the Item represented by this ViewHolder or NO_POSITION if old position does not exists or cleared (pre-layout is complete).

getItemId

fun getItemId(): Long

Returns The itemId represented by this ViewHolder.

Return
Long: The item's id if adapter has stable ids, RecyclerView#NO_ID otherwise

toString

open fun toString(): String

getItemViewType

fun getItemViewType(): Int
Return
Int: The view type of this ViewHolder.

getPosition

fun getPosition(): Int

setIsRecyclable

fun setIsRecyclable(recyclable: Boolean): Unit

Informs the recycler whether this item can be recycled. Views which are not recyclable will not be reused for other items until setIsRecyclable() is later set to true. Calls to setIsRecyclable() should always be paired (one call to setIsRecyclabe(false) should always be matched with a later call to setIsRecyclable(true)). Pairs of calls may be nested, as the state is internally reference-counted.

Parameters
recyclable Boolean: Whether this item is available to be recycled. Default value is true.

See Also

Properties

itemView

@NonNull val itemView: View!