SparseArrayObjectAdapter

Kotlin |Java

open class SparseArrayObjectAdapter : ObjectAdapter

kotlin.Any
↳	androidx.leanback.widget.ObjectAdapter
	↳	androidx.leanback.widget.SparseArrayObjectAdapter

An ObjectAdapter implemented with a android.util.SparseArray. This class maintains an array of objects where each object is associated with an integer key which determines its order relative to other objects.

Summary

Inherited constants
From class ObjectAdapter Int NO_ID Indicates that an id has not been set.

Public constructors
<init>(presenterSelector: PresenterSelector!) Constructs an adapter with the given PresenterSelector.
<init>(presenter: Presenter!) Constructs an adapter with the given Presenter.
<init>() Constructs an adapter.

Public methods
open Unit	clear(key: Int) Clears the given key and associated item from the adapter.
open Unit	clear() Removes all items from this adapter, leaving it empty.
open Any!	get(position: Int)
open Int	indexOf(item: Any!) Returns the index for the given item in the adapter.
open Int	indexOf(key: Int) Returns the index for the given key in the adapter.
open Boolean	isImmediateNotifySupported()
open Any!	lookup(key: Int) Returns the object for the given key, or null if no mapping for that key exists.
open Unit	notifyArrayItemRangeChanged(positionStart: Int, itemCount: Int) Notify that the content of a range of items changed.
open Unit	set(key: Int, item: Any!) Sets the item for the given key.
open Int	size()

Inherited functions

From class ObjectAdapter Long getId(position: Int) Returns the id for the given position. Presenter! getPresenter(item: Any!) Returns the Presenter for the given item from the adapter. PresenterSelector! getPresenterSelector() Returns the presenter selector for this ObjectAdapter. Boolean hasStableIds() Returns true if the item ids are stable across changes to the underlying data. When this is true, clients of the ObjectAdapter can use getId(int) to correlate Objects across changes. Unit notifyChanged() Notifies UI that the underlying data has changed. Unit notifyItemMoved(fromPosition: Int, toPosition: Int) Notifies UI that item at fromPosition has been moved to toPosition. Unit notifyItemRangeChanged(positionStart: Int, itemCount: Int) Notifies UI that some items has changed. Unit notifyItemRangeChanged(positionStart: Int, itemCount: Int, payload: Any!) Notifies UI that some items has changed. Unit notifyItemRangeInserted(positionStart: Int, itemCount: Int) Notifies UI that new items has been inserted. Unit notifyItemRangeRemoved(positionStart: Int, itemCount: Int) Notifies UI that some items that has been removed. Unit onHasStableIdsChanged() Called when setHasStableIds(boolean) is called and the status of stable ids has changed. Unit onPresenterSelectorChanged() Called when setPresenterSelector(PresenterSelector) is called and the PresenterSelector differs from the previous one. Unit registerObserver(observer: ObjectAdapter.DataObserver!) Registers a DataObserver for data change notifications. Unit setHasStableIds(hasStableIds: Boolean) Sets whether the item ids are stable across changes to the underlying data. Unit setPresenterSelector(presenterSelector: PresenterSelector!) Sets the presenter selector. May not be null. Unit unregisterAllObservers() Unregisters all DataObservers for this ObjectAdapter. Unit unregisterObserver(observer: ObjectAdapter.DataObserver!) Unregisters a DataObserver for data change notifications.

Public constructors

<init>

SparseArrayObjectAdapter(presenterSelector: PresenterSelector!)

Constructs an adapter with the given PresenterSelector.

<init>

SparseArrayObjectAdapter(presenter: Presenter!)

Constructs an adapter with the given Presenter.

<init>

SparseArrayObjectAdapter()

Constructs an adapter.

Public methods

clear

open fun clear(key: Int): Unit

Clears the given key and associated item from the adapter.

Parameters
key	Int: The key to be cleared.

clear

open fun clear(): Unit

Removes all items from this adapter, leaving it empty.

get

open fun get(position: Int): Any!

indexOf

open fun indexOf(item: Any!): Int

Returns the index for the given item in the adapter.

Parameters
item	Any!: The item to find in the array.

Return
Int	Index of the item, or a negative value if not found.

indexOf

open fun indexOf(key: Int): Int

Returns the index for the given key in the adapter.

Parameters
key	Int: The key to find in the array.

Return
Int	Index of the item, or a negative value if not found.

isImmediateNotifySupported

open fun isImmediateNotifySupported(): Boolean

lookup

open fun lookup(key: Int): Any!

Returns the object for the given key, or null if no mapping for that key exists.