com.mikepenz.fastadapter

Class FastAdapter<Item extends IItem>

java.lang.Object

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

com.mikepenz.fastadapter.FastAdapter<Item>

Direct Known Subclasses:

FastItemAdapter

public class FastAdapter<Item extends IItem>
extends android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Created by mikepenz on 27.12.15.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FastAdapter.OnBindViewHolderListener
class	FastAdapter.OnBindViewHolderListenerImpl
static interface	FastAdapter.OnClickListener<Item extends IItem>
static interface	FastAdapter.OnCreateViewHolderListener
class	FastAdapter.OnCreateViewHolderListenerImpl default implementation of the OnCreateViewHolderListener
static interface	FastAdapter.OnLongClickListener<Item extends IItem>
static interface	FastAdapter.OnTouchListener<Item extends IItem>
static class	FastAdapter.RelativeInfo<Item extends IItem> an internal class to return the IItem and relativePosition and it's adapter at once. used to save one iteration inside the getInternalItem method

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BUNDLE_EXPANDED
protected static java.lang.String	BUNDLE_SELECTIONS

Constructor Summary

Constructors

Constructor and Description
FastAdapter() default CTOR

Method Summary

Modifier and Type	Method and Description
void	collapse() collapses all expanded items
void	collapse(int position) collapses (closes) the given collapsible item at the given position
java.util.List<Item>	deleteAllSelectedItems() deletes all current selected items
void	deselect() deselects all selections
void	deselect(int position) deselects an item and removes it's position in the selections list
void	deselect(java.lang.Iterable<java.lang.Integer> positions) deselects all items at the positions in the iteratable
void	expand(int position) opens the expandable item at the given position
IAdapter<Item>	getAdapter(int position) Gets the adapter for the given position
int[]	getExpandedItems()
Item	getItem(int position) gets the IItem by a position, from all registered adapters
int	getItemCount() calculates the total ItemCount over all registered adapters
int	getItemCount(int order) calculates the item count up to a given (excluding this) order number
long	getItemId(int position) finds the int ItemId from the IItem which exists at the given position
int	getItemViewType(int position) finds the int ItemViewType from the IItem which exists at the given position
int	getPosition(Item item) Searches for the given item and calculates it's global position
FastAdapter.RelativeInfo<Item>	getRelativeInfo(int position) Internal method to get the Item as ItemHolder which comes with the relative position within it's adapter Finds the responsible adapter for the given position
java.util.Set<Item>	getSelectedItems()
java.util.Set<java.lang.Integer>	getSelections()
java.util.Map<java.lang.Integer,Item>	getTypeInstances()
void	notifyAdapterDataSetChanged() wraps notifyDataSetChanged
void	notifyAdapterItemChanged(int position) wraps notifyItemChanged
void	notifyAdapterItemChanged(int position, java.lang.Object payload) wraps notifyItemChanged
void	notifyAdapterItemInserted(int position) wraps notifyItemInserted
void	notifyAdapterItemMoved(int fromPosition, int toPosition) wraps notifyItemMoved
void	notifyAdapterItemRangeChanged(int position, int itemCount) wraps notifyItemRangeChanged
void	notifyAdapterItemRangeChanged(int position, int itemCount, java.lang.Object payload) wraps notifyItemRangeChanged
void	notifyAdapterItemRangeInserted(int position, int itemCount) wraps notifyItemRangeInserted
void	notifyAdapterItemRangeRemoved(int position, int itemCount) wraps notifyItemRangeRemoved
void	notifyAdapterItemRemoved(int position) wraps notifyItemRemoved
void	onBindViewHolder(android.support.v7.widget.RecyclerView.ViewHolder holder, int position) Binds the data to the created ViewHolder and sets the listeners to the holder.itemView
android.support.v7.widget.RecyclerView.ViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType) Creates the ViewHolder by the viewType
<A extends AbstractAdapter<Item>> void	registerAdapter(A adapter) registers an AbstractAdapter which will be hooked into the adapter chain
void	registerTypeInstance(Item item) register a new type into the TypeInstances to be able to efficiently create thew ViewHolders
android.os.Bundle	saveInstanceState(android.os.Bundle savedInstanceState) add the values to the bundle for saveInstanceState
android.os.Bundle	saveInstanceState(android.os.Bundle savedInstanceState, java.lang.String prefix) add the values to the bundle for saveInstanceState
void	select(int position) selects an item and remembers it's position in the selections list
void	select(int position, boolean fireEvent) selects an item and remembers it's position in the selections list
void	select(java.lang.Iterable<java.lang.Integer> positions) selects all items at the positions in the iteratable
void	toggleExpandable(int position) toggles the expanded state of the given expandable item at the given position
void	toggleSelection(int position) toggles the selection of the item at the given position
FastAdapter<Item>	withAllowDeselection(boolean allowDeselection) If false, a user can't deselect an item via click (you can still do this programmatically)
FastAdapter<Item>	withMultiSelect(boolean multiSelect) Enable this if you want multiSelection possible in the list
FastAdapter<Item>	withOnBindViewHolderListener(FastAdapter.OnBindViewHolderListener onBindViewHolderListener) allows you to set an custom OnBindViewHolderListener which is used to bind the view.
FastAdapter<Item>	withOnClickListener(FastAdapter.OnClickListener<Item> onClickListener) Define the OnClickListener which will be used for a single item
FastAdapter<Item>	withOnCreateViewHolderListener(FastAdapter.OnCreateViewHolderListener onCreateViewHolderListener) allows you to set a custom OnCreateViewHolderListener which will be used before and after the ViewHolder is created You may check the OnCreateViewHolderListenerImpl for the default behavior
FastAdapter<Item>	withOnLongClickListener(FastAdapter.OnLongClickListener<Item> onLongClickListener) Define the OnLongClickListener which will be used for a single item
FastAdapter<Item>	withOnPreClickListener(FastAdapter.OnClickListener<Item> OnPreClickListener) Define the OnPreClickListener which will be used for a single item and is called after all internal methods are done
FastAdapter<Item>	withOnPreLongClickListener(FastAdapter.OnLongClickListener<Item> OnPreLongClickListener) Define the OnLongClickListener which will be used for a single item and is called after all internal methods are done
FastAdapter<Item>	withOnTouchListener(FastAdapter.OnTouchListener<Item> onTouchListener) Define the TouchListener which will be used for a single item
FastAdapter<Item>	withSavedInstanceState(android.os.Bundle savedInstanceState) re-selects all elements stored in the savedInstanceState IMPORTANT!
FastAdapter<Item>	withSavedInstanceState(android.os.Bundle savedInstanceState, java.lang.String prefix) re-selects all elements stored in the savedInstanceState IMPORTANT!
FastAdapter<Item>	withSelectOnLongClick(boolean selectOnLongClick) Disable this if you want the selection on a single tap
FastAdapter<Item>	withSelectWithItemUpdate(boolean selectWithItemUpdate) select between the different selection behaviors.

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

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

Field Detail

BUNDLE_SELECTIONS

protected static final java.lang.String BUNDLE_SELECTIONS

See Also:

Constant Field Values

BUNDLE_EXPANDED

protected static final java.lang.String BUNDLE_EXPANDED

See Also:

Constant Field Values

Constructor Detail

FastAdapter

public FastAdapter()

default CTOR

Method Detail

withOnClickListener

public FastAdapter<Item> withOnClickListener(FastAdapter.OnClickListener<Item> onClickListener)

Define the OnClickListener which will be used for a single item

Parameters:

onClickListener - the OnClickListener which will be used for a single item

Returns:

this

withOnPreClickListener

public FastAdapter<Item> withOnPreClickListener(FastAdapter.OnClickListener<Item> OnPreClickListener)

Define the OnPreClickListener which will be used for a single item and is called after all internal methods are done

Parameters:

OnPreClickListener - the OnPreClickListener which will be called after a single item was clicked and all internal methods are done

Returns:

this

withOnLongClickListener

public FastAdapter<Item> withOnLongClickListener(FastAdapter.OnLongClickListener<Item> onLongClickListener)

Define the OnLongClickListener which will be used for a single item

Parameters:

onLongClickListener - the OnLongClickListener which will be used for a single item

Returns:

this

withOnPreLongClickListener

public FastAdapter<Item> withOnPreLongClickListener(FastAdapter.OnLongClickListener<Item> OnPreLongClickListener)

Define the OnLongClickListener which will be used for a single item and is called after all internal methods are done

Parameters:

OnPreLongClickListener - the OnLongClickListener which will be called after a single item was clicked and all internal methods are done

Returns:

this

withOnTouchListener

public FastAdapter<Item> withOnTouchListener(FastAdapter.OnTouchListener<Item> onTouchListener)

Define the TouchListener which will be used for a single item

Parameters:

onTouchListener - the TouchListener which will be used for a single item

Returns:

this

withOnCreateViewHolderListener

public FastAdapter<Item> withOnCreateViewHolderListener(FastAdapter.OnCreateViewHolderListener onCreateViewHolderListener)

allows you to set a custom OnCreateViewHolderListener which will be used before and after the ViewHolder is created You may check the OnCreateViewHolderListenerImpl for the default behavior

Parameters:

onCreateViewHolderListener - the OnCreateViewHolderListener (you may use the OnCreateViewHolderListenerImpl)

withOnBindViewHolderListener

public FastAdapter<Item> withOnBindViewHolderListener(FastAdapter.OnBindViewHolderListener onBindViewHolderListener)

allows you to set an custom OnBindViewHolderListener which is used to bind the view. This will overwrite the libraries behavior. You may check the OnBindViewHolderListenerImpl for the default behavior

Parameters:

onBindViewHolderListener - the OnBindViewHolderListener

withSelectWithItemUpdate

public FastAdapter<Item> withSelectWithItemUpdate(boolean selectWithItemUpdate)

select between the different selection behaviors. there are now 2 different variants of selection. you can toggle this via `withSelectWithItemUpdate(boolean)` (where false == default - variant 1) 1.) direct selection via the view "selected" state, we also make sure we do not animate here so no notifyItemChanged is called if we repeatly press the same item 2.) we select the items via a notifyItemChanged. this will allow custom selected logics within your views (isSelected() - do something...) and it will also animate the change via the provided itemAnimator. because of the animation of the itemAnimator the selection will have a small delay (time of animating)

Parameters:

selectWithItemUpdate - true if notifyItemChanged should be called upon select

Returns:

this

withMultiSelect

public FastAdapter<Item> withMultiSelect(boolean multiSelect)

Enable this if you want multiSelection possible in the list

Parameters:

multiSelect - true to enable multiSelect

Returns:

this

withSelectOnLongClick

public FastAdapter<Item> withSelectOnLongClick(boolean selectOnLongClick)

Disable this if you want the selection on a single tap

Parameters:

selectOnLongClick - false to do select via single click

Returns:

this

withAllowDeselection

public FastAdapter<Item> withAllowDeselection(boolean allowDeselection)

If false, a user can't deselect an item via click (you can still do this programmatically)

Parameters:

allowDeselection - true if a user can deselect an already selected item via click

Returns:

this

withSavedInstanceState

public FastAdapter<Item> withSavedInstanceState(android.os.Bundle savedInstanceState)

re-selects all elements stored in the savedInstanceState IMPORTANT! Call this method only after all items where added to the adapters again. Otherwise it may select wrong items!

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

Returns:

this

withSavedInstanceState

public FastAdapter<Item> withSavedInstanceState(android.os.Bundle savedInstanceState,
                                                java.lang.String prefix)

re-selects all elements stored in the savedInstanceState IMPORTANT! Call this method only after all items where added to the adapters again. Otherwise it may select wrong items!

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

prefix - a prefix added to the savedInstance key so we can store multiple states

Returns:

this

registerAdapter

public <A extends AbstractAdapter<Item>> void registerAdapter(A adapter)

registers an AbstractAdapter which will be hooked into the adapter chain

Parameters:

adapter - an adapter which extends the AbstractAdapter

registerTypeInstance

public void registerTypeInstance(Item item)

register a new type into the TypeInstances to be able to efficiently create thew ViewHolders

Parameters:

item - an IItem which will be shown in the list

getTypeInstances

public java.util.Map<java.lang.Integer,Item> getTypeInstances()

Returns:

all typeInstances remembered within the FastAdapter

onCreateViewHolder

public android.support.v7.widget.RecyclerView.ViewHolder onCreateViewHolder(android.view.ViewGroup parent,
                                                                            int viewType)

Creates the ViewHolder by the viewType

Specified by:

onCreateViewHolder in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

parent - the parent view (the RecyclerView)

viewType - the current viewType which is bound

Returns:

the ViewHolder with the bound data

onBindViewHolder

public void onBindViewHolder(android.support.v7.widget.RecyclerView.ViewHolder holder,
                             int position)

Binds the data to the created ViewHolder and sets the listeners to the holder.itemView

Specified by:

onBindViewHolder in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder - the viewHolder we bind the data on

position - the global position

getPosition

public int getPosition(Item item)

Searches for the given item and calculates it's global position

Parameters:

item - the item which is searched for

Returns:

the global position, or -1 if not found

getItem

public Item getItem(int position)

gets the IItem by a position, from all registered adapters

Parameters:

position - the global position

Returns:

the found IItem or null

getRelativeInfo

public FastAdapter.RelativeInfo<Item> getRelativeInfo(int position)

Internal method to get the Item as ItemHolder which comes with the relative position within it's adapter Finds the responsible adapter for the given position

Parameters:

position - the global position

Returns:

the adapter which is responsible for this position

getAdapter

public IAdapter<Item> getAdapter(int position)

Gets the adapter for the given position

Parameters:

position - the global position

Returns:

the adapter responsible for this global position

getItemViewType

public int getItemViewType(int position)

finds the int ItemViewType from the IItem which exists at the given position

Overrides:

getItemViewType in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

position - the global position

Returns:

the viewType for this position

getItemId

public long getItemId(int position)

finds the int ItemId from the IItem which exists at the given position

Overrides:

getItemId in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

position - the global position

Returns:

the itemId for this position

getItemCount

public int getItemCount()

calculates the total ItemCount over all registered adapters

Specified by:

getItemCount in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

the global count

getItemCount

public int getItemCount(int order)

calculates the item count up to a given (excluding this) order number

Parameters:

order - the number up to which the items are counted

Returns:

the total count of items up to the adapter order

saveInstanceState

public android.os.Bundle saveInstanceState(android.os.Bundle savedInstanceState)

add the values to the bundle for saveInstanceState

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

Returns:

the passed bundle with the newly added data

saveInstanceState

public android.os.Bundle saveInstanceState(android.os.Bundle savedInstanceState,
                                           java.lang.String prefix)

add the values to the bundle for saveInstanceState

Parameters:

savedInstanceState - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in Note: Otherwise it is null.

prefix - a prefix added to the savedInstance key so we can store multiple states

Returns:

the passed bundle with the newly added data

getSelections

public java.util.Set<java.lang.Integer> getSelections()

Returns:

a set with the global positions of all selected items

getSelectedItems

public java.util.Set<Item> getSelectedItems()

Returns:

a set with the items which are currently selected

toggleSelection

public void toggleSelection(int position)

toggles the selection of the item at the given position

Parameters:

position - the global position

select

public void select(java.lang.Iterable<java.lang.Integer> positions)

selects all items at the positions in the iteratable

Parameters:

positions - the global positions to select

select

public void select(int position)

selects an item and remembers it's position in the selections list

Parameters:

position - the global position

select

public void select(int position,
                   boolean fireEvent)

selects an item and remembers it's position in the selections list

Parameters:

position - the global position

fireEvent - true if the onClick listener should be called

deselect

public void deselect()

deselects all selections

deselect

public void deselect(java.lang.Iterable<java.lang.Integer> positions)

deselects all items at the positions in the iteratable

Parameters:

positions - the global positions to deselect

deselect

public void deselect(int position)

deselects an item and removes it's position in the selections list

Parameters:

position - the global position

deleteAllSelectedItems

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

deletes all current selected items

Returns:

a list of the IItem elements which were deleted

getExpandedItems

public int[] getExpandedItems()

Returns:

a set with the global positions of all expanded items

toggleExpandable

public void toggleExpandable(int position)

toggles the expanded state of the given expandable item at the given position

Parameters:

position - the global position

collapse

public void collapse()

collapses all expanded items

collapse

public void collapse(int position)

collapses (closes) the given collapsible item at the given position

Parameters:

position - the global position

expand

public void expand(int position)

opens the expandable item at the given position

Parameters:

position - the global position

notifyAdapterDataSetChanged

public void notifyAdapterDataSetChanged()

wraps notifyDataSetChanged

notifyAdapterItemInserted

public void notifyAdapterItemInserted(int position)

wraps notifyItemInserted

Parameters:

position - the global position

notifyAdapterItemRangeInserted

public void notifyAdapterItemRangeInserted(int position,
                                           int itemCount)

wraps notifyItemRangeInserted

Parameters:

position - the global position

itemCount - the count of items inserted

notifyAdapterItemRemoved

public void notifyAdapterItemRemoved(int position)

wraps notifyItemRemoved

Parameters:

position - the global position

notifyAdapterItemRangeRemoved

public void notifyAdapterItemRangeRemoved(int position,
                                          int itemCount)

wraps notifyItemRangeRemoved

Parameters:

position - the global position

itemCount - the count of items removed

notifyAdapterItemMoved

public void notifyAdapterItemMoved(int fromPosition,
                                   int toPosition)

wraps notifyItemMoved

Parameters:

fromPosition - the global fromPosition

toPosition - the global toPosition

notifyAdapterItemChanged

public void notifyAdapterItemChanged(int position)

wraps notifyItemChanged

Parameters:

position - the global position

notifyAdapterItemChanged

public void notifyAdapterItemChanged(int position,
                                     java.lang.Object payload)

wraps notifyItemChanged

Parameters:

position - the global position

payload - additional payload

notifyAdapterItemRangeChanged

public void notifyAdapterItemRangeChanged(int position,
                                          int itemCount)

wraps notifyItemRangeChanged

Parameters:

position - the global position

itemCount - the count of items changed

notifyAdapterItemRangeChanged

public void notifyAdapterItemRangeChanged(int position,
                                          int itemCount,
                                          java.lang.Object payload)

wraps notifyItemRangeChanged

Parameters:

position - the global position

itemCount - the count of items changed

payload - an additional payload