PreferenceViewHolder

Kotlin |Java

open class PreferenceViewHolder : RecyclerView.ViewHolder

kotlin.Any
↳	androidx.recyclerview.widget.RecyclerView.ViewHolder
	↳	androidx.preference.PreferenceViewHolder

A RecyclerView.ViewHolder class which caches views associated with the default Preference layouts. Cached views can be retrieved by calling findViewById(int).

Summary

Public methods
open View!	findViewById(@IdRes id: Int) Returns a cached reference to a subview managed by this object.
open Boolean	isDividerAllowedAbove() Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it.
open Boolean	isDividerAllowedBelow() Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it.
open Unit	setDividerAllowedAbove(allowed: Boolean) Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it.
open Unit	setDividerAllowedBelow(allowed: Boolean) Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it.

Inherited functions

From class ViewHolder Int getAbsoluteAdapterPosition() Returns the Adapter position of the item represented by this ViewHolder with respect to the RecyclerView's Adapter. If the Adapter that bound this ViewHolder is inside another adapter (e.g. ConcatAdapter), this position might be different and will include the offsets caused by other adapters in the ConcatAdapter. 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. Note that if you are querying the position as RecyclerView sees, you should use getAbsoluteAdapterPosition() (e.g. you want to use it to save scroll state). If you are querying the position to access the Adapter contents, you should use getBindingAdapterPosition(). Int getAdapterPosition() RecyclerView.Adapter<out RecyclerView.ViewHolder!>? getBindingAdapter() Returns the Adapter that last bound this ViewHolder. Might return null if this ViewHolder is not bound to any adapter. Int getBindingAdapterPosition() Returns the Adapter position of the item represented by this ViewHolder with respect to the Adapter that bound it. 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. If the Adapter that bound this ViewHolder is inside another Adapter (e.g. ConcatAdapter), this position might be different than getAbsoluteAdapterPosition(). If you would like to know the position that RecyclerView considers (e.g. for saved state), you should use getAbsoluteAdapterPosition(). Long getItemId() Returns The itemId represented by this ViewHolder. Int getItemViewType() Int getLayoutPosition() 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 getAbsoluteAdapterPosition() or RecyclerView.Recycler#convertPreLayoutPositionToPostLayout(int). Int getOldPosition() 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. Int getPosition() Boolean isRecyclable() Unit setIsRecyclable(recyclable: Boolean) 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. String toString()

Inherited properties
From class ViewHolder View itemView

Public methods

findViewById

open fun findViewById(@IdRes id: Int): View!

Returns a cached reference to a subview managed by this object. If the view reference is not yet cached, it falls back to calling View#findViewById(int) and caches the result.

Parameters
id	Int: Resource ID of the view to find

Return
View!	The view, or null if no view with the requested ID is found

isDividerAllowedAbove

open fun isDividerAllowedAbove(): Boolean

Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it.

Return
Boolean	true if dividers are allowed above this item

isDividerAllowedBelow

open fun isDividerAllowedBelow(): Boolean

Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it.

Return
Boolean	true if dividers are allowed below this item

setDividerAllowedAbove

open fun setDividerAllowedAbove(allowed: Boolean): Unit

Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it. By default, Preference#onBindViewHolder(PreferenceViewHolder) will set this to the same value as returned by Preference#isSelectable(), so that non-selectable items do not have a divider drawn above them.

Parameters
allowed	Boolean: False to prevent dividers being drawn above this item

setDividerAllowedBelow

open fun setDividerAllowedBelow(allowed: Boolean): Unit

Dividers are only drawn between items if both items allow it, or above the first and below the last item if that item allows it. By default, Preference#onBindViewHolder(PreferenceViewHolder) will set this to the same value as returned by Preference#isSelectable(), so that non-selectable items do not have a divider drawn below them.

Parameters
allowed	Boolean: False to prevent dividers being drawn below this item