com.mikepenz.fastadapter.adapters

Class ItemAdapter<Item extends IItem>

java.lang.Object

android.support.v7.widget.RecyclerView.Adapter

com.mikepenz.fastadapter.AbstractAdapter<Item>

com.mikepenz.fastadapter.adapters.ItemAdapter<Item>

All Implemented Interfaces:

IAdapter<Item>, IItemAdapter<Item>

Direct Known Subclasses:

FooterAdapter, GenericItemAdapter, HeaderAdapter

public class ItemAdapter<Item extends IItem>
extends AbstractAdapter<Item>
implements IItemAdapter<Item>

Created by mikepenz on 27.12.15. A general ItemAdapter implementation based on the AbstractAdapter to speed up development for general items This adapter has the order of 500 which is the centered order

Nested Class Summary

Nested classes/interfaces inherited from interface com.mikepenz.fastadapter.IItemAdapter

IItemAdapter.Predicate<Item extends IItem>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Comparator<Item>	mComparator

Constructor Summary

Constructors

Constructor and Description
ItemAdapter()

Method Summary

Modifier and Type	Method and Description
ItemAdapter<Item>	add(int position, Item... items) add an array of items at the given position within the existing items
ItemAdapter<Item>	add(int position, java.util.List<Item> items) add a list of items at the given position within the existing items
ItemAdapter<Item>	add(Item... items) add an array of items to the end of the existing items
ItemAdapter<Item>	add(java.util.List<Item> items) add a list of items to the end of the existing items
ItemAdapter<Item>	clear() removes all items of this adapter
void	filter(java.lang.CharSequence constraint) filters the items with the constraint using the provided Predicate
Item	getAdapterItem(int position)
int	getAdapterItemCount() defines the count of items of THIS adapter
java.util.List<Item>	getAdapterItems()
int	getAdapterPosition(Item item) Searches for the given item and calculates its relative position
int	getAdapterPosition(long identifier) Searches for the given identifier and calculates its relative position
java.util.Comparator<Item>	getComparator()
int	getGlobalPosition(int position) returns the global position if the relative position within this adapter was given
ItemFilter<Item>	getItemFilter()
int	getOrder() defines in which order this adapter should be hooked into the FastAdapter
boolean	isUseIdDistributor()
ItemAdapter<Item>	move(int fromPosition, int toPosition) moves an item within the list from a position to a position
void	remapMappedTypes() forces to remap all possible types for the RecyclerView
ItemAdapter<Item>	remove(int position) removes an item at the given position within the existing icons
ItemAdapter<Item>	removeRange(int position, int itemCount) removes a range of items starting with the given position within the existing icons
ItemAdapter<Item>	set(int position, Item item) sets an item at the given position, overwriting the previous item
ItemAdapter<Item>	set(java.util.List<Item> items) set a new list of items and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter NOTE this will not sort
protected ItemAdapter<Item>	set(java.util.List<Item> items, boolean resetFilter)
ItemAdapter<Item>	setNewList(java.util.List<Item> items) sets a complete new list of items onto this adapter, using the new list.
ItemAdapter<Item>	setNewList(java.util.List<Item> items, boolean retainFilter) sets a complete new list of items onto this adapter, using the new list.
<T extends IItem & IExpandable<T,S>,S extends IItem & ISubItem<Item,T>> T	setSubItems(T collapsible, java.util.List<S> subItems) sets the subItems of the given collapsible This method also makes sure identifiers are set if we use the IdDistributor
ItemAdapter<Item>	withComparator(java.util.Comparator<Item> comparator) define a comparator which will be used to sort the list "everytime" it is altered NOTE this will only sort if you "set" a new list or "add" new items (not if you provide a position for the add function)
ItemAdapter<Item>	withComparator(java.util.Comparator<Item> comparator, boolean sortNow) define a comparator which will be used to sort the list "everytime" it is altered NOTE this will only sort if you "set" a new list or "add" new items (not if you provide a position for the add function)
ItemAdapter<Item>	withItemFilter(ItemFilter<Item> itemFilter) allows you to define your own Filter implementation instead of the default `ItemFilter`
ItemAdapter	withUseIdDistributor(boolean useIdDistributor) defines if the IdDistributor is used to provide an ID to all added items which do not yet define an id

Methods inherited from class com.mikepenz.fastadapter.AbstractAdapter

clearMappedTypes, getFastAdapter, getItem, getItemCount, getItemId, getItemViewType, mapPossibleType, mapPossibleTypes, onAttachedToRecyclerView, onBindViewHolder, onBindViewHolder, onCreateViewHolder, onDetachedFromRecyclerView, onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onViewRecycled, registerAdapterDataObserver, setHasStableIds, unregisterAdapterDataObserver, wrap, wrap

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

bindViewHolder, createViewHolder, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mikepenz.fastadapter.IAdapter

getFastAdapter, getItem, getItemCount

Field Detail

mComparator

protected java.util.Comparator<Item extends IItem> mComparator

Constructor Detail

ItemAdapter

public ItemAdapter()

Method Detail

withUseIdDistributor

public ItemAdapter withUseIdDistributor(boolean useIdDistributor)

defines if the IdDistributor is used to provide an ID to all added items which do not yet define an id

Parameters:

useIdDistributor - false if the IdDistributor shouldn't be used

Returns:

this

isUseIdDistributor

public boolean isUseIdDistributor()

Returns:

if we use the idDistributor with this adapter

withItemFilter

public ItemAdapter<Item> withItemFilter(@NonNull
                                        ItemFilter<Item> itemFilter)

allows you to define your own Filter implementation instead of the default `ItemFilter`

Parameters:

itemFilter - the filter to use

Returns:

this

getItemFilter

@NonNull
public ItemFilter<Item> getItemFilter()

Returns:

the filter used to filter items

filter

public void filter(@Nullable
                   java.lang.CharSequence constraint)

filters the items with the constraint using the provided Predicate

Parameters:

constraint - the string used to filter the list

withComparator

public ItemAdapter<Item> withComparator(java.util.Comparator<Item> comparator)

define a comparator which will be used to sort the list "everytime" it is altered NOTE this will only sort if you "set" a new list or "add" new items (not if you provide a position for the add function)

Parameters:

comparator - used to sort the list

Returns:

this

withComparator

public ItemAdapter<Item> withComparator(java.util.Comparator<Item> comparator,
                                        boolean sortNow)

define a comparator which will be used to sort the list "everytime" it is altered NOTE this will only sort if you "set" a new list or "add" new items (not if you provide a position for the add function)

Parameters:

comparator - used to sort the list

sortNow - specifies if we use the provided comparator to sort now

Returns:

this

getComparator

public java.util.Comparator<Item> getComparator()

Returns:

the defined Comparator used for this ItemAdaper

getOrder

public int getOrder()

Description copied from interface: IAdapter

defines in which order this adapter should be hooked into the FastAdapter

Specified by:

getOrder in interface IAdapter<Item extends IItem>

Returns:

the order of the items within the FastAdapter

getAdapterItemCount

public int getAdapterItemCount()

Description copied from interface: IAdapter

defines the count of items of THIS adapter

Specified by:

getAdapterItemCount in interface IAdapter<Item extends IItem>

Returns:

the count of items within this adapter

getAdapterItems

public java.util.List<Item> getAdapterItems()

Specified by:

getAdapterItems in interface IAdapter<Item extends IItem>

Returns:

the items within this adapter

getAdapterPosition

public int getAdapterPosition(Item item)

Searches for the given item and calculates its relative position

Specified by:

getAdapterPosition in interface IAdapter<Item extends IItem>

Parameters:

item - the item which is searched for

Returns:

the relative position

getAdapterPosition

public int getAdapterPosition(long identifier)

Searches for the given identifier and calculates its relative position

Specified by:

getAdapterPosition in interface IAdapter<Item extends IItem>

Parameters:

identifier - the identifier of an item which is searched for

Returns:

the relative position

getGlobalPosition

public int getGlobalPosition(int position)

returns the global position if the relative position within this adapter was given

Specified by:

getGlobalPosition in interface IAdapter<Item extends IItem>

Parameters:

position - the relative position

Returns:

the global position

getAdapterItem

public Item getAdapterItem(int position)

Specified by:

getAdapterItem in interface IAdapter<Item extends IItem>

Parameters:

position - the relative position

Returns:

the item inside this adapter

setSubItems

public <T extends IItem & IExpandable<T,S>,S extends IItem & ISubItem<Item,T>> T setSubItems(T collapsible,
                                                                                             java.util.List<S> subItems)

sets the subItems of the given collapsible This method also makes sure identifiers are set if we use the IdDistributor

Specified by:

setSubItems in interface IItemAdapter<Item extends IItem>

Parameters:

collapsible - the collapsible which gets the subItems set

subItems - the subItems for this collapsible item

Returns:

the item type of the collapsible

set

public ItemAdapter<Item> set(java.util.List<Item> items)

set a new list of items and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter NOTE this will not sort

Specified by:

set in interface IItemAdapter<Item extends IItem>

Parameters:

items - the items to set

set

protected ItemAdapter<Item> set(java.util.List<Item> items,
                                boolean resetFilter)

setNewList

public ItemAdapter<Item> setNewList(java.util.List<Item> items)

sets a complete new list of items onto this adapter, using the new list. Calls notifyDataSetChanged

Specified by:

setNewList in interface IItemAdapter<Item extends IItem>

Parameters:

items - the new items to set

setNewList

public ItemAdapter<Item> setNewList(java.util.List<Item> items,
                                    boolean retainFilter)

sets a complete new list of items onto this adapter, using the new list. Calls notifyDataSetChanged

Parameters:

items - the new items to set

retainFilter - set to true if you want to keep the filter applied

Returns:

this

remapMappedTypes

public void remapMappedTypes()

forces to remap all possible types for the RecyclerView

add

@SafeVarargs
public final ItemAdapter<Item> add(Item... items)

add an array of items to the end of the existing items

Specified by:

add in interface IItemAdapter<Item extends IItem>

Parameters:

items - the items to add

add

public ItemAdapter<Item> add(java.util.List<Item> items)

add a list of items to the end of the existing items

Specified by:

add in interface IItemAdapter<Item extends IItem>

Parameters:

items - the items to add

add

@SafeVarargs
public final ItemAdapter<Item> add(int position,
                                                Item... items)

add an array of items at the given position within the existing items

Specified by:

add in interface IItemAdapter<Item extends IItem>

Parameters:

position - the global position

items - the items to add

add

public ItemAdapter<Item> add(int position,
                             java.util.List<Item> items)

add a list of items at the given position within the existing items

Specified by:

add in interface IItemAdapter<Item extends IItem>

Parameters:

position - the global position

items - the items to add

set

public ItemAdapter<Item> set(int position,
                             Item item)

sets an item at the given position, overwriting the previous item

Specified by:

set in interface IItemAdapter<Item extends IItem>

Parameters:

position - the global position

item - the item to set

move

public ItemAdapter<Item> move(int fromPosition,
                              int toPosition)

moves an item within the list from a position to a position

Parameters:

fromPosition - the position global from which we want to move

toPosition - the global position to which to move

Returns:

this

remove

public ItemAdapter<Item> remove(int position)

removes an item at the given position within the existing icons

Specified by:

remove in interface IItemAdapter<Item extends IItem>

Parameters:

position - the global position

removeRange

public ItemAdapter<Item> removeRange(int position,
                                     int itemCount)

removes a range of items starting with the given position within the existing icons

Specified by:

removeRange in interface IItemAdapter<Item extends IItem>

Parameters:

position - the global position

itemCount - the count of items which were removed

clear

public ItemAdapter<Item> clear()

removes all items of this adapter

Specified by:

clear in interface IItemAdapter<Item extends IItem>