CursorObjectAdapter
public
class
CursorObjectAdapter
extends ObjectAdapter
java.lang.Object | ||
↳ | androidx.leanback.widget.ObjectAdapter | |
↳ | androidx.leanback.widget.CursorObjectAdapter |
An ObjectAdapter
implemented with a Cursor
.
Summary
Inherited constants |
---|
Public constructors | |
---|---|
CursorObjectAdapter(PresenterSelector presenterSelector)
Constructs an adapter with the given |
|
CursorObjectAdapter(Presenter presenter)
Constructs an adapter that uses the given |
|
CursorObjectAdapter()
Constructs an adapter. |
Public methods | |
---|---|
void
|
changeCursor(Cursor cursor)
Changes the underlying cursor to a new cursor. |
void
|
close()
Closes this adapter, closing the backing |
Object
|
get(int index)
Returns the item for the given position. |
final
Cursor
|
getCursor()
Returns the |
final
CursorMapper
|
getMapper()
Returns the |
boolean
|
isClosed()
Returns true if the adapter, and hence the backing |
boolean
|
isImmediateNotifySupported()
Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise. |
final
void
|
setMapper(CursorMapper mapper)
Sets the |
int
|
size()
Returns the number of items in the adapter. |
Cursor
|
swapCursor(Cursor cursor)
Swap in a new Cursor, returning the old Cursor. |
Protected methods | |
---|---|
final
void
|
invalidateCache(int index)
Removes an item from the cache. |
final
void
|
invalidateCache(int index, int count)
Removes |
void
|
onCursorChanged()
Called whenever the cursor changes. |
void
|
onMapperChanged()
Called when |
Inherited methods | |
---|---|
Public constructors
CursorObjectAdapter
public CursorObjectAdapter (PresenterSelector presenterSelector)
Constructs an adapter with the given PresenterSelector
.
Parameters | |
---|---|
presenterSelector |
PresenterSelector |
CursorObjectAdapter
public CursorObjectAdapter (Presenter presenter)
Constructs an adapter that uses the given Presenter
for all items.
Parameters | |
---|---|
presenter |
Presenter |
CursorObjectAdapter
public CursorObjectAdapter ()
Constructs an adapter.
Public methods
changeCursor
public void changeCursor (Cursor cursor)
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.
|
get
public Object get (int index)
Returns the item for the given position.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
Object |
getMapper
public final CursorMapper getMapper ()
Returns the CursorMapper
used to convert Cursor
rows into
Objects.
Returns | |
---|---|
CursorMapper |
isClosed
public boolean isClosed ()
Returns true if the adapter, and hence the backing Cursor
, is closed; false
otherwise.
Returns | |
---|---|
boolean |
isImmediateNotifySupported
public boolean isImmediateNotifySupported ()
Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise.
Returns | |
---|---|
boolean |
setMapper
public final void setMapper (CursorMapper mapper)
Sets the CursorMapper
used to convert Cursor
rows into
Objects.
Parameters | |
---|---|
mapper |
CursorMapper |
size
public int size ()
Returns the number of items in the adapter.
Returns | |
---|---|
int |
swapCursor
public Cursor swapCursor (Cursor cursor)
Swap in a new Cursor, returning the old Cursor. Unlike changeCursor(Cursor), the returned old Cursor is not closed.
Parameters | |
---|---|
cursor |
Cursor : The new cursor to be used.
|
Returns | |
---|---|
Cursor |
Protected methods
invalidateCache
protected final void invalidateCache (int index)
Removes an item from the cache. This will force the item to be re-read
from the data source the next time get(int)
is called.
Parameters | |
---|---|
index |
int |
invalidateCache
protected final void invalidateCache (int index, int count)
Removes count
items starting at index
.
Parameters | |
---|---|
index |
int |
count |
int |
onCursorChanged
protected void onCursorChanged ()
Called whenever the cursor changes.
onMapperChanged
protected void onMapperChanged ()
Called when setMapper(CursorMapper)
is called and a different
mapper is provided.