CursorObjectAdapter

Kotlin |Java

open class CursorObjectAdapter : ObjectAdapter

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

An ObjectAdapter implemented with a Cursor.

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 that uses the given `Presenter` for all items.
`<init>()` Constructs an adapter.

Public methods
open Unit	`changeCursor(cursor: Cursor!)` Changes the underlying cursor to a new cursor.
open Unit	`close()` Closes this adapter, closing the backing `Cursor` as well.
open Any!	`get(index: Int)`
Cursor!	`getCursor()` Returns the `Cursor` backing the adapter.
CursorMapper!	`getMapper()` Returns the `CursorMapper` used to convert `Cursor` rows into Objects.
open Boolean	`isClosed()` Returns true if the adapter, and hence the backing `Cursor`, is closed; false otherwise.
open Boolean	`isImmediateNotifySupported()`
Unit	`setMapper(mapper: CursorMapper!)` Sets the `CursorMapper` used to convert `Cursor` rows into Objects.
open Int	`size()`
open Cursor!	`swapCursor(cursor: Cursor!)` Swap in a new Cursor, returning the old Cursor.

Protected methods
Unit	`invalidateCache(index: Int)` Removes an item from the cache.
Unit	`invalidateCache(index: Int, count: Int)` Removes `count` items starting at `index`.
open Unit	`onCursorChanged()` Called whenever the cursor changes.
open Unit	`onMapperChanged()` Called when `setMapper(CursorMapper)` is called and a different mapper is provided.

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>

CursorObjectAdapter(presenterSelector: PresenterSelector!)

Constructs an adapter with the given PresenterSelector.

<init>

CursorObjectAdapter(presenter: Presenter!)

Constructs an adapter that uses the given Presenter for all items.

<init>

CursorObjectAdapter()

Constructs an adapter.

Public methods

changeCursor

open fun changeCursor(cursor: Cursor!): Unit

Changes the underlying cursor to a new cursor. If there is an existing cursor it will be closed if it is different than the new cursor.

Parameters
`cursor`	Cursor!: The new cursor to be used.

close

open fun close(): Unit

Closes this adapter, closing the backing Cursor as well.

get

open fun get(index: Int): Any!

getCursor

fun getCursor(): Cursor!

Returns the Cursor backing the adapter.

getMapper

fun getMapper(): CursorMapper!

Returns the CursorMapper used to convert Cursor rows into Objects.

isClosed

open fun isClosed(): Boolean

Returns true if the adapter, and hence the backing Cursor, is closed; false otherwise.

isImmediateNotifySupported

open fun isImmediateNotifySupported(): Boolean

setMapper

fun setMapper(mapper</