LeanbackListPreferenceDialogFragment.AdapterMulti

inner class LeanbackListPreferenceDialogFragment.AdapterMulti : RecyclerView.Adapter, LeanbackListPreferenceDialogFragment.ViewHolder.OnItemClickListener

kotlin.Any
   ↳ androidx.recyclerview.widget.RecyclerView.Adapter
     ↳ androidx.leanback.preference.LeanbackListPreferenceDialogFragment.AdapterMulti

Adapter for multiple choices.

Summary

Public constructors
AdapterMulti(
    entries: Array<CharSequence!>!,
    entryValues: Array<CharSequence!>!,
    initialSelections: (Mutable)Set<String!>!
)

Public functions
Int

Returns the total number of items in the data set held by the adapter.
Unit

Called by RecyclerView to display the data at the specified position.
LeanbackListPreferenceDialogFragment.ViewHolder!
onCreateViewHolder(parent: ViewGroup!, viewType: Int)

Called when RecyclerView needs a new ViewHolder of the given type to represent an item.
Unit

Inherited functions
From androidx.recyclerview.widget.RecyclerView.Adapter
Unit
bindViewHolder(holder: VH, position: Int)

This method internally calls onBindViewHolder to update the ViewHolder contents with the item at the given position and also sets up some private fields to be used by RecyclerView.
VH
createViewHolder(parent: ViewGroup, viewType: Int)

This method calls onCreateViewHolder to create a new ViewHolder and initializes some private fields to be used by RecyclerView.
Int
findRelativeAdapterPositionIn(
    adapter: RecyclerView.Adapter<RecyclerView.ViewHolder!>,
    viewHolder: RecyclerView.ViewHolder,
    localPosition: Int
)

Returns the position of the given ViewHolder in the given Adapter.
Long
getItemId(position: Int)

Return the stable ID for the item at position.
Int
getItemViewType(position: Int)

Return the view type of the item at position for the purposes of view recycling.
RecyclerView.Adapter.StateRestorationPolicy

Returns when this Adapter wants to restore the state.
Boolean

Returns true if one or more observers are attached to this adapter.
Boolean

Returns true if this adapter publishes a unique long value that can act as a key for the item at a given position in the data set.
Unit

Notify any registered observers that the data set has changed.
Unit

Notify any registered observers that the item at position has changed.
Unit
notifyItemChanged(position: Int, payload: Any?)

Notify any registered observers that the item at position has changed with an optional payload object.
Unit

Notify any registered observers that the item reflected at position has been newly inserted.
Unit
notifyItemMoved(fromPosition: Int, toPosition: Int)

Notify any registered observers that the item reflected at fromPosition has been moved to toPosition.
Unit
notifyItemRangeChanged(positionStart: Int, itemCount: Int)

Notify any registered observers that the itemCount items starting at position positionStart have changed.
Unit
notifyItemRangeChanged(positionStart: Int, itemCount: Int, payload: Any?)

Notify any registered observers that the itemCount items starting at position positionStart have changed.
Unit
notifyItemRangeInserted(positionStart: Int, itemCount: Int)

Notify any registered observers that the currently reflected itemCount items starting at positionStart have been newly inserted.
Unit
notifyItemRangeRemoved(positionStart: Int, itemCount: Int)

Notify any registered observers that the itemCount items previously located at positionStart have been removed from the data set.
Unit

Notify any registered observers that the item previously located at position has been removed from the data set.
Unit

Called by RecyclerView when it starts observing this Adapter.
Unit
onBindViewHolder(holder: VH, position: Int, payloads: (Mutable)List<Any!>)

Called by RecyclerView to display the data at the specified position.
Unit

Called by RecyclerView when it stops observing this Adapter.
Boolean

Called by the RecyclerView if a ViewHolder created by this Adapter cannot be recycled due to its transient state.
Unit

Called when a view created by this adapter has been attached to a window.
Unit

Called when a view created by this adapter has been detached from its window.
Unit
onViewRecycled(holder: VH)

Called when a view created by this adapter has been recycled.
Unit

Register a new observer to listen for data changes.
Unit
setHasStableIds(hasStableIds: Boolean)

Indicates whether each item in the data set can be represented with a unique identifier of type java.lang.Long.
Unit

Sets the state restoration strategy for the Adapter.
Unit

Unregister an observer currently listening for data changes.

Public constructors

AdapterMulti

Added in 1.1.0
Deprecated in 1.1.0
AdapterMulti(
    entries: Array<CharSequence!>!,
    entryValues: Array<CharSequence!>!,
    initialSelections: (Mutable)Set<String!>!
)

Public functions

getItemCount

Added in 1.1.0
Deprecated in 1.1.0
fun getItemCount(): Int

Returns the total number of items in the data set held by the adapter.

Returns
Int

The total number of items in this adapter.

onBindViewHolder

Added in 1.1.0
Deprecated in 1.1.0
fun onBindViewHolder(
    holder: LeanbackListPreferenceDialogFragment.ViewHolder!,
    position: Int
): Unit

Called by RecyclerView to display the data at the specified position. This method should update the contents of the itemView to reflect the item at the given position.

Note that unlike android.widget.ListView, RecyclerView will not call this method again if the position of the item changes in the data set unless the item itself is invalidated or the new position cannot be determined. For this reason, you should only use the position parameter while acquiring the related data item inside this method and should not keep a copy of it. If you need the position of an item later on (e.g. in a click listener), use getBindingAdapterPosition which will have the updated adapter position. Override onBindViewHolder instead if Adapter can handle efficient partial bind.

Parameters
holder: LeanbackListPreferenceDialogFragment.ViewHolder!

The ViewHolder which should be updated to represent the contents of the item at the given position in the data set.
position: Int

The position of the item within the adapter's data set.

onCreateViewHolder

Added in 1.1.0
Deprecated in 1.1.0
fun onCreateViewHolder(parent: ViewGroup!, viewType: Int): LeanbackListPreferenceDialogFragment.ViewHolder!

Called when RecyclerView needs a new ViewHolder of the given type to represent an item.

This new ViewHolder should be constructed with a new View that can represent the items of the given type. You can either create a new View manually or inflate it from an XML layout file.

The new ViewHolder will be used to display items of the adapter using onBindViewHolder. Since it will be re-used to display different items in the data set, it is a good idea to cache references to sub views of the View to avoid unnecessary findViewById calls.

Parameters
parent: ViewGroup!

The ViewGroup into which the new View will be added after it is bound to an adapter position.
viewType: Int

The view type of the new View.
Returns
LeanbackListPreferenceDialogFragment.ViewHolder!

A new ViewHolder that holds a View of the given view type.
See also
getItemViewType
onBindViewHolder

onItemClick

Added in 1.2.0-alpha04
Deprecated in 1.2.0-alpha04
fun onItemClick(
    viewHolder: LeanbackListPreferenceDialogFragment.ViewHolder!
): Unit