universum.studios.android.widget.adapter

Class SimpleAdapter<Item,VH>

java.lang.Object

android.widget.BaseAdapter

universum.studios.android.widget.adapter.BaseAdapter<Item,VH>

universum.studios.android.widget.adapter.SimpleAdapter<Item,VH>

Type Parameters:

Item - Type of the item presented within a data set of a subclass of this SimpleAdapter.

VH - Type of the view holder used within a subclass of this SimpleAdapter.

All Implemented Interfaces:

Adapter, ListAdapter, SpinnerAdapter, DataSet<Item>, DataSetAdapter<Item>, ItemsAdapter<Item>

public abstract class SimpleAdapter<Item,VH>
extends BaseAdapter<Item,VH>
implements ItemsAdapter<Item>

A BaseAdapter implementation which specifies simple API for data set management of items. This adapter supports changing of the current data set via changeItems(List) and obtaining an item for a desired position via getItem(int). All items attached to the adapter may be obtained via getItems().

In the simplest implementation case of this adapter, only BaseAdapter.onCreateView(android.view.ViewGroup, int) and BaseAdapter.onBindViewHolder(Object, int) methods are required to be implemented to take a full advantage of this adapter class.

Author:

Martin Albedinsky

Field Summary

Fields inherited from class universum.studios.android.widget.adapter.BaseAdapter

mContext, mLayoutInflater, mResources

Fields inherited from interface universum.studios.android.widget.adapter.DataSet

NO_ID, NO_POSITION

Fields inherited from interface android.widget.Adapter

IGNORE_ITEM_VIEW_TYPE, NO_SELECTION

Constructor Summary

Constructors

Constructor and Description
SimpleAdapter(Context context) Creates a new instance of SimpleAdapter without initial items data set.
SimpleAdapter(Context context, Item[] items) Same as SimpleAdapter(Context, List) for array of initial items data set.
SimpleAdapter(Context context, List<Item> items) Creates a new instance of SimpleAdapter with the given initial items data set.

Method Summary

Modifier and Type	Method and Description
void	changeItems(List<Item> items) Same as ItemsAdapter.swapItems(List) without returning the old data set of items.
Item	getItem(int position) Returns the item (model) containing data from this data set for the specified position.
int	getItemCount() Returns the count of items available within this data set.
List<Item>	getItems() Returns the current items data set of this adapter.
boolean	hasItemAt(int position) Returns a boolean flag indicating whether this data set has item that can provide data for the specified position or not.
protected boolean	onItemsChange(List<Item> newItems, List<Item> oldItems) Called from swapItems(List) in order to handle change in items of this adapter.
List<Item>	swapItems(List<Item> items) Changes items data set of this adapter and returns the old items data set.

Methods inherited from class universum.studios.android.widget.adapter.BaseAdapter

currentViewType, getCount, getItemId, getView, hasStableIds, inflate, notifyDataSetActionSelected, notifyDataSetChanged, notifyDataSetInvalidated, onBindViewHolder, onCreateView, onCreateViewHolder, onDataSetActionSelected, registerOnDataChangeListener, registerOnDataSetActionListener, registerOnDataSetListener, restoreInstanceState, saveInstanceState, unregisterOnDataChangeListener, unregisterOnDataSetActionListener, unregisterOnDataSetListener

Methods inherited from class android.widget.BaseAdapter

areAllItemsEnabled, getDropDownView, getItemViewType, getViewTypeCount, isEmpty, isEnabled, registerDataSetObserver, unregisterDataSetObserver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface universum.studios.android.widget.adapter.DataSetAdapter

hasStableIds, isEnabled, restoreInstanceState, saveInstanceState

Methods inherited from interface universum.studios.android.widget.adapter.DataSet

getItemId, isEmpty, registerOnDataChangeListener, registerOnDataSetActionListener, registerOnDataSetListener, unregisterOnDataChangeListener, unregisterOnDataSetActionListener, unregisterOnDataSetListener

Constructor Detail

SimpleAdapter

public SimpleAdapter(@NonNull
                     Context context)

Creates a new instance of SimpleAdapter without initial items data set.

Parameters:

context - Context in which will be this adapter used.

See Also:

SimpleAdapter(Context, Object[]), SimpleAdapter(Context, List)

SimpleAdapter

public SimpleAdapter(@NonNull
                     Context context,
                     @NonNull
                     Item[] items)

Same as SimpleAdapter(Context, List) for array of initial items data set.

SimpleAdapter

public SimpleAdapter(@NonNull
                     Context context,
                     @NonNull
                     List<Item> items)

Creates a new instance of SimpleAdapter with the given initial items data set.

Parameters:

context - Context in which will be this adapter used.

items - List of items to be used as initial data set for this adapter.

Method Detail

changeItems

public void changeItems(@Nullable
                        List<Item> items)

Description copied from interface: ItemsAdapter

Same as ItemsAdapter.swapItems(List) without returning the old data set of items.

Specified by:

changeItems in interface ItemsAdapter<Item>

Parameters:

items - The desired items to be changed. May be null to clear the current ones.

See Also:

ItemsAdapter.getItems()

swapItems

@Nullable
public List<Item> swapItems(@Nullable
                                       List<Item> items)

Description copied from interface: ItemsAdapter

Changes items data set of this adapter and returns the old items data set.

Specified by:

swapItems in interface ItemsAdapter<Item>

Parameters:

items - The desired items to be changed. May be null to clear the current ones.

Returns:

The old items data set or null if this adapter does not have items data set specified.

See Also:

ItemsAdapter.getItems()

onItemsChange

protected boolean onItemsChange(@Nullable
                                List<Item> newItems,
                                @Nullable
                                List<Item> oldItems)

Called from swapItems(List) in order to handle change in items of this adapter.

Note, that during this call this adapter has already the new items attached.

This implementation does nothing.

Parameters:

newItems - The new items data set for this adapter.

oldItems - The old items data set of this adapter that has been replaced by the new one.

Returns:

True if change has been handled and appropriate callbacks has been fired to registered observers, false if default BaseAdapter.notifyDataSetChanged() should be invoked.

getItems

@Nullable
public List<Item> getItems()

Description copied from interface: ItemsAdapter

Returns the current items data set of this adapter.

Specified by:

getItems in interface ItemsAdapter<Item>

Returns:

This adapter's items data set or null if there is no items data set provided by this adapter.

See Also:

ItemsAdapter.changeItems(List), ItemsAdapter.swapItems(List)

getItemCount

public int getItemCount()

Description copied from interface: DataSet

Returns the count of items available within this data set.

Specified by:

getItemCount in interface DataSet<Item>

Returns:

Count of rows of the attached cursor or 0 if no cursor is attached or it has no rows.

See Also:

DataSet.isEmpty(), DataSet.hasItemAt(int), DataSet.getItem(int)

hasItemAt

public boolean hasItemAt(int position)

Description copied from interface: DataSet

Returns a boolean flag indicating whether this data set has item that can provide data for the specified position or not.

Specified by:

hasItemAt in interface DataSet<Item>

Parameters:

position - The position of item to check.

Returns:

True if DataSet.getItem(int) can be called 'safely', false otherwise.

getItem

@NonNull
public Item getItem(int position)

Description copied from interface: DataSet

Returns the item (model) containing data from this data set for the specified position.

Specified by:

getItem in interface Adapter

Specified by:

getItem in interface DataSet<Item>

Parameters:

position - Position of the item to obtain.

Returns:

Item with data for the requested position.

See Also:

DataSet.hasItemAt(int), DataSet.getItemId(int)