com.mikepenz.fastadapter

Class FastAdapter<Item extends IItem>

java.lang.Object

<any>

com.mikepenz.fastadapter.FastAdapter<Item>

Type Parameters:

Item - Defines the type of items this `FastAdapter` manages (in case of multiple different types, use `IItem`)

public class FastAdapter<Item extends IItem>
extends <any>

The `FastAdapter` class is the core managing class of the `FastAdapter` library, it handles all `IAdapter` implementations, keeps track of the item types which can be displayed and correctly provides the size and position and identifier information to the RecyclerView.

It also comes with IAdapterExtension allowing to further modify its behaviour. Additionally it allows to attach various different listener's, and also EventHooks on per item and view basis.

See the sample application for more details

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FastAdapter.RelativeInfo<Item extends IItem> an internal class to return the IItem and relativePosition and its adapter at once.
static class	FastAdapter.ViewHolder<Item extends IItem> A ViewHolder provided from the FastAdapter to allow handling the important event's within the ViewHolder instead of the item

Constructor Summary

Constructors

Constructor and Description
FastAdapter() default CTOR

Method Summary

Modifier and Type	Method and Description
IAdapter<Item>	adapter(int order) Tries to get an adapter by a specific order
<A extends IAdapter<Item>> FastAdapter<Item>	addAdapter(int index, A adapter) add's a new adapter at the specific position
<E extends IAdapterExtension<Item>> FastAdapter<Item>	addExtension(E extension)
protected void	cacheSizes() we cache the sizes of our adapters so get accesses are faster
void	clearTypeInstance() clears the internal mapper - be sure, to remap everything before going on
java.util.List<Item>	deleteAllSelectedItems() Deprecated. deprecated in favor of SelectExtension.deleteAllSelectedItems(), Retrieve it via getExtension(Class)
void	deselect() Deprecated. deprecated in favor of SelectExtension.deselect() , Retrieve it via getExtension(Class)
void	deselect(int position) Deprecated. deprecated in favor of SelectExtension.deselect(int) , Retrieve it via getExtension(Class)
void	deselect(int position, java.util.Iterator<java.lang.Integer> entries) Deprecated. deprecated in favor of SelectExtension.deselect(int, Iterator), Retrieve it via getExtension(Class)
void	deselect(java.lang.Iterable<java.lang.Integer> positions) Deprecated. deprecated in favor of SelectExtension.deselect(Iterable) , Retrieve it via getExtension(Class)
FastAdapter<Item>	enableVerboseLog() enables the verbose log for the adapter
IAdapter<Item>	getAdapter(int position) Gets the adapter for the given position
java.util.List<EventHook<Item>>	getEventHooks()
<T extends IAdapterExtension<Item>> T	getExtension(java.lang.Class<? super T> clazz)
java.util.Collection<IAdapterExtension<Item>>	getExtensions()
static <Item extends IItem> Item	getHolderAdapterItem(RecyclerView.ViewHolder holder) convenient helper method to get the Item from a holder
static <Item extends IItem> Item	getHolderAdapterItem(RecyclerView.ViewHolder holder, int position) convenient helper method to get the Item from a holder
static <Item extends IItem> Item	getHolderAdapterItemTag(RecyclerView.ViewHolder holder) convenient helper method to get the Item from a holder via the defined tag
int	getHolderAdapterPosition(RecyclerView.ViewHolder holder) helper method to get the position from a holder overwrite this if you have an adapter adding additional items inbetwean
Item	getItem(int position) gets the IItem by a position, from all registered adapters
<any>	getItemById(long identifier) gets the IItem given an identifier, from all registered adapters
int	getItemCount() calculates the total ItemCount over all registered adapters
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
OnClickListener<Item>	getOnClickListener()
int	getPosition(Item item) Searches for the given item and calculates its global position
int	getPosition(long identifier) Searches for the given item and calculates its global position
int	getPreItemCount(int position) calculates the item count up to a given (excluding this) adapter (defined by the global position of the item)
int	getPreItemCountByOrder(int order) calculates the item count up to a given (excluding this) order number
FastAdapter.RelativeInfo<Item>	getRelativeInfo(int position) Internal method to get the Item as ItemHolder which comes with the relative position within its adapter Finds the responsible adapter for the given position
java.util.Set<Item>	getSelectedItems() Deprecated. deprecated in favor of SelectExtension.getSelectedItems() , Retrieve it via getExtension(Class)
SelectExtension<Item>	getSelectExtension() Deprecated. deprecated in favor of getExtension(Class)
java.util.Set<java.lang.Integer>	getSelections() Deprecated. deprecated in favor of SelectExtension.getSelections() , Retrieve it via getExtension(Class)
Item	getTypeInstance(int type) gets the TypeInstance remembered within the FastAdapter for an item
ITypeInstanceCache<Item>	getTypeInstanceCache()
ClickEventHook<Item>	getViewClickListener()
LongClickEventHook<Item>	getViewLongClickListener()
TouchEventHook<Item>	getViewTouchListener()
boolean	isSelectable()
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	onAttachedToRecyclerView(RecyclerView recyclerView)
void	onBindViewHolder(RecyclerView.ViewHolder holder, int position) Binds the data to the created ViewHolder and sets the listeners to the holder.itemView Note that you should use the `onBindViewHolder(RecyclerView.ViewHolder holder, int position, List payloads` as it allows you to implement a more efficient adapter implementation
void	onBindViewHolder(RecyclerView.ViewHolder holder, int position, java.util.List<java.lang.Object> payloads) Binds the data to the created ViewHolder and sets the listeners to the holder.itemView
RecyclerView.ViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType) Creates the ViewHolder by the viewType
void	onDetachedFromRecyclerView(RecyclerView recyclerView)
boolean	onFailedToRecycleView(RecyclerView.ViewHolder holder) is called when the ViewHolder is in a transient state.
void	onViewAttachedToWindow(RecyclerView.ViewHolder holder) is called in onViewAttachedToWindow when the view is detached from the window
void	onViewDetachedFromWindow(RecyclerView.ViewHolder holder) is called in onViewDetachedFromWindow when the view is detached from the window
void	onViewRecycled(RecyclerView.ViewHolder holder) Unbinds the data to the already existing ViewHolder and removes the listeners from the holder.itemView
Triple<java.lang.Boolean,Item,java.lang.Integer>	recursive(AdapterPredicate<Item> predicate, boolean stopOnMatch) util function which recursively iterates over all items and subItems of the given adapter.
Triple<java.lang.Boolean,Item,java.lang.Integer>	recursive(AdapterPredicate<Item> predicate, int globalStartPosition, boolean stopOnMatch) util function which recursively iterates over all items and subItems of the given adapter.
static <Item extends IItem> Triple<java.lang.Boolean,Item,java.lang.Integer>	recursiveSub(IAdapter<Item> lastParentAdapter, int lastParentPosition, IExpandable parent, AdapterPredicate<Item> predicate, boolean stopOnMatch) Util function which recursively iterates over all items of a `IExpandable` parent if and only if it is `expanded` and has `subItems` This is usually only used in
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() Deprecated. deprecated in favor of SelectExtension.select() , Retrieve it via getExtension(Class)
void	select(boolean considerSelectableFlag) Deprecated. deprecated in favor of SelectExtension.select(boolean) , Retrieve it via getExtension(Class)
void	select(int position) Deprecated. deprecated in favor of SelectExtension.select(int), Retrieve it via getExtension(Class)
void	select(int position, boolean fireEvent) Deprecated. deprecated in favor of SelectExtension.select(int, boolean) , Retrieve it via getExtension(Class)
void	select(int position, boolean fireEvent, boolean considerSelectableFlag) Deprecated. deprecated in favor of SelectExtension.select(int, boolean, boolean) , Retrieve it via getExtension(Class)
void	select(java.lang.Iterable<java.lang.Integer> positions) Deprecated. deprecated in favor of SelectExtension.select(Iterable) , Retrieve it via getExtension(Class)
void	setTypeInstanceCache(ITypeInstanceCache<Item> mTypeInstanceCache) Sets an type instance cache to this fast adapter instance.
void	toggleSelection(int position) Deprecated. deprecated in favor of SelectExtension.toggleSelection(int) , Retrieve it via getExtension(Class)
static <Item extends IItem,A extends IAdapter> FastAdapter<Item>	with(A adapter) creates a new FastAdapter with the provided adapters if adapters is null, a default ItemAdapter is defined
static <Item extends IItem,A extends IAdapter> FastAdapter<Item>	with(java.util.Collection<A> adapters) creates a new FastAdapter with the provided adapters if adapters is null, a default ItemAdapter is defined
static <Item extends IItem,A extends IAdapter> FastAdapter<Item>	with(java.util.Collection<A> adapters, java.util.Collection<IAdapterExtension<Item>> extensions) creates a new FastAdapter with the provided adapters if adapters is null, a default ItemAdapter is defined
FastAdapter<Item>	withAllowDeselection(boolean allowDeselection) If false, a user can't deselect an item via click (you can still do this programmatically)
FastAdapter<Item>	withAttachDefaultListeners(boolean mAttachDefaultListeners) if set to `false` will not attach any listeners to the list.
FastAdapter<Item>	withEventHook(EventHook<Item> eventHook) adds a new event hook for an item NOTE: this has to be called before adding the first items, as this won't be called anymore after the ViewHolders were created
FastAdapter<Item>	withEventHooks(java.util.Collection<? extends EventHook<Item>> eventHooks) adds new event hooks for an item NOTE: this has to be called before adding the first items, as this won't be called anymore after the ViewHolders were created
FastAdapter<Item>	withItemEvent(EventHook<Item> eventHook) Deprecated. please use `withEventHook`
FastAdapter<Item>	withLegacyBindViewMode(boolean legacyBindViewMode) set to true if you want the FastAdapter to forward all calls from onBindViewHolder(final RecyclerView.ViewHolder holder, int position) to onBindViewHolder(final RecyclerView.ViewHolder holder, int position, List payloads)
FastAdapter<Item>	withMultiSelect(boolean multiSelect) Enable this if you want multiSelection possible in the list
FastAdapter<Item>	withOnBindViewHolderListener(OnBindViewHolderListener onBindViewHolderListener) allows you to set an custom OnBindViewHolderListener which is used to bind the view.
FastAdapter<Item>	withOnClickListener(OnClickListener<Item> onClickListener) Define the OnClickListener which will be used for a single item
FastAdapter<Item>	withOnCreateViewHolderListener(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(OnLongClickListener<Item> onLongClickListener) Define the OnLongClickListener which will be used for a single item
FastAdapter<Item>	withOnPreClickListener(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(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(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! Call this method only after all items where added to the adapters again.
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.
FastAdapter<Item>	withSelectable(boolean selectable) set if no item is selectable
FastAdapter<Item>	withSelectionListener(ISelectionListener<Item> selectionListener) set a listener that get's notified whenever an item is selected or deselected
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 java.lang.Object

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

Constructor Detail

FastAdapter

public FastAdapter()

default CTOR

Method Detail

enableVerboseLog

public FastAdapter<Item> enableVerboseLog()

enables the verbose log for the adapter

Returns:

this

setTypeInstanceCache

public void setTypeInstanceCache(ITypeInstanceCache<Item> mTypeInstanceCache)

Sets an type instance cache to this fast adapter instance. The cache will manage the type instances to create new views more efficient. Normally an shared cache is used over all adapter instances.

Parameters:

mTypeInstanceCache - a custom `TypeInstanceCache` implementation

getTypeInstanceCache

public ITypeInstanceCache<Item> getTypeInstanceCache()

Returns:

the current type instance cache

with

public static <Item extends IItem,A extends IAdapter> FastAdapter<Item> with(A adapter)

creates a new FastAdapter with the provided adapters if adapters is null, a default ItemAdapter is defined

Parameters:

adapter - the adapters which this FastAdapter should use

Returns:

a new FastAdapter

with

public static <Item extends IItem,A extends IAdapter> FastAdapter<Item> with(java.util.Collection<A> adapters)

creates a new FastAdapter with the provided adapters if adapters is null, a default ItemAdapter is defined

Parameters:

adapters - the adapters which this FastAdapter should use

Returns:

a new FastAdapter

with

public static <Item extends IItem,A extends IAdapter> FastAdapter<Item> with(java.util.Collection<A> adapters,
                                                                             java.util.Collection<IAdapterExtension<Item>> extensions)

creates a new FastAdapter with the provided adapters if adapters is null, a default ItemAdapter is defined

Parameters:

adapters - the adapters which this FastAdapter should use

Returns:

a new FastAdapter

addAdapter

public <A extends IAdapter<Item>> FastAdapter<Item> addAdapter(int index,
                                                               A adapter)

add's a new adapter at the specific position

Parameters:

index - the index where the new adapter should be added

adapter - the new adapter to be added

Returns:

this

adapter

public IAdapter<Item> adapter(int order)

Tries to get an adapter by a specific order

Parameters:

order - the order (position) to search the adapter at

Returns:

the IAdapter if found

addExtension

public <E extends IAdapterExtension<Item>> FastAdapter<Item> addExtension(E extension)

Parameters:

extension -

Returns:

getExtensions

public java.util.Collection<IAdapterExtension<Item>> getExtensions()

Returns:

the AdapterExtensions we provided

getExtension

public <T extends IAdapterExtension<Item>> T getExtension(java.lang.Class<? super T> clazz)

Parameters:

clazz - the extension class, to retrieve its instance

Returns:

the found IAdapterExtension or null if it is not found

withItemEvent

@Deprecated
public FastAdapter<Item> withItemEvent(EventHook<Item> eventHook)

Deprecated. please use `withEventHook`

adds a new event hook for an item NOTE: this has to be called before adding the first items, as this won't be called anymore after the ViewHolders were created

Parameters:

eventHook - the event hook to be added for an item

Returns:

this

getEventHooks

public java.util.List<EventHook<Item>> getEventHooks()

Returns:

the eventHooks handled by this FastAdapter

withEventHook

public FastAdapter<Item> withEventHook(EventHook<Item> eventHook)

adds a new event hook for an item NOTE: this has to be called before adding the first items, as this won't be called anymore after the ViewHolders were created

Parameters:

eventHook - the event hook to be added for an item

Returns:

this

withEventHooks

public FastAdapter<Item> withEventHooks(java.util.Collection<? extends EventHook<Item>> eventHooks)

adds new event hooks for an item NOTE: this has to be called before adding the first items, as this won't be called anymore after the ViewHolders were created

Parameters:

eventHooks - the event hooks to be added for an item

Returns:

this

withOnClickListener

public FastAdapter<Item> withOnClickListener(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

getOnClickListener

public OnClickListener<Item> getOnClickListener()

Returns:

the set OnClickListener

withOnPreClickListener

public FastAdapter<Item> withOnPreClickListener(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(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(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(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(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(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

withSelectable

public FastAdapter<Item> withSelectable(boolean selectable)

set if no item is selectable

Parameters:

selectable - true if items are selectable

Returns:

this

withLegacyBindViewMode

public FastAdapter<Item> withLegacyBindViewMode(boolean legacyBindViewMode)

set to true if you want the FastAdapter to forward all calls from onBindViewHolder(final RecyclerView.ViewHolder holder, int position) to onBindViewHolder(final RecyclerView.ViewHolder holder, int position, List payloads)

Parameters:

legacyBindViewMode - true if you want to activate it (default = false)

Returns:

this

withAttachDefaultListeners

public FastAdapter<Item> withAttachDefaultListeners(boolean mAttachDefaultListeners)

if set to `false` will not attach any listeners to the list. click events will have to be handled manually It is important to remember, if deactivated no listeners won't be attached at a later time either, as the listeners are only attached at ViewHolder creation time.

Parameters:

mAttachDefaultListeners - false if you want no listeners attached to the item (default = true)

Returns:

this

withSelectionListener

public FastAdapter<Item> withSelectionListener(ISelectionListener<Item> selectionListener)

set a listener that get's notified whenever an item is selected or deselected

Parameters:

selectionListener - the listener that will be notified about selection changes

Returns:

this

isSelectable

public boolean isSelectable()

Returns:

if items are selectable

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

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

getTypeInstance

public Item getTypeInstance(int type)

gets the TypeInstance remembered within the FastAdapter for an item

Parameters:

type - the int type of the item

Returns:

the Item typeInstance

clearTypeInstance

public void clearTypeInstance()

clears the internal mapper - be sure, to remap everything before going on

getHolderAdapterPosition

public int getHolderAdapterPosition(RecyclerView.ViewHolder holder)

helper method to get the position from a holder overwrite this if you have an adapter adding additional items inbetwean

Parameters:

holder - the viewHolder of the item

Returns:

the position of the holder

onCreateViewHolder

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

Creates the ViewHolder by the viewType

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(RecyclerView.ViewHolder holder,
                             int position)

Binds the data to the created ViewHolder and sets the listeners to the holder.itemView Note that you should use the `onBindViewHolder(RecyclerView.ViewHolder holder, int position, List payloads` as it allows you to implement a more efficient adapter implementation

Parameters:

holder - the viewHolder we bind the data on

position - the global position

onBindViewHolder

public void onBindViewHolder(RecyclerView.ViewHolder holder,
                             int position,
                             java.util.List<java.lang.Object> payloads)

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

Parameters:

holder - the viewHolder we bind the data on

position - the global position

payloads - the payloads for the bindViewHolder event containing data which allows to improve view animating

onViewRecycled

public void onViewRecycled(RecyclerView.ViewHolder holder)

Unbinds the data to the already existing ViewHolder and removes the listeners from the holder.itemView

Parameters:

holder - the viewHolder we unbind the data from

onViewDetachedFromWindow

public void onViewDetachedFromWindow(RecyclerView.ViewHolder holder)

is called in onViewDetachedFromWindow when the view is detached from the window

Parameters:

holder - the viewHolder for the view which got detached

onViewAttachedToWindow

public void onViewAttachedToWindow(RecyclerView.ViewHolder holder)

is called in onViewAttachedToWindow when the view is detached from the window

Parameters:

holder - the viewHolder for the view which got detached

onFailedToRecycleView

public boolean onFailedToRecycleView(RecyclerView.ViewHolder holder)

is called when the ViewHolder is in a transient state. return true if you want to reuse that view anyways

Parameters:

holder - the viewHolder for the view which failed to recycle

Returns:

true if we want to recycle anyways (false - it get's destroyed)

onAttachedToRecyclerView

public void onAttachedToRecyclerView(RecyclerView recyclerView)

onDetachedFromRecyclerView

public void onDetachedFromRecyclerView(RecyclerView recyclerView)

getPosition

public int getPosition(Item item)

Searches for the given item and calculates its global position

Parameters:

item - the item which is searched for

Returns:

the global position, or -1 if not found

getPosition

public int getPosition(long identifier)

Searches for the given item and calculates its global position

Parameters:

identifier - the identifier of an 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

getItemById

public <any> getItemById(long identifier)

gets the IItem given an identifier, from all registered adapters

Parameters:

identifier - the identifier of the searched item

Returns:

the found Pair<IItem, Integer> (the found item, and it's global position if it is currently displayed) 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 its 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

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

Parameters:

position - the global position

Returns:

the itemId for this position

getItemCount

public int getItemCount()

calculates the total ItemCount over all registered adapters

Returns:

the global count

getPreItemCountByOrder

public int getPreItemCountByOrder(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

getPreItemCount

public int getPreItemCount(int position)

calculates the item count up to a given (excluding this) adapter (defined by the global position of the item)

Parameters:

position - the global position of an adapter item

Returns:

the total count of items up to the adapter which holds the given position

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

cacheSizes

protected void cacheSizes()

we cache the sizes of our adapters so get accesses are faster

getViewClickListener

public ClickEventHook<Item> getViewClickListener()

Returns:

the `ClickEventHook` which is attached by default (if not deactivated) via `withAttachDefaultListeners`

See Also:

withAttachDefaultListeners(boolean)

getViewLongClickListener

public LongClickEventHook<Item> getViewLongClickListener()

Returns:

the `LongClickEventHook` which is attached by default (if not deactivated) via `withAttachDefaultListeners`

See Also:

withAttachDefaultListeners(boolean)

getViewTouchListener

public TouchEventHook<Item> getViewTouchListener()

Returns:

the `TouchEventHook` which is attached by default (if not deactivated) via `withAttachDefaultListeners`

See Also:

withAttachDefaultListeners(boolean)

getSelectExtension

@Deprecated
public SelectExtension<Item> getSelectExtension()

Deprecated. deprecated in favor of getExtension(Class)

Returns:

the selectExtension defined for this FastAdaper

getSelections

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

Deprecated. deprecated in favor of SelectExtension.getSelections() , Retrieve it via getExtension(Class)

Returns:

a set with the global positions of all selected items

getSelectedItems

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

Deprecated. deprecated in favor of SelectExtension.getSelectedItems() , Retrieve it via getExtension(Class)

Returns:

a set with the items which are currently selected

toggleSelection

@Deprecated
public void toggleSelection(int position)

Deprecated. deprecated in favor of SelectExtension.toggleSelection(int) , Retrieve it via getExtension(Class)

toggles the selection of the item at the given position

Parameters:

position - the global position

select

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

Deprecated. deprecated in favor of SelectExtension.select(Iterable) , Retrieve it via getExtension(Class)

selects all items at the positions in the iteratable

Parameters:

positions - the global positions to select

select

@Deprecated
public void select(int position)

Deprecated. deprecated in favor of SelectExtension.select(int), Retrieve it via getExtension(Class)

selects an item and remembers its position in the selections list

Parameters:

position - the global position

select

@Deprecated
public void select(int position,
                               boolean fireEvent)

Deprecated. deprecated in favor of SelectExtension.select(int, boolean) , Retrieve it via getExtension(Class)

selects an item and remembers its position in the selections list

Parameters:

position - the global position

fireEvent - true if the onClick listener should be called

select

@Deprecated
public void select(int position,
                               boolean fireEvent,
                               boolean considerSelectableFlag)

Deprecated. deprecated in favor of SelectExtension.select(int, boolean, boolean) , Retrieve it via getExtension(Class)

selects an item and remembers its position in the selections list

Parameters:

position - the global position

fireEvent - true if the onClick listener should be called

considerSelectableFlag - true if the select method should not select an item if its not selectable

deselect

@Deprecated
public void deselect()

Deprecated. deprecated in favor of SelectExtension.deselect() , Retrieve it via getExtension(Class)

deselects all selections

select

@Deprecated
public void select()

Deprecated. deprecated in favor of SelectExtension.select() , Retrieve it via getExtension(Class)

select all items

select

@Deprecated
public void select(boolean considerSelectableFlag)

Deprecated. deprecated in favor of SelectExtension.select(boolean) , Retrieve it via getExtension(Class)

select all items

Parameters:

considerSelectableFlag - true if the select method should not select an item if its not selectable

deselect

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

Deprecated. deprecated in favor of SelectExtension.deselect(Iterable) , Retrieve it via getExtension(Class)

deselects all items at the positions in the iteratable

Parameters:

positions - the global positions to deselect

deselect

@Deprecated
public void deselect(int position)

Deprecated. deprecated in favor of SelectExtension.deselect(int) , Retrieve it via getExtension(Class)

deselects an item and removes its position in the selections list

Parameters:

position - the global position

deselect

@Deprecated
public void deselect(int position,
                                 java.util.Iterator<java.lang.Integer> entries)

Deprecated. deprecated in favor of SelectExtension.deselect(int, Iterator), Retrieve it via getExtension(Class)

deselects an item and removes its position in the selections list also takes an iterator to remove items from the map

Parameters:

position - the global position

entries - the iterator which is used to deselect all

deleteAllSelectedItems

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

Deprecated. deprecated in favor of SelectExtension.deleteAllSelectedItems(), Retrieve it via getExtension(Class)

deletes all current selected items

Returns:

a list of the IItem elements which were deleted

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

getHolderAdapterItem

public static <Item extends IItem> Item getHolderAdapterItem(RecyclerView.ViewHolder holder)

convenient helper method to get the Item from a holder

Parameters:

holder - the ViewHolder for which we want to retrieve the item

Returns:

the Item found for this ViewHolder

getHolderAdapterItem

public static <Item extends IItem> Item getHolderAdapterItem(RecyclerView.ViewHolder holder,
                                                             int position)

convenient helper method to get the Item from a holder

Parameters:

holder - the ViewHolder for which we want to retrieve the item

position - the position for which we want to retrieve the item

Returns:

the Item found for the given position and that ViewHolder

getHolderAdapterItemTag

public static <Item extends IItem> Item getHolderAdapterItemTag(RecyclerView.ViewHolder holder)

convenient helper method to get the Item from a holder via the defined tag

Parameters:

holder - the ViewHolder for which we want to retrieve the item

Returns:

the Item found for the given position and that ViewHolder

recursive

public Triple<java.lang.Boolean,Item,java.lang.Integer> recursive(AdapterPredicate<Item> predicate,
                                                                  boolean stopOnMatch)

util function which recursively iterates over all items and subItems of the given adapter. It executes the given `predicate` on every item and will either stop if that function returns true, or continue (if stopOnMatch is false)

Parameters:

predicate - the predicate to run on every item, to check for a match or do some changes (e.g. select)

stopOnMatch - defines if we should stop iterating after the first match

Returns:

Triple<Boolean, IItem, Integer> The first value is true (it is always not null), the second contains the item and the third the position (if the item is visible) if we had a match, (always false and null and null in case of stopOnMatch == false)

recursive

public Triple<java.lang.Boolean,Item,java.lang.Integer> recursive(AdapterPredicate<Item> predicate,
                                                                  int globalStartPosition,
                                                                  boolean stopOnMatch)

util function which recursively iterates over all items and subItems of the given adapter. It executes the given `predicate` on every item and will either stop if that function returns true, or continue (if stopOnMatch is false)

Parameters:

predicate - the predicate to run on every item, to check for a match or do some changes (e.g. select)

globalStartPosition - the start position at which we star tto recursively iterate over the items. (This will not stop at the end of a sub hierarchy!)

stopOnMatch - defines if we should stop iterating after the first match

Returns:

Triple<Boolean, IItem, Integer> The first value is true (it is always not null), the second contains the item and the third the position (if the item is visible) if we had a match, (always false and null and null in case of stopOnMatch == false)

recursiveSub

public static <Item extends IItem> Triple<java.lang.Boolean,Item,java.lang.Integer> recursiveSub(IAdapter<Item> lastParentAdapter,
                                                                                                 int lastParentPosition,
                                                                                                 IExpandable parent,
                                                                                                 AdapterPredicate<Item> predicate,
                                                                                                 boolean stopOnMatch)

Util function which recursively iterates over all items of a `IExpandable` parent if and only if it is `expanded` and has `subItems` This is usually only used in

Type Parameters:

Item - the type of the `Item`

Parameters:

lastParentAdapter - the last `IAdapter` managing the last (visible) parent item (that might also be a parent of a parent, ..)

lastParentPosition - the global position of the last (visible) parent item, holding this sub item (that might also be a parent of a parent, ..)

parent - the `IExpandableParent` to start from

predicate - the predicate to run on every item, to check for a match or do some changes (e.g. select)

stopOnMatch - defines if we should stop iterating after the first match

Returns:

Triple<Boolean, IItem, Integer> The first value is true (it is always not null), the second contains the item and the third the position (if the item is visible) if we had a match, (always false and null and null in case of stopOnMatch == false)