added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

ArrayObjectAdapter

public class ArrayObjectAdapter
extends ObjectAdapter

java.lang.Object
   ↳ android.support.v17.leanback.widget.ObjectAdapter
     ↳ android.support.v17.leanback.widget.ArrayObjectAdapter

An ObjectAdapter implemented with an ArrayList.

Summary

Inherited constants

From class android.support.v17.leanback.widget.ObjectAdapter

Public constructors

ArrayObjectAdapter(PresenterSelector presenterSelector)

Constructs an adapter with the given PresenterSelector.

ArrayObjectAdapter(Presenter presenter)

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

ArrayObjectAdapter()

Constructs an adapter.

Public methods

void add(Object item)

Adds an item to the end of the adapter.

void add(int index, Object item)

Inserts an item into this adapter at the specified index.

void addAll(int index, Collection items)

Adds the objects in the given collection to the adapter, starting at the given index.

void clear()

Removes all items from this adapter, leaving it empty.

Object get(int index)

Returns the item for the given position.

int indexOf(Object item)

Returns the index for the first occurrence of item in the adapter, or -1 if not found.

boolean isImmediateNotifySupported()

Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise.

void move(int fromPosition, int toPosition)

Moved the item at fromPosition to toPosition.

void notifyArrayItemRangeChanged(int positionStart, int itemCount)

Notify that the content of a range of items changed.

boolean remove(Object item)

Removes the first occurrence of the given item from the adapter.

int removeItems(int position, int count)

Removes a range of items from the adapter.

void replace(int position, Object item)

Replaces item at position with a new item and calls notifyItemRangeChanged() at the given position.

void setItems(List itemList, DiffCallback callback)

Set a new item list to adapter.

int size()

Returns the number of items in the adapter.

<E> List<E> unmodifiableList()

Gets a read-only view of the list of object of this ArrayObjectAdapter.

Inherited methods

From class android.support.v17.leanback.widget.ObjectAdapter
From class java.lang.Object

Public constructors

ArrayObjectAdapter

added in version 22.1.0
ArrayObjectAdapter (PresenterSelector presenterSelector)

Constructs an adapter with the given PresenterSelector.

Parameters
presenterSelector PresenterSelector

ArrayObjectAdapter

added in version 22.1.0
ArrayObjectAdapter (Presenter presenter)

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

Parameters
presenter Presenter

ArrayObjectAdapter

added in version 22.1.0
ArrayObjectAdapter ()

Constructs an adapter.

Public methods

add

added in version 22.1.0
void add (Object item)

Adds an item to the end of the adapter.

Parameters
item Object: The item to add to the end of the adapter.

add

added in version 22.1.0
void add (int index, 
                Object item)

Inserts an item into this adapter at the specified index. If the index is > size() an exception will be thrown.

Parameters
index int: The index at which the item should be inserted.
item Object: The item to insert into the adapter.

addAll

added in version 22.1.0
void addAll (int index, 
                Collection items)

Adds the objects in the given collection to the adapter, starting at the given index. If the index is >= size() an exception will be thrown.

Parameters
index int: The index at which the items should be inserted.
items Collection: A Collection of items to insert.

clear

added in version 22.1.0
void clear ()

Removes all items from this adapter, leaving it empty.

get

added in version 22.1.0
Object get (int index)

Returns the item for the given position.

Parameters
index int

Returns
Object

indexOf

added in version 22.1.0
int indexOf (Object item)

Returns the index for the first occurrence of item in the adapter, or -1 if not found.

Parameters
item Object: The item to find in the list.
Returns
int Index of the first occurrence of the item in the adapter, or -1 if not found.

isImmediateNotifySupported

added in version 25.1.0
boolean isImmediateNotifySupported ()

Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise.

Returns
boolean

move

added in version 27.1.0
void move (int fromPosition, 
                int toPosition)

Moved the item at fromPosition to toPosition.

Parameters
fromPosition int: Previous position of the item.
toPosition int: New position of the item.

notifyArrayItemRangeChanged

added in version 22.1.0
void notifyArrayItemRangeChanged (int positionStart, 
                int itemCount)

Notify that the content of a range of items changed. Note that this is not same as items being added or removed.

Parameters
positionStart int: The position of first item that has changed.
itemCount int: The count of how many items have changed.

remove

added in version 22.1.0
boolean remove (Object item)

Removes the first occurrence of the given item from the adapter.

Parameters
item Object: The item to remove from the adapter.
Returns
boolean True if the item was found and thus removed from the adapter.

removeItems

added in version 22.1.0
int removeItems (int position, 
                int count)

Removes a range of items from the adapter. The range is specified by giving the starting position and the number of elements to remove.

Parameters
position int: The index of the first item to remove.
count int: The number of items to remove.
Returns
int The number of items removed.

replace

added in version 22.1.0
void replace (int position, 
                Object item)

Replaces item at position with a new item and calls notifyItemRangeChanged() at the given position. Note that this method does not compare new item to existing item.

Parameters
position int: The index of item to replace.
item Object: The new item to be placed at given position.

setItems

added in version 27.1.0
void setItems (List itemList, 
                DiffCallback callback)

Set a new item list to adapter. The DiffUtil will compute the difference and dispatch it to specified position.

Parameters
itemList List: List of new Items
callback DiffCallback: Optional DiffCallback Object to compute the difference between the old data set and new data set. When null, notifyChanged() will be fired.

size

added in version 22.1.0
int size ()

Returns the number of items in the adapter.

Returns
int

unmodifiableList

added in version 22.1.0
List<E> unmodifiableList ()

Gets a read-only view of the list of object of this ArrayObjectAdapter.

Returns
List<E>