com.telerik.widget.list

Class ListViewDataSourceAdapter

java.lang.Object

android.support.v7.widget.RecyclerView.Adapter<ListViewHolder>

com.telerik.widget.list.ListViewAdapter

com.telerik.widget.list.ListViewDataSourceAdapter

All Implemented Interfaces:

DataChangedListener

public class ListViewDataSourceAdapter
extends ListViewAdapter
implements DataChangedListener

Base class for an Adapter used by RadListView that supports data operations like grouping, filtering and sorting.

Adapters provide a binding from an app-specific data set to views that are displayed within a RadListView.

Constructor Summary

Constructors

Constructor and Description
ListViewDataSourceAdapter(List items) Creates an instance of the ListViewDataSourceAdapter class.

Method Summary

Modifier and Type	Method and Description
void	add(int index, Object item) Inserts the specified object into this ListViewAdapter at the specified index.
void	add(int index, Object item, boolean invalidateDescriptors) Inserts the specified object into this ListViewAdapter at the specified index.
void	add(Object item) Adds the specified item at the end of the items in this ListViewAdapter.
void	add(Object item, boolean invalidateDescriptors) Adds the specified item at the end of the items in this ListViewAdapter.
void	addFilterDescriptor(Function<Object,Boolean> filterDescriptor) Adds a filter descriptor that specifies how the items on this list can be filtered.
void	addGroupDescriptor(Function<Object,Object> groupDescriptor) Adds a group descriptor that specifies how the items on this list can be grouped.
void	addSortDescriptor(Function2<Object,Object,Integer> sortDescriptor) Adds a sort descriptor that specifies how the items on this list can be sorted.
boolean	canReorder(int position) Determines if the item at the provided position can be reordered.
boolean	canSelect(int position) Determines if the item at the provided position is selectable.
boolean	canSwipe(int position) Determines if the item at the provided position can be swiped.
void	clearFilterDescriptors() Clears the list of filter descriptors used by this instance.
void	clearGroupDescriptors() Clears the list of group descriptors used by this instance.
void	clearSortDescriptors() Clears the list of sort descriptors used by this instance.
void	dataChanged(DataChangeInfo info)
int	getBaseItemCount() Returns the total number of items handled by the adapter after the data operation are performed.
DataItem	getDataItem(int position) Return the DataItem on the provided position.
int	getGroupViewType(Object group) Return the view type of provided group header item for the purposes of view recycling.
int	getHeaderPosition(int position)
Object	getItem(int position) Return the item on the provided position.
int	getItemCount()
long	getItemId(int position)
int	getItemViewType(int position)
int	getItemViewType(Object item) Return the view type of provided item for the purposes of view recycling.
int	getPosition(long id) Return the position of the item with the provided id.
int	getPosition(Object searchItem) Return the position of the item that is provided.
void	invalidateDescriptors() Invalidates the descriptors and updates the list with any updates on the list.
boolean	isGroupHeader(int position) Return true if the item at the specified position is a group header and false otherwise.
void	onBindGroupViewHolder(ListViewHolder holder, Object groupKey) Called by RadListView to display the specified group header.
void	onBindItemViewHolder(ListViewHolder holder, Object entity) Called by RadListView to display the specified item.
void	onBindViewHolder(ListViewHolder holder, int position)
ListViewHolder	onCreateGroupViewHolder(ViewGroup parent, int viewType) Called when RadListView needs a new ListViewHolder of the given type to represent a group header item.
ListViewHolder	onCreateItemViewHolder(ViewGroup parent, int viewType) Called when RadListView needs a new ListViewHolder of the given type to represent an item from the list.
ListViewHolder	onCreateViewHolder(ViewGroup parent, int viewType)
Object	remove(int index) Removes the object at the specified index from the list of items in this ListViewAdapter.
Object	remove(int index, boolean invalidateDescriptors) Removes the object at the specified index from the list of items in this ListViewAdapter.
boolean	remove(Object item) Removes the first occurrence of the specified object from the list of items in this ListViewAdapter.
boolean	remove(Object item, boolean invalidateDescriptors) Removes the first occurrence of the specified object from the list of items in this ListViewAdapter.
void	removeFilterDescriptor(Function<Object,Boolean> filterDescriptor) Removes the specified filter descriptor from the descriptors used by this instance.
void	removeGroupDescriptor(Function<Object,Object> groupDescriptor) Removes the specified group descriptor from the descriptors used by this instance.
void	removeSortDescriptor(Function2<Object,Object,Integer> sortDescriptor) Removes the specified sort descriptor from the descriptors used by this instance.
boolean	reorderItem(int oldPosition, int newPosition) Provides the reorder operation as requested by an ItemReorderBehavior instance.
void	setItems(List items) Sets a new list of items to be handled by this adapter instance.

Methods inherited from class com.telerik.widget.list.ListViewAdapter

canDeselect, getItem, getItemId, getItems, notifyLoadingFinished, notifyRefreshFinished, notifySwipeExecuteFinished, onBindSwipeContentHolder, onCreateSwipeContentHolder

Methods inherited from class android.support.v7.widget.RecyclerView.Adapter

bindViewHolder, createViewHolder, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onAttachedToRecyclerView, onBindViewHolder, onDetachedFromRecyclerView, onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onViewRecycled, registerAdapterDataObserver, setHasStableIds, unregisterAdapterDataObserver

Methods inherited from class java.lang.Object

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

Constructor Detail

ListViewDataSourceAdapter

public ListViewDataSourceAdapter(List items)

Creates an instance of the ListViewDataSourceAdapter class.

Parameters:

items - a list of items that will be handled by this adapter

Method Detail

addGroupDescriptor

public void addGroupDescriptor(Function<Object,Object> groupDescriptor)

Adds a group descriptor that specifies how the items on this list can be grouped. For example, here's how you can group a list of strings by their first letter:

 myAdapter.addGroupDescriptor(new Function <String, Character >() {
        @Override
       public Character apply(String argument) {
         return argument.charAt(0);
       }
    });
 
 

Parameters:

groupDescriptor - the group descriptor to use.

removeGroupDescriptor

public void removeGroupDescriptor(Function<Object,Object> groupDescriptor)

Removes the specified group descriptor from the descriptors used by this instance.

Parameters:

groupDescriptor - the group descriptor to remove.

clearGroupDescriptors

public void clearGroupDescriptors()

Clears the list of group descriptors used by this instance.

addSortDescriptor

public void addSortDescriptor(Function2<Object,Object,Integer> sortDescriptor)

Adds a sort descriptor that specifies how the items on this list can be sorted. For example, here's how you can sort a list of items by the value returned by their getName() method:

 myAdapter.addGroupDescriptor(new Function2 <MyItem, MyItem, Integer >() {
        @Override
       public Integer apply(MyItem argument1, MyItem argument2) {
         return argument1.getName().compareTo(argument2.getName);
       }
    });
 
 

Parameters:

sortDescriptor - the sort descriptor to use.

removeSortDescriptor

public void removeSortDescriptor(Function2<Object,Object,Integer> sortDescriptor)

Removes the specified sort descriptor from the descriptors used by this instance.

Parameters:

sortDescriptor - the sort descriptor to remove.

clearSortDescriptors

public void clearSortDescriptors()

Clears the list of sort descriptors used by this instance.

addFilterDescriptor

public void addFilterDescriptor(Function<Object,Boolean> filterDescriptor)

Adds a filter descriptor that specifies how the items on this list can be filtered. For example, here's how you can filter a list of string to those starting with the letter "s":

 myAdapter.addFilterDescriptor(new Function <String, Boolean >() {
        @Override
       public Boolean apply(String argument) {
         return argument.startsWith("s");
       }
    });
 
 

Parameters:

filterDescriptor - the filter descriptor to use.

removeFilterDescriptor

public void removeFilterDescriptor(Function<Object,Boolean> filterDescriptor)

Removes the specified filter descriptor from the descriptors used by this instance.

Parameters:

filterDescriptor - the filter descriptor to remove.

clearFilterDescriptors

public void clearFilterDescriptors()

Clears the list of filter descriptors used by this instance.

invalidateDescriptors

public void invalidateDescriptors()

Invalidates the descriptors and updates the list with any updates on the list.

add

public void add(Object item)

Description copied from class: ListViewAdapter

Adds the specified item at the end of the items in this ListViewAdapter.

Overrides:

add in class ListViewAdapter

Parameters:

item - the object to add.

add

public void add(Object item,
                boolean invalidateDescriptors)

Adds the specified item at the end of the items in this ListViewAdapter.

Parameters:

item - the object to add.

invalidateDescriptors - specifies whether the descriptors will be invalidated after this change.

add

public void add(int index,
                Object item)

Description copied from class: ListViewAdapter

Inserts the specified object into this ListViewAdapter at the specified index. The object is inserted before the current element at the specified index.

Overrides:

add in class ListViewAdapter

Parameters:

index - the index at which to insert.

item - the object to add.

add

public void add(int index,
                Object item,
                boolean invalidateDescriptors)

Inserts the specified object into this ListViewAdapter at the specified index. The object is inserted before the current element at the specified index.

Parameters:

index - the index at which to insert.

item - the object to add.

invalidateDescriptors - specifies whether the descriptors will be invalidated after this change.

remove

public boolean remove(Object item)

Description copied from class: ListViewAdapter

Removes the first occurrence of the specified object from the list of items in this ListViewAdapter.

Overrides:

remove in class ListViewAdapter

Parameters:

item - the object to remove.

remove

public boolean remove(Object item,
                      boolean invalidateDescriptors)

Removes the first occurrence of the specified object from the list of items in this ListViewAdapter.

Parameters:

item - the object to remove.

invalidateDescriptors - specifies whether the descriptors will be invalidated after this change.

remove

public Object remove(int index)

Description copied from class: ListViewAdapter

Removes the object at the specified index from the list of items in this ListViewAdapter.

Overrides:

remove in class ListViewAdapter

Parameters:

index - the index of the object to remove.

remove

public Object remove(int index,
                     boolean invalidateDescriptors)

Removes the object at the specified index from the list of items in this ListViewAdapter.

Parameters:

index - the index of the object to remove.

invalidateDescriptors - specifies whether the descriptors will be invalidated after this change.

getDataItem

public DataItem getDataItem(int position)

Return the DataItem on the provided position. Returns null if the position exceeds the bounds of the list of items.

Parameters:

position - the position of the data item

Returns:

the item on the specified position or null if not found

isGroupHeader

public boolean isGroupHeader(int position)

Return true if the item at the specified position is a group header and false otherwise.

Parameters:

position - the position of the item

setItems

public void setItems(List items)

Description copied from class: ListViewAdapter

Sets a new list of items to be handled by this adapter instance.

Overrides:

setItems in class ListViewAdapter

See Also:

ListViewAdapter.getItems()

dataChanged

public void dataChanged(DataChangeInfo info)

Specified by:

dataChanged in interface DataChangedListener

getItem

public Object getItem(int position)

Description copied from class: ListViewAdapter

Return the item on the provided position. Returns null if the position exceeds the bounds of the list of items.

Overrides:

getItem in class ListViewAdapter

Parameters:

position - the position of the item

Returns:

the item on the specified position or null if not found

canSwipe

public boolean canSwipe(int position)

Description copied from class: ListViewAdapter

Determines if the item at the provided position can be swiped.

Overrides:

canSwipe in class ListViewAdapter

See Also:

SwipeRefreshBehavior

canSelect

public boolean canSelect(int position)

Description copied from class: ListViewAdapter

Determines if the item at the provided position is selectable.

Overrides:

canSelect in class ListViewAdapter

See Also:

SelectionBehavior

getPosition

public int getPosition(long id)

Description copied from class: ListViewAdapter

Return the position of the item with the provided id. Returns INVALID_ID if an item with that id is not found.

Overrides:

getPosition in class ListViewAdapter

Parameters:

id - the item id to query

Returns:

the position of the item with the provided id

getPosition

public int getPosition(Object searchItem)

Description copied from class: ListViewAdapter

Return the position of the item that is provided. Returns -1 if the item is not found.

Overrides:

getPosition in class ListViewAdapter

Parameters:

searchItem - the item to query

Returns:

the index of the first occurrence of the object or -1 if the object was not found.

canReorder

public boolean canReorder(int position)

Description copied from class: ListViewAdapter

Determines if the item at the provided position can be reordered.

Overrides:

canReorder in class ListViewAdapter

See Also:

ItemReorderBehavior

reorderItem

public boolean reorderItem(int oldPosition,
                           int newPosition)

Description copied from class: ListViewAdapter

Provides the reorder operation as requested by an ItemReorderBehavior instance.

Overrides:

reorderItem in class ListViewAdapter

See Also:

ItemReorderBehavior

getItemId

public long getItemId(int position)

Overrides:

getItemId in class ListViewAdapter

onCreateViewHolder

public final ListViewHolder onCreateViewHolder(ViewGroup parent,
                                               int viewType)

Overrides:

onCreateViewHolder in class ListViewAdapter

onBindViewHolder

public final void onBindViewHolder(ListViewHolder holder,
                                   int position)

Overrides:

onBindViewHolder in class ListViewAdapter

getItemViewType

public final int getItemViewType(int position)

Overrides:

getItemViewType in class RecyclerView.Adapter<ListViewHolder>

getItemViewType

public int getItemViewType(Object item)

Return the view type of provided item for the purposes of view recycling. Please note that the negative values are preserved for view types of the group headers. The default implementation of this method returns 0, making the assumption of a single view type for the adapter. Consider using id resources to uniquely identify item view types.

Parameters:

item - item to query

Returns:

integer value identifying the type of the view needed to represent the item. Type codes need not be contiguous.

See Also:

getGroupViewType(Object)

getGroupViewType

public int getGroupViewType(Object group)

Return the view type of provided group header item for the purposes of view recycling. Please note that the negative values are required for view types of the group headers. The default implementation of this method returns ITEM_VIEW_TYPE_GROUP, making the assumption of a single view type for the headers in this adapter. Consider using id resources to uniquely identify group header item view types.

Parameters:

group - group header to query

Returns:

integer value identifying the type of the view needed to represent the item. Type codes need not be contiguous.

See Also:

getItemViewType(Object)

getItemCount

public final int getItemCount()

Overrides:

getItemCount in class ListViewAdapter

getBaseItemCount

public int getBaseItemCount()

Returns the total number of items handled by the adapter after the data operation are performed. This means that if you are having 10 items and they are grouped in 3 groups, this method will return 10, but the list will display 13 items - 10 for the actual items and 3 for the group headers. For the total number of items (13) use getItemCount().

Returns:

The total number of items in this adapter.

See Also:

getBaseItemCount()

onCreateGroupViewHolder

public ListViewHolder onCreateGroupViewHolder(ViewGroup parent,
                                              int viewType)

Called when RadListView needs a new ListViewHolder of the given type to represent a group header item. The method will be called for negative values of viewType. Note that if the itemView type is negative, the view will be treated like a group header. The new ViewHolder will be used to display items of the adapter using onBindGroupViewHolder(ListViewHolder, Object). Since it will be re-used to display different items in the data set, it is a good idea to cache references to sub views of the View to avoid unnecessary View.findViewById(int) calls.

Parameters:

parent - The ViewGroup into which the new View will be added after it is bound to an adapter position.

viewType - The view type of the new View.

Returns:

A new ViewHolder that holds a View of the given view type.

See Also:

onBindGroupViewHolder(ListViewHolder, Object), onCreateItemViewHolder(android.view.ViewGroup, int)

onBindGroupViewHolder

public void onBindGroupViewHolder(ListViewHolder holder,
                                  Object groupKey)

Called by RadListView to display the specified group header. This method should update the contents of the RecyclerView.ViewHolder.itemView to reflect the given group header item.

Parameters:

holder - The ViewHolder which should be updated to represent the contents of the group key that is provided.

groupKey - The group key that should be bound.

See Also:

onBindItemViewHolder(ListViewHolder, Object), onCreateGroupViewHolder(android.view.ViewGroup, int)

onCreateItemViewHolder

public ListViewHolder onCreateItemViewHolder(ViewGroup parent,
                                             int viewType)

Called when RadListView needs a new ListViewHolder of the given type to represent an item from the list. The method will be called for non-negative values of viewType. Note that if the itemView type is negative, the view will be treated like a group header. The new ViewHolder will be used to display items of the adapter using onBindItemViewHolder(ListViewHolder, Object). Since it will be re-used to display different items in the data set, it is a good idea to cache references to sub views of the View to avoid unnecessary View.findViewById(int) calls.

Parameters:

parent - The ViewGroup into which the new View will be added after it is bound to an adapter position.

viewType - The view type of the new View.

Returns:

A new ViewHolder that holds a View of the given view type.

See Also:

onBindItemViewHolder(ListViewHolder, Object), onCreateGroupViewHolder(android.view.ViewGroup, int)

onBindItemViewHolder

public void onBindItemViewHolder(ListViewHolder holder,
                                 Object entity)

Called by RadListView to display the specified item. This method should update the contents of the RecyclerView.ViewHolder.itemView to reflect the given item.

Parameters:

holder - The ViewHolder which should be updated to represent the contents of the group key that is provided.

entity - The entity that should be bound.

See Also:

onBindGroupViewHolder(ListViewHolder, Object), onCreateItemViewHolder(android.view.ViewGroup, int)

getHeaderPosition

public int getHeaderPosition(int position)