com.sawyer.advadapters.widget

Class AbsArrayAdapter<T>

java.lang.Object

android.widget.BaseAdapter

com.sawyer.advadapters.widget.AbsArrayAdapter<T>

All Implemented Interfaces:

Adapter, Filterable, ListAdapter, SpinnerAdapter

public abstract class AbsArrayAdapter<T>
extends BaseAdapter
implements Filterable

A custom abstract BaseAdapter that is backed by an ArrayList of arbitrary objects. By default this class delegates view generation and defining the filtering logic to subclasses.

Designed to be a more flexible and customizable solution then Android's ArrayAdapter class. It provides extra features such as: supporting additional ArrayList methods, resolves outstanding filtering bugs, makes smarter use of notifyDataSetChanged(), and conveniently passes along a layout inflater for view creation.

Because of the background filtering process, all methods which mutates the underlying data are internally synchronized. This ensures a thread safe environment for internal write operations. If filtering is not required, it's strongly recommended to use the NFArrayAdapter instead.

Field Summary

Fields inherited from interface android.widget.Adapter

IGNORE_ITEM_VIEW_TYPE, NO_SELECTION

Constructor Summary

Constructors

Constructor and Description
AbsArrayAdapter(Context activity) Constructor
AbsArrayAdapter(Context activity, Collection<T> items) Constructor
AbsArrayAdapter(Context activity, T[] items) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(T items) Adds the specified items at the end of the adapter.
void	addAll(Collection<? extends T> items) Adds the specified Collection at the end of the adapter.
void	addAll(T... items) Adds the specified items at the end of the adapter.
void	clear() Remove all elements from the adapter.
boolean	contains(T item) Tests whether this adapter contains the specified item.
boolean	containsAll(Collection<?> items) Tests whether this adapter contains all items contained in the specified collection.
Context	getContext()
int	getCount()
View	getDropDownView(int position, View convertView, ViewGroup parent)
View	getDropDownView(LayoutInflater inflater, int position, View convertView, ViewGroup parent) Get a View that displays in the drop down popup the data at the specified position in the data set.
Filter	getFilter()
ArrayList<T>	getFilteredList()
T	getItem(int position)
long	getItemId(int position)
ArrayList<T>	getList()
int	getPosition(T item) Returns the position of the specified item in the array.
View	getView(int position, View convertView, ViewGroup parent)
abstract View	getView(LayoutInflater inflater, int position, View convertView, ViewGroup parent) Get a View that displays the data at the specified position in the data set.
void	notifyDataSetChanged()
void	remove(T item) Removes the first occurrence of the specified item from the adapter.
void	removeAll(Collection<?> items) Removes all occurrences in the adapter of each item in the specified collection.
void	retainAll(Collection<?> items) Removes all items from this adapter that are not contained in the specified collection.
void	setList(Collection<? extends T> items) Resets the adapter to store a new list of items.
void	setNotifyOnChange(boolean notifyOnChange) Control whether methods that change the list (add(T), retainAll(java.util.Collection<?>), remove(T), clear()) automatically call notifyDataSetChanged().
void	sort() Sorts the content of this adapter using the natural order of the stored items themselves.
void	sort(Comparator<? super T> comparator) Sorts the content of this adapter using the specified comparator.
void	update(int position, T item) Updates the item at the specified position in the adapter with the specified item.

Methods inherited from class android.widget.BaseAdapter

areAllItemsEnabled, getItemViewType, getViewTypeCount, hasStableIds, isEmpty, isEnabled, notifyDataSetInvalidated, registerDataSetObserver, unregisterDataSetObserver

Methods inherited from class java.lang.Object

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

Constructor Detail

AbsArrayAdapter

public AbsArrayAdapter(Context activity)

Constructor

Parameters:

activity - Context used for inflating views

AbsArrayAdapter

public AbsArrayAdapter(Context activity,
                       T[] items)

Constructor

Parameters:

activity - Context used for inflating views

items - The items to represent within the adapter.

AbsArrayAdapter

public AbsArrayAdapter(Context activity,
                       Collection<T> items)

Constructor

Parameters:

activity - Context used for inflating views

items - The items to represent within the adapter.

Method Detail

add

public void add(T items)

Adds the specified items at the end of the adapter. Will repeat the last filtering request if invoked while filtered results are being displayed.

Parameters:

items - The items to add at the end of the adapter.

addAll

public void addAll(Collection<? extends T> items)

Adds the specified Collection at the end of the adapter. Will repeat the last filtering request if invoked while filtered results are being displayed.

Parameters:

items - The Collection to add at the end of the adapter.

addAll

@SafeVarargs
public final void addAll(T... items)

Adds the specified items at the end of the adapter. Will repeat the last filtering request if invoked while filtered results are being displayed.

Parameters:

items - The items to add at the end of the adapter.

clear

public void clear()

Remove all elements from the adapter.

contains

public boolean contains(T item)

Tests whether this adapter contains the specified item. Be aware that this is a linear search.

Parameters:

item - The item to search for

Returns:

true if the item is an element of this adapter. false otherwise

containsAll

public boolean containsAll(Collection<?> items)

Tests whether this adapter contains all items contained in the specified collection. Be aware that this performs a nested for loop search...eg O(n*m) complexity.

Parameters:

items - The collection of items

Returns:

true if all items in the specified collection are elements of this adapter, false otherwise

getContext

public Context getContext()

Returns:

The Context associated with this adapter.

getCount

public int getCount()

Specified by:

getCount in interface Adapter

getDropDownView

public View getDropDownView(LayoutInflater inflater,
                            int position,
                            View convertView,
                            ViewGroup parent)

Get a View that displays in the drop down popup the data at the specified position in the data set.

Parameters:

inflater - the LayoutInflater object that can be used to inflate each view.

position - index of the item whose view we want.

convertView - the old view to reuse, if possible. Note: You should check that this view is non-null and of an appropriate type before using. If it is not possible to convert this view to display the correct data, this method can create a new view.

parent - the parent that this view will eventually be attached to

Returns:

a View corresponding to the data at the specified position.

getDropDownView

public final View getDropDownView(int position,
                                  View convertView,
                                  ViewGroup parent)

Specified by:

getDropDownView in interface SpinnerAdapter

Overrides:

getDropDownView in class BaseAdapter

getFilter

public Filter getFilter()

Specified by:

getFilter in interface Filterable

getFilteredList

public ArrayList<T> getFilteredList()

Returns:

The shown filtered list. If no filter is applied, then the original list is returned.

getItem

public T getItem(int position)

Specified by:

getItem in interface Adapter

getItemId

public long getItemId(int position)

Specified by:

getItemId in interface Adapter

getList

public ArrayList<T> getList()

Returns:

The original (unfiltered) list of items stored within the Adapter

setList

public void setList(Collection<? extends T> items)

Resets the adapter to store a new list of items. Convenient way of calling clear(), then addAll(java.util.Collection) without having to worry about an extra notifyDataSetChanged() invoked in between. Will repeat the last filtering request if invoked while filtered results are being displayed.

Parameters:

items - New list of items to store within the adapter.

getPosition

public int getPosition(T item)

Returns the position of the specified item in the array. Be aware that this performs a linear search.

Parameters:

item - The item to retrieve the position of.

Returns:

The position of the specified item.

getView

public abstract View getView(LayoutInflater inflater,
                             int position,
                             View convertView,
                             ViewGroup parent)

Get a View that displays the data at the specified position in the data set. You can either create a View manually or inflate it from an XML layout file. When the View is inflated, the parent View (GridView, ListView...) will apply default layout parameters unless you use LayoutInflater.inflate(int, android.view.ViewGroup, boolean) to specify a root view and to prevent attachment to the root.

Parameters:

inflater - The LayoutInflater object that can be used to inflate each view.

position - The position of the item within the adapter's data set of the item whose view we want.

convertView - The old view to reuse, if possible. Note: You should check that this view is non-null and of an appropriate type before using. If it is not possible to convert this view to display the correct data, this method can create a new view. Heterogeneous lists can specify their number of view types, so that this View is always of the right type (see BaseAdapter.getViewTypeCount() and BaseAdapter.getItemViewType(int)).

parent - The parent that this view will eventually be attached to

Returns:

A View corresponding to the data at the specified position.

getView

public final View getView(int position,
                          View convertView,
                          ViewGroup parent)

Specified by:

getView in interface Adapter

notifyDataSetChanged

public void notifyDataSetChanged()

Overrides:

notifyDataSetChanged in class BaseAdapter

remove

public void remove(T item)

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

Parameters:

item - The item to remove.

removeAll

public void removeAll(Collection<?> items)

Removes all occurrences in the adapter of each item in the specified collection.

Parameters:

items - The collection of items to remove

retainAll

public void retainAll(Collection<?> items)

Removes all items from this adapter that are not contained in the specified collection.

Parameters:

items - The collection of items to retain

setNotifyOnChange

public void setNotifyOnChange(boolean notifyOnChange)

Control whether methods that change the list (add(T), retainAll(java.util.Collection<?>), remove(T), clear()) automatically call notifyDataSetChanged(). If set to false, caller must manually call notifyDataSetChanged() to have the changes reflected in the attached view.

The default is true, and calling notifyDataSetChanged() resets the flag to true.

Parameters:

notifyOnChange - if true, modifications to the list will automatically call notifyDataSetChanged()

sort

public void sort()

Sorts the content of this adapter using the natural order of the stored items themselves. This requires items to have implemented Comparable and is equivalent of passing null to sort(java.util.Comparator).

Throws:

ClassCastException - If the comparator is null and the stored items do not implement Comparable or if compareTo throws for any pair of items.

sort

public void sort(Comparator<? super T> comparator)

Sorts the content of this adapter using the specified comparator.

Parameters:

comparator - Used to sort the items contained in this adapter. Null to use an item's Comparable interface.

Throws:

ClassCastException - If the comparator is null and the stored items do not implement Comparable or if compareTo throws for any pair of items.

update

public void update(int position,
                   T item)

Updates the item at the specified position in the adapter with the specified item. This operation does not change the size of the adapter. Will repeat the last filtering request if invoked while filtered results are being displayed. Be-aware this method is only a constant time operation when the list is not filtered. Otherwise, the position must be converted to a unfiltered position; which requires traversing the original unfiltered list.

Parameters:

position - The location at which to put the specified item

item - The new item to replace with the old