FlexibleAdapter (flexible-adapter 5.1.0 API)

java.lang.Object
- RecyclerView.Adapter
- - eu.davidea.flexibleadapter.SelectableAdapter
  - - eu.davidea.flexibleadapter.AnimatorAdapter
    - - eu.davidea.flexibleadapter.FlexibleAdapter<T>

All Implemented Interfaces:

FastScroller.AdapterInterface, FastScroller.BubbleTextCreator, FastScroller.OnScrollStateChangeListener, ItemTouchHelperCallback.AdapterCallback
```
public class FlexibleAdapter<T extends IFlexible>
extends AnimatorAdapter
implements ItemTouchHelperCallback.AdapterCallback
```
This Adapter is backed by an ArrayList of arbitrary objects of class T, where T is your adapter object containing the data of a single item. This Adapter simplifies the development by providing a set of standard methods to handle changes on the data set such as: selecting, filtering, adding, removing, moving and animating an item.
With version 5.0.0, T item must implement IFlexible item interface as base item for all view types and new methods have been added in order to:
- handle Headers/Sections with IHeader and ISectionable items;
- expand and collapse IExpandable items;
- drag&drop and swipe any items.
Since:

03/05/2015 Created
16/01/2016 Expandable items
24/01/2016 Drag&Drop, Swipe-to-dismiss
30/01/2016 Class now extends AnimatorAdapter that extends SelectableAdapter
02/02/2016 New code reorganization, new item interfaces and full refactoring
08/02/2016 Headers/Sections
10/02/2016 The class is not abstract anymore, it is ready to be used
20/02/2016 Sticky headers
22/04/2016 Endless Scrolling
13/07/2016 Update and Filter operations are executed asynchronously (high performance on big list)
25/11/2016 Scrollable Headers and Footers; Reviewed EndlessScroll
28/03/2017 Adapter now makes a copy of the provided list at startup, updateDataSet and filterItems
10/04/2017 Endless Top Scrolling
15/04/2017 Starting or resetting the Filter will empty the bin of the deletedItems
23/04/2017 Wrapper class for any third type of LayoutManagers
04/02/2018 Child view click
13/02/2018 Multi filter

See Also:

AnimatorAdapter, SelectableAdapter, IFlexible, FlexibleViewHolder, ExpandableViewHolder

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FlexibleAdapter.DiffUtilCallback<T extends IFlexible>` Use `FlexibleAdapter.DiffUtilCallback.setItems(List, List)` to set the old and new lists, that are available as: - `protected List<T> oldItems;` - `protected List<T> newItems;`
`static interface`	`FlexibleAdapter.EndlessScrollListener`
`class`	`FlexibleAdapter.HandlerCallback` Handler callback for delayed actions.
`static interface`	`FlexibleAdapter.OnActionStateListener`
`static interface`	`FlexibleAdapter.OnDeleteCompleteListener`
`static interface`	`FlexibleAdapter.OnFilterListener`
`static interface`	`FlexibleAdapter.OnItemClickListener`
`static interface`	`FlexibleAdapter.OnItemLongClickListener`
`static interface`	`FlexibleAdapter.OnItemMoveListener`
`static interface`	`FlexibleAdapter.OnItemSwipeListener`
`static interface`	`FlexibleAdapter.OnStickyHeaderChangeListener`
`static interface`	`FlexibleAdapter.OnUpdateListener`

Nested classes/interfaces inherited from class eu.davidea.flexibleadapter.SelectableAdapter
SelectableAdapter.Mode

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`FILTER`
`protected int`	`LOAD_MORE_COMPLETE`
`protected FlexibleAdapter.OnDeleteCompleteListener`	`mDeleteCompleteListener`
`protected FlexibleAdapter.EndlessScrollListener`	`mEndlessScrollListener`
`protected FlexibleAdapter.OnFilterListener`	`mFilterListener`
`protected android.os.Handler`	`mHandler`
`protected android.view.LayoutInflater`	`mInflater`
`FlexibleAdapter.OnItemClickListener`	`mItemClickListener`
`FlexibleAdapter.OnItemLongClickListener`	`mItemLongClickListener`
`protected FlexibleAdapter.OnItemMoveListener`	`mItemMoveListener`
`protected FlexibleAdapter.OnItemSwipeListener`	`mItemSwipeListener`
`protected FlexibleAdapter.OnStickyHeaderChangeListener`	`mStickyHeaderChangeListener`
`protected FlexibleAdapter.OnUpdateListener`	`mUpdateListener`
`protected int`	`UPDATE`

Fields inherited from class eu.davidea.flexibleadapter.SelectableAdapter
isFastScroll, mFastScrollerDelegate, mLastItemInActionMode, mRecyclerView, mSelectAll

Constructor Summary

Constructors
Constructor and Description
`FlexibleAdapter(java.util.List<T> items)` Simple Constructor with NO listeners!
`FlexibleAdapter(java.util.List<T> items, java.lang.Object listeners)` Main Constructor with all managed listeners for ViewHolder and the Adapter itself.
`FlexibleAdapter(java.util.List<T> items, java.lang.Object listeners, boolean stableIds)` Same as `FlexibleAdapter(List, Object)` with possibility to set stableIds.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addItem(int position, T item)` Inserts the given item at the specified position or Adds the item to the end of the list (no matters if the new position is out of bounds!).
`boolean`	`addItem(T item)` Simply append the provided item to the end of the list.
`boolean`	`addItems(int position, java.util.List<T> items)` Inserts a set of items at specified position or Adds the items to the end of the list (no matters if the new position is out of bounds!).
`int`	`addItemToSection(ISectionable sectionable, IHeader header, java.util.Comparator<IFlexible> comparator)` Adds a new item in a section when the relative position is unknown.
`int`	`addItemToSection(ISectionable sectionable, IHeader header, int index)` Adds a new item in a section when the relative position is known.
`void`	`addItemWithDelay(int position, T item, long delay, boolean scrollToPosition)` Inserts the given item at desired position or Add item at last position with a delay and auto-scroll to the position.
`FlexibleAdapter<T>`	`addListener(java.lang.Object listener)` Initializes the listener(s) of this Adapter.
`boolean`	`addScrollableFooter(T footerItem)` Adds a Scrollable Footer.
`void`	`addScrollableFooterWithDelay(T footerItem, long delay, boolean scrollToPosition)` Same as `addScrollableFooter(IFlexible)` but with a delay and the possibility to scroll to it.
`boolean`	`addScrollableHeader(T headerItem)` Adds a Scrollable Header.
`void`	`addScrollableHeaderWithDelay(T headerItem, long delay, boolean scrollToPosition)` Same as `addScrollableHeader(IFlexible)` but with a delay and the possibility to scroll to it.
`int`	`addSection(IHeader header)` Adds and shows an empty section to the top (position = 0).
`int`	`addSection(IHeader header, java.util.Comparator<IFlexible> comparator)` Adds and shows an empty section.
`boolean`	`addSubItem(int parentPosition, int subPosition, T item)` Convenience method of `addSubItem(int, int, IFlexible, boolean, Object)`.
`boolean`	`addSubItem(int parentPosition, int subPosition, T item, boolean expandParent, java.lang.Object payload)` Convenience method of `addSubItems(int, int, IExpandable, List, boolean, Object)`.
`boolean`	`addSubItems(int parentPosition, int subPosition, java.util.List<T> items)` Convenience method of `addSubItems(int, int, List, boolean, Object)`.
`boolean`	`addSubItems(int parentPosition, int subPosition, java.util.List<T> items, boolean expandParent, java.lang.Object payload)` Convenience method of `addSubItems(int, int, IExpandable, List, boolean, Object)`.
`boolean`	`areHeadersShown()` Evaluates if Adapter has headers shown.
`boolean`	`areHeadersSticky()` Evaluates if Adapter can actually display sticky headers on the top.
`int`	`calculatePositionFor(java.lang.Object item, java.util.Comparator<IFlexible> comparator)` New method to extract the new position where the item should lay.
`void`	`clear()` This method clears everything: main items, Scrollable Headers and Footers and everything else is displayed.
`void`	`clearAllBut(java.lang.Integer... viewTypes)` Clears the Adapter list retaining Scrollable Headers and Footers and all items of the type provided as parameter.
`void`	`clearSelection()` Clears the selection status for all items one by one and it doesn't stop animations in the items.
`int`	`collapse(int position)` Collapses an `IExpandable` item that is already expanded and if no subItem is selected.
`int`	`collapse(int position, boolean notifyParent)` Same behaviors as `collapse(int)` with possibility to notify/update the parent.
`int`	`collapseAll()` Collapses all expandable items with the minimum level of `mMinCollapsibleLevel`.
`int`	`collapseAll(int level)` Collapses all expandable items with the level equals-higher than the specified level.
`void`	`confirmDeletion()` Performs removal confirmation and cleans memory by synchronizing the internal list from deletion.
`boolean`	`contains(T item)` This method is never called internally.
`void`	`emptyBin()` Cleans memory from items just removed.
`void`	`ensureHeaderParent()` Ensures the current sticky header view is correctly displayed in the sticky layout.
`int`	`expand(int position)` Expands an item that is `IExpandable` type, not yet expanded and if has subItems.
`int`	`expand(int position, boolean notifyParent)` Expands an item that is `IExpandable` type, not yet expanded and if has subItems.
`int`	`expand(T item)` Convenience method to expand a single item.
`int`	`expand(T item, boolean init)` Convenience method to initially expand a single item.
`int`	`expandAll()` Expands all `IExpandable` items with minimum of level `mMinCollapsibleLevel`.
`int`	`expandAll(int level)` Expands all `IExpandable` items with at least the specified level.
`FlexibleAdapter<T>`	`expandItemsAtStartUp()` Maps and expands items that are initially configured to be shown as expanded.
`void`	`filterItems()` Filters the current list with the filter previously set with `setFilter(Serializable)`.
`void`	`filterItems(java.util.List<T> unfilteredItems)` WATCH OUT!
`void`	`filterItems(java.util.List<T> unfilteredItems, long delay)` WATCH OUT!
`void`	`filterItems(long delay)` Same as `filterItems()` but with a delay in the execution, useful to grab more characters from user before starting the search.
`protected boolean`	`filterObject(T item, java.io.Serializable constraint)` This method checks if the provided object is a type of `IFilterable` interface, if yes, performs the filter on the implemented method `IFilterable.filter(Serializable)`.
`int`	`getCardinalPositionOf(IFlexible item)` Retrieves the position of the Main item in the Adapter list excluding the scrollable Headers.
`java.util.List<T>`	`getCurrentChildren(IExpandable expandable)` Retrieves all the original children of the specified parent, filtering out all the deleted children if any.
`java.util.List<T>`	`getCurrentItems()` Gets an unmodifiable view of the internal list of items.
`java.util.List<T>`	`getDeletedChildren(IExpandable expandable)` Retrieves only the deleted children of the specified parent.
`java.util.List<T>`	`getDeletedItems()`
`int`	`getEndlessCurrentPage()` Provides the current endless page if the page size limit is set, if not set the returned value is always 0.
`int`	`getEndlessPageSize()` The current setting for the endless page size limit.
`int`	`getEndlessTargetCount()` The current setting for the endless target item count limit.
`IExpandable`	`getExpandableOf(int position)` Retrieves the parent of a child for the provided position.
`IExpandable`	`getExpandableOf(T child)` Retrieves the parent of a child.
`IExpandable`	`getExpandableOfDeletedChild(T child)` Retrieves the expandable of the deleted child.
`int`	`getExpandablePositionOf(T child)` Retrieves the parent position of a child.
`java.util.List<T>`	`getExpandedItems()` Provides a list of all expandable items that are currently expanded.
`java.util.List<java.lang.Integer>`	`getExpandedPositions()` Provides a list of all expandable positions that are currently expanded.
`<F extends java.io.Serializable> F`	`getFilter(java.lang.Class<F> clazz)` Gets the current filter.
`int`	`getGlobalPositionOf(IFlexible item)` Retrieves the global position of the item in the Adapter list.
`java.util.List<IHeader>`	`getHeaderItems()` Retrieves all the header items.
`IHeader`	`getHeaderOf(T item)` Retrieves the header of the provided `ISectionable` item.
`T`	`getItem(int position)` Returns the object of the generic type T.
`<S extends T> S`	`getItem(int position, java.lang.Class<S> clazz)` Returns the object of specific type S.
`int`	`getItemCount()` Returns the total number of items in the data set held by the adapter (headers and footers INCLUDED).
`int`	`getItemCountOfTypes(java.lang.Integer... viewTypes)` Provides the number of items currently displayed of one or more certain types.
`long`	`getItemId(int position)` This method is mostly used by the adapter if items have stableIds.
`ItemTouchHelper`	`getItemTouchHelper()` Used by `FlexibleViewHolder.onTouch(View, MotionEvent)` to start Drag or Swipe when HandleView is touched.
`ItemTouchHelperCallback`	`getItemTouchHelperCallback()` Returns the customization of the ItemTouchHelperCallback or the default if it wasn't set before.
`int`	`getItemViewType(int position)` You CANNOT override this method: `FlexibleAdapter` delegates the ViewType definition via `IFlexible.getLayoutRes()` so ViewTypes are automatically mapped (AutoMap).
`int`	`getMainItemCount()` Returns the total number of items in the data set held by the adapter.
`int`	`getMinCollapsibleLevel()`
`int`	`getSameTypePositionOf(IFlexible item)` Retrieves the position of any item in the Adapter counting only the items of the same view type of the provided item and excluding all the others view types.
`java.util.List<T>`	`getScrollableFooters()`
`java.util.List<T>`	`getScrollableHeaders()`
`IHeader`	`getSectionHeader(int position)` Retrieves the `IHeader` item of any specified position.
`java.util.List<java.lang.Integer>`	`getSectionItemPositions(IHeader header)` Provides all the item positions that belongs to the section represented by the provided header.
`java.util.List<ISectionable>`	`getSectionItems(IHeader header)` Provides all the items that belongs to the section represented by the provided header.
`java.util.List<T>`	`getSiblingsOf(T child)` Provides the full sub list where the child currently lays.
`int`	`getStickyHeaderElevation()` Gets the layout in dpi elevation for sticky header.
`int`	`getStickyPosition()` Returns the current position of the sticky header.
`int`	`getSubPositionOf(T child)` Retrieves the sub position of any sub item in the section where it lays.
`long`	`getTime()`
`java.util.List<java.lang.Integer>`	`getUndoPositions()`
`boolean`	`hasFilter()`
`boolean`	`hasHeader(T item)` Helper method to check if an item holds a header.
`boolean`	`hasNewFilter(java.io.Serializable constraint)` Checks if the filter is changed.
`boolean`	`hasSameHeader(T item, IHeader header)` Checks if the item has a header and that header is the same of the provided one.
`boolean`	`hasSubItems(IExpandable expandable)` Utility method to check if the expandable item has sub items.
`void`	`hideAllHeaders()` Hides all headers from the RecyclerView.
`void`	`invalidateItemDecorations(long delay)` Helper method to post invalidate the item decorations after the provided delay.
`boolean`	`isAnimateChangesWithDiffUtil()`
`boolean`	`isAnyChildSelected()`
`boolean`	`isAnyParentSelected()`
`boolean`	`isAutoCollapseOnExpand()`
`boolean`	`isAutoScrollOnExpand()`
`boolean`	`isEmpty()` You can override this method to define your own concept of "Empty".
`boolean`	`isEnabled(int position)` Deprecated. Use `isItemEnabled(int)`.
`boolean`	`isEndlessScrollEnabled()` Evaluates if the Adapter is in Endless Scroll mode.
`boolean`	`isExpandable(T item)` Checks if the provided item is an `IExpandable` instance.
`boolean`	`isExpanded(int position)`
`boolean`	`isExpanded(T item)` Checks if the provided item is an `IExpandable` instance and is expanded.
`boolean`	`isFiltering()`
`boolean`	`isHandleDragEnabled()` Returns whether ItemTouchHelper should start a drag and drop operation by touching its handle.
`boolean`	`isHeader(T item)`
`boolean`	`isItemEnabled(int position)` Checks if the current item has the property `enabled = true`.
`boolean`	`isLongPressDragEnabled()` Returns whether ItemTouchHelper should start a drag and drop operation if an item is long pressed.
`boolean`	`isPermanentDelete()` Returns if items will be deleted immediately when deletion is requested.
`boolean`	`isRecursiveCollapse()`
`boolean`	`isRestoreInTime()`
`boolean`	`isRestoreWithSelection()` Returns the current configuration to restore selections on Undo.
`boolean`	`isScrollableHeaderOrFooter(int position)` Checks if at the provided position, the item is a Header or Footer.
`boolean`	`isScrollableHeaderOrFooter(T item)` Checks if at the provided item is a Header or Footer.
`boolean`	`isSelectable(int position)` Checks if the current item has the property `selectable = true`.
`boolean`	`isSwipeEnabled()` Returns whether ItemTouchHelper should start a swipe operation if a pointer is swiped over the View.
`boolean`	`isTopEndless()`
`void`	`moveItem(int fromPosition, int toPosition)` Moves the item placed at position `fromPosition` to the position `toPosition`.
`void`	`moveItem(int fromPosition, int toPosition, java.lang.Object payload)` Moves the item placed at position `fromPosition` to the position `toPosition`.
`void`	`onActionStateChanged(RecyclerView.ViewHolder viewHolder, int actionState)` Called when the `ItemTouchHelper` first registers an item as being moved or swiped or when has been released.
`void`	`onAttachedToRecyclerView(RecyclerView recyclerView)` Attaches the `FastScrollerDelegate` to the RecyclerView if necessary.
`void`	`onBindViewHolder(RecyclerView.ViewHolder holder, int position)` You CANNOT override this method to bind the items.
`void`	`onBindViewHolder(RecyclerView.ViewHolder holder, int position, java.util.List payloads)` Same concept of `#onBindViewHolder()` but with Payload.
`RecyclerView.ViewHolder`	`onCreateViewHolder(android.view.ViewGroup parent, int viewType)` You CANNOT override this method to create the ViewHolder, `FlexibleAdapter` delegates the creation via `IFlexible.createViewHolder()`.
`void`	`onDetachedFromRecyclerView(RecyclerView recyclerView)` Detaches the `FastScrollerDelegate` from the RecyclerView if necessary.
`boolean`	`onItemMove(int fromPosition, int toPosition)` Called when an item has been dragged far enough to trigger a move.
`void`	`onItemSwiped(int position, int direction)` Called when an item has been dismissed by a swipe.
`protected void`	`onLoadMore(int position)` This method is called automatically when an item is bound.
`void`	`onLoadMoreComplete(java.util.List<T> newItems)` To call when more items are successfully loaded.
`void`	`onLoadMoreComplete(java.util.List<T> newItems, long delay)` Call this method to complete the action of the Loading more items.
`protected void`	`onPostFilter()` This method is called after the execution of Async Filter, it calls the implementation of the `FlexibleAdapter.OnFilterListener` for the filterView.
`protected void`	`onPostUpdate()` This method is called only in case of granular notifications (not when notifyDataSetChanged) and after the execution of Async Update, it calls the implementation of the `FlexibleAdapter.OnUpdateListener` for the emptyView.
`void`	`onRestoreInstanceState(android.os.Bundle savedInstanceState)` Restore the previous state of the expanded items.
`void`	`onSaveInstanceState(android.os.Bundle outState)` Save the state of the current expanded items.
`void`	`onViewAttachedToWindow(RecyclerView.ViewHolder holder)`
`void`	`onViewDetachedFromWindow(RecyclerView.ViewHolder holder)`
`void`	`onViewRecycled(RecyclerView.ViewHolder holder)`
`void`	`removeAllScrollableFooters()` Removes all Scrollable Footers at once.
`void`	`removeAllScrollableHeaders()` Removes all Scrollable Headers at once.
`void`	`removeAllSelectedItems()` Convenience method to remove all items that are currently selected.
`void`	`removeAllSelectedItems(java.lang.Object payload)` Convenience method to remove all items that are currently selected.
`void`	`removeItem(int position)` Convenience method of `removeItem(int, Object)` providing `Payload.CHANGE` as payload for the parent item.
`void`	`removeItem(int position, java.lang.Object payload)` Removes an item from the internal list and notify the change.
`void`	`removeItems(java.util.List<java.lang.Integer> selectedPositions)` Convenience method of `removeItems(List, Object)` providing the default `Payload.CHANGE` for the parent items.
`void`	`removeItems(java.util.List<java.lang.Integer> selectedPositions, java.lang.Object payload)` Removes items by ranges, auto-collapse expanded items and notify the change.
`void`	`removeItemsOfType(java.lang.Integer... viewTypes)` Selectively removes all items of the type provided as parameter.
`void`	`removeItemWithDelay(T item, long delay, boolean permanent)` Removes the given item after the given delay.
`FlexibleAdapter<T>`	`removeListener(java.lang.Object listener)` Removes one listener from this Adapter.
`void`	`removeRange(int positionStart, int itemCount)` Same as `removeRange(int, int, Object)`, but in this case the parent will not be notified about the change, if children are removed.
`void`	`removeRange(int positionStart, int itemCount, java.lang.Object payload)` Removes a list of consecutive items and notify the change.
`void`	`removeScrollableFooter(T footerItem)` Removes the provided Scrollable Footer.
`void`	`removeScrollableFooterWithDelay(T footerItem, long delay)` Same as `removeScrollableFooter(IFlexible)` but with a delay.
`void`	`removeScrollableHeader(T headerItem)` Removes the provided Scrollable Header.
`void`	`removeScrollableHeaderWithDelay(T headerItem, long delay)` Same as `removeScrollableHeader(IFlexible)` but with a delay.
`void`	`removeSection(IHeader header)` Removes all items of a section, header included.
`void`	`restoreDeletedItems()` Restore items just removed.
`void`	`saveUndoPositions(java.util.List<java.lang.Integer> undoPositions)`
`void`	`selectAll(java.lang.Integer... viewTypes)` Helper to automatically select all the items of the viewType equal to the viewType of the first selected item.
`FlexibleAdapter<T>`	`setAnimateChangesWithDiffUtil(boolean useDiffUtil)` Whether use `DiffUtil` to calculate the changes between 2 lists after Update or Filter operations.
`FlexibleAdapter<T>`	`setAnimateToLimit(int limit)` Tunes the limit after the which the synchronization animations, occurred during updateDataSet and filter operations, are skipped and `#notifyDataSetChanged()` will be called instead.
`FlexibleAdapter<T>`	`setAutoCollapseOnExpand(boolean collapseOnExpand)` Automatically collapse all previous expanded parents before expand the new clicked parent.
`FlexibleAdapter<T>`	`setAutoScrollOnExpand(boolean scrollOnExpand)` Automatically scroll the clicked expandable item to the first visible position.
`FlexibleAdapter<T>`	`setDiffUtilCallback(FlexibleAdapter.DiffUtilCallback diffUtilCallback)` Sets a custom implementation of `FlexibleAdapter.DiffUtilCallback` for the DiffUtil.
`FlexibleAdapter<T>`	`setDisplayHeadersAtStartUp(boolean displayHeaders)` Sets if all headers should be shown at startup by the Adapter automatically.
`FlexibleAdapter<T>`	`setEndlessPageSize(int endlessPageSize)` Sets the limit to automatically disable the endless feature when coming items size is less than the page size.
`FlexibleAdapter<T>`	`setEndlessProgressItem(T progressItem)` Sets the progressItem to be displayed at the end of the list and activate the Loading More feature.
`FlexibleAdapter<T>`	`setEndlessScrollListener(FlexibleAdapter.EndlessScrollListener endlessScrollListener, T progressItem)` Sets the progressItem to be displayed at the end of the list and Sets the callback to automatically load more items asynchronously(your duty) (no further user action is needed but the scroll).
`FlexibleAdapter<T>`	`setEndlessScrollThreshold(int thresholdItems)` Sets the minimum number of items still to bind to start the automatic loading.
`FlexibleAdapter<T>`	`setEndlessTargetCount(int endlessTargetCount)` Sets the limit to automatically disable the endless feature when the total items count in the Adapter is equals or bigger than the target count.
`void`	`setFilter(java.io.Serializable filter)` Sets the new filter entity.
`FlexibleAdapter<T>`	`setHandleDragEnabled(boolean handleDragEnabled)` Enables / Disables the drag of the item with a handle view.
`FlexibleAdapter<T>`	`setHeadersShown(boolean headersShown)` Manually change the flag to indicate that headers are inserted(or not) in the main list by the user and the Adapter doesn't(does) have to automatically insert them.
`FlexibleAdapter<T>`	`setItemTouchHelperCallback(ItemTouchHelperCallback itemTouchHelperCallback)` Sets a custom callback implementation for item touch.
`FlexibleAdapter<T>`	`setLoadingMoreAtStartUp(boolean enable)` Sets if Endless / Loading More should be triggered at start-up, especially when the list is empty.
`FlexibleAdapter<T>`	`setLongPressDragEnabled(boolean longPressDragEnabled)` Enables / Disables the drag of the item when long-press the entire itemView.
`FlexibleAdapter<T>`	`setMinCollapsibleLevel(int minCollapsibleLevel)` Sets the minimum level which all sub expandable items will be collapsed too.
`FlexibleAdapter<T>`	`setNotifyChangeOfUnfilteredItems(boolean notifyChange)` With this setting, we can skip the check of the implemented method `IFlexible.shouldNotifyChange(IFlexible)`.
`FlexibleAdapter<T>`	`setNotifyMoveOfFilteredItems(boolean notifyMove)` This method performs a further step to nicely animate the moved items.
`FlexibleAdapter<T>`	`setPermanentDelete(boolean permanentDelete)` Sets if the deleted items should be deleted immediately or if Adapter should cache them to restore them when requested by the user.
`FlexibleAdapter<T>`	`setRecursiveCollapse(boolean collapseSubLevels)` Automatically collapse all inner sub expandable when higher parent is collapsed.
`FlexibleAdapter<T>`	`setRestoreSelectionOnUndo(boolean restoreSelection)` Gives the possibility to restore the selection on Undo, when `restoreDeletedItems()` is called.
`FlexibleAdapter<T>`	`setStickyHeaderElevation(int stickyElevation)` Sets the elevation in dpi for the sticky header layout.
`FlexibleAdapter<T>`	`setStickyHeaders(boolean sticky)` Enables/Disables the sticky header feature with default sticky layout container.
`FlexibleAdapter<T>`	`setStickyHeaders(boolean sticky, android.view.ViewGroup stickyContainer)` Enables/Disables the sticky header feature with a custom sticky layout container.
`FlexibleAdapter<T>`	`setSwipeEnabled(boolean swipeEnabled)` Enables full the swipe of the items.
`void`	`setTopEndless(boolean topEndless)` Sets endless scrolling from the top.
`FlexibleAdapter<T>`	`setUnlinkAllItemsOnRemoveHeaders(boolean unlinkOnRemoveHeader)` Setting to automatically unlink the deleted header from items having that header linked.
`boolean`	`shouldMove(int fromPosition, int toPosition)` Evaluate if positions are compatible for swapping.
`FlexibleAdapter<T>`	`showAllHeaders()` Shows all headers in the RecyclerView at their linked position.
`void`	`smoothScrollToPosition(int position)` Performs safe smooth scroll with a delay of ms.
`void`	`swapItems(java.util.List<T> list, int fromPosition, int toPosition)` Swaps the elements of list at indices fromPosition and toPosition and notify the change.
`void`	`toggleSelection(int position)` Toggles the selection status of the item at a given position.
`void`	`updateDataSet(java.util.List<T> items)` Convenience method of `updateDataSet(List, boolean)` (You should read the comments of this method).
`void`	`updateDataSet(java.util.List<T> items, boolean animate)` This method will refresh the entire data set content.
`void`	`updateItem(int position, T item, java.lang.Object payload)` Updates/Rebounds the itemView corresponding to the current position of the provided item with the new content.
`void`	`updateItem(T item)` Updates/Rebounds the itemView corresponding to the current position of the provided item with the new content.
`void`	`updateItem(T item, java.lang.Object payload)` Updates/Rebounds the itemView corresponding to the current position of the provided item with the new content.

Methods inherited from class eu.davidea.flexibleadapter.AnimatorAdapter
animateView, isAnimationOnForwardScrollingEnabled, isAnimationOnReverseScrollingEnabled, isOnlyEntryAnimation, setAnimationDelay, setAnimationDuration, setAnimationEntryStep, setAnimationInitialDelay, setAnimationInterpolator, setAnimationOnForwardScrolling, setAnimationOnReverseScrolling, setOnlyEntryAnimation

Methods inherited from class eu.davidea.flexibleadapter.SelectableAdapter
addSelection, enableLogs, getAllBoundViewHolders, getFastScroller, getFlexibleLayoutManager, getMode, getRecyclerView, getSelectedItemCount, getSelectedPositions, getSelectedPositionsAsSet, isFastScrollerEnabled, isLastItemInActionMode, isSelectAll, isSelected, onCreateBubbleText, onFastScrollerStateChange, removeSelection, setFastScroller, setFlexibleLayoutManager, setMode, swapSelection, toggleFastScroller, useTag

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UPDATE
```
protected final int UPDATE
```
    See Also:
    
    Constant Field Values
  - FILTER
```
protected final int FILTER
```
    See Also:
    
    Constant Field Values
  - LOAD_MORE_COMPLETE
```
protected final int LOAD_MORE_COMPLETE
```
    See Also:
    
    Constant Field Values
  - mHandler
```
protected android.os.Handler mHandler
```
  - mInflater
```
protected android.view.LayoutInflater mInflater
```
  - mItemClickListener
```
public FlexibleAdapter.OnItemClickListener mItemClickListener
```
  - mItemLongClickListener
```
public FlexibleAdapter.OnItemLongClickListener mItemLongClickListener
```
  - mUpdateListener
```
protected FlexibleAdapter.OnUpdateListener mUpdateListener
```
  - mFilterListener
```
protected FlexibleAdapter.OnFilterListener mFilterListener
```
  - mItemMoveListener
```
protected FlexibleAdapter.OnItemMoveListener mItemMoveListener
```
  - mItemSwipeListener
```
protected FlexibleAdapter.OnItemSwipeListener mItemSwipeListener
```
  - mEndlessScrollListener
```
protected FlexibleAdapter.EndlessScrollListener mEndlessScrollListener
```
  - mDeleteCompleteListener
```
protected FlexibleAdapter.OnDeleteCompleteListener mDeleteCompleteListener
```
  - mStickyHeaderChangeListener
```
protected FlexibleAdapter.OnStickyHeaderChangeListener mStickyHeaderChangeListener
```
- Constructor Detail
  - FlexibleAdapter
```
public FlexibleAdapter(java.util.List<T> items)
```
    Simple Constructor with NO listeners!
    
    Parameters:
    
    items - items to display.
    
    Since:
    
    4.2.0 Created
    5.0.0-rc2 Copy of the Original List is done internally
    
    See Also:
    
    FlexibleAdapter(List, Object), FlexibleAdapter(List, Object, boolean)
  - FlexibleAdapter
```
public FlexibleAdapter(java.util.List<T> items,
                       java.lang.Object listeners)
```
    Main Constructor with all managed listeners for ViewHolder and the Adapter itself.
    The listener must be a single instance of a class, usually Activity or Fragment, where you can implement how to handle the different events.
    
    THE ADAPTER WORKS WITH A COPY OF THE ORIGINAL LIST: new ArrayList<T>(originalList);
    Parameters:
    
    items - items to display
    listeners - can be an instance of:
    
    FlexibleAdapter.OnItemClickListener
    FlexibleAdapter.OnItemLongClickListener
    FlexibleAdapter.OnItemMoveListener
    FlexibleAdapter.OnItemSwipeListener
    FlexibleAdapter.OnStickyHeaderChangeListener
    FlexibleAdapter.OnUpdateListener
    Since:
    
    5.0.0-b1 Created
    5.0.0-rc2 Copy of the Original List is done internally
    
    See Also:
    
    FlexibleAdapter(List), FlexibleAdapter(List, Object, boolean), addListener(Object)
  - FlexibleAdapter
```
public FlexibleAdapter(java.util.List<T> items,
                       java.lang.Object listeners,
                       boolean stableIds)
```
    Same as FlexibleAdapter(List, Object) with possibility to set stableIds.
    Tip: Setting true allows the RecyclerView to rebind only items really changed after a refresh with #notifyDataSetChanged() or after swapping Adapter. This increases performance.
    Set true only if items implement Object.hashCode() and have unique ids. The method #setHasStableIds(boolean) will be called.
    
    Parameters:
    
    stableIds - set true if item implements hashcode() and have unique ids.
    
    Since:
    
    5.0.0-b8 Created
    5.0.0-rc2 Copy of the Original List is done internally
    
    See Also:
    
    FlexibleAdapter(List), FlexibleAdapter(List, Object), addListener(Object)
- Method Detail
  - addListener
```
public FlexibleAdapter<T> addListener(java.lang.Object listener)
```
    Initializes the listener(s) of this Adapter.
    This method is automatically called from the Constructor.
    
    Parameters:
    
    listener - the object(s) instance(s) of any listener
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    removeListener(Object)
  - removeListener
```
public FlexibleAdapter<T> removeListener(java.lang.Object listener)
```
    Removes one listener from this Adapter.
    Warning:
    - In case of Click and LongClick events, it will remove also the callback from all bound ViewHolders too. To restore these 2 events on the current bound ViewHolders, call addListener(Object) providing the instance of the desired listener.
    - To remove a specific listener you have to provide the either the instance or the Class type of the listener, example:
      removeListener(mUpdateListener); removeListener(FlexibleAdapter.OnItemLongClickListener.class);
    Parameters:
    
    listener - the listener instance or Class type to remove from this Adapter and/or from all bound ViewHolders
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-rc3
    
    See Also:
    
    addListener(Object)
  - onAttachedToRecyclerView
```
public void onAttachedToRecyclerView(RecyclerView recyclerView)
```
    Attaches the FastScrollerDelegate to the RecyclerView if necessary.
    
    Attaches the StickyHeaderHelper to the RecyclerView if necessary.
    
    Overrides:
    
    onAttachedToRecyclerView in class SelectableAdapter
    
    Since:
    
    5.0.0-b6
  - onDetachedFromRecyclerView
```
public void onDetachedFromRecyclerView(RecyclerView recyclerView)
```
    Detaches the FastScrollerDelegate from the RecyclerView if necessary.
    
    Detaches the StickyHeaderHelper from the RecyclerView if necessary.
    
    Overrides:
    
    onDetachedFromRecyclerView in class SelectableAdapter
    
    Since:
    
    5.0.0-b6
  - expandItemsAtStartUp
```
public FlexibleAdapter<T> expandItemsAtStartUp()
```
    Maps and expands items that are initially configured to be shown as expanded.
    This method should be called during the creation of the Activity/Fragment, useful also after a screen rotation.
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
  - isEnabled
```
@Deprecated
public boolean isEnabled(int position)
```
    Deprecated. Use isItemEnabled(int).
  - isItemEnabled
```
public boolean isItemEnabled(int position)
```
    Checks if the current item has the property enabled = true.
    When an item is disabled, user cannot interact with it.
    
    Parameters:
    
    position - the current position of the item to check
    
    Returns:
    
    true if the item property enabled is set true, false otherwise
    
    Since:
    
    5.0.0-b6
  - isSelectable
```
public boolean isSelectable(int position)
```
    Checks if the current item has the property selectable = true.
    
    Specified by:
    
    isSelectable in class SelectableAdapter
    
    Parameters:
    
    position - the current position of the item to check
    
    Returns:
    
    true if the item property selectable is true, false otherwise
    
    Since:
    
    5.0.0-b6
  - toggleSelection
```
public void toggleSelection(int position)
```
    Toggles the selection status of the item at a given position.
    The behaviour depends on the selection mode previously set with SelectableAdapter.setMode(int).
    The Activated State of the ItemView is automatically set in FlexibleViewHolder.toggleActivation() called in onClick event
    Usage:
    - If you don't want any item to be selected/activated at all, just don't call this method.
    - To have actually the item visually selected you need to add a custom Selector Drawable to the background of the View, via DrawableUtils or via layout's item: android:background="?attr/selectableItemBackground", pointing to a custom Drawable in the style.xml (note: prefix ?android:attr doesn't work).
    Overrides:
    
    toggleSelection in class SelectableAdapter
    
    Parameters:
    
    position - position of the item to toggle the selection status for.
    
    Since:
    
    5.0.0-b1
  - selectAll
```
public void selectAll(java.lang.Integer... viewTypes)
```
    Helper to automatically select all the items of the viewType equal to the viewType of the first selected item.
    Examples:
    - if user initially selects an expandable of type A, then only expandable items of type A can be selected.
    - if user initially selects a non-expandable of type B, then only items of type B can be selected.
    - The developer can override this behaviour by passing a list of viewTypes for which he wants to force the selection.
    Overrides:
    
    selectAll in class SelectableAdapter
    
    Parameters:
    
    viewTypes - All the desired viewTypes to be selected, providing no view types, will automatically select all the viewTypes of the first item user has selected
    
    Since:
    
    5.0.0-b1
  - clearSelection
```
public void clearSelection()
```
    Clears the selection status for all items one by one and it doesn't stop animations in the items.
    Note 1: Items are not rebound, so an eventual animation is not stopped!
    Note 2: This method use java.util.Iterator on synchronized collection to avoid java.util.ConcurrentModificationException.
    
    Overrides:
    
    clearSelection in class SelectableAdapter
    
    Since:
    
    5.0.0-b1
  - isAnyParentSelected
```
public boolean isAnyParentSelected()
```
    Returns:
    
    true if a parent is selected
    
    Since:
    
    5.0.0-b1
  - isAnyChildSelected
```
public boolean isAnyChildSelected()
```
    Returns:
    
    true if any child of any parent is selected, false otherwise
    
    Since:
    
    5.0.0-b1
  - updateDataSet
```
public void updateDataSet(java.util.List<T> items)
```
    Convenience method of updateDataSet(List, boolean) (You should read the comments of this method).
    In this call, changes will NOT be animated: Warning! #notifyDataSetChanged() will be invoked.
    
    Parameters:
    
    items - the new data set
    
    Since:
    
    5.0.0-b1 Created
    5.0.0-rc2 Copy of the Original List done internally
    
    See Also:
    
    updateDataSet(List, boolean)
  - updateDataSet
```
public void updateDataSet(java.util.List<T> items,
                          boolean animate)
```
    This method will refresh the entire data set content. Optionally, all changes can be animated, limited by the value previously set with setAnimateToLimit(int) to improve performance on very big list. Should provide animate=false to directly invoke #notifyDataSetChanged() without any animations, if stableIds is not set!
    Note:
    - Scrollable Headers and Footers (if existent) will be restored in this call.
    - I strongly recommend to implement Object.hashCode() to all adapter items along with Object.equals(Object): This Adapter is making use of HashSet to improve performance.
    Note: The following methods will be also called at the end of the operation:
    1. expandItemsAtStartUp()
    2. showAllHeaders() if headers are shown
    3. onPostUpdate()
    4. FlexibleAdapter.OnUpdateListener.onUpdateEmptyView(int) if the listener is set
    Parameters:
    
    items - the new data set
    
    animate - true to animate the changes, false for an instant refresh
    
    Since:
    
    5.0.0-b7 Created
    5.0.0-rc2 Copy of the Original List done internally
    
    See Also:
    
    updateDataSet(List), setAnimateToLimit(int), onPostUpdate()
  - getItem
```
public T getItem(int position)
```
    Returns the object of the generic type T.
    This method cannot be overridden since the entire library relies on it.
    
    Parameters:
    
    position - the position of the item in the list
    
    Returns:
    
    The T object for the position provided or null if item not found
    
    Since:
    
    1.0.0
  - getItem
```
public <S extends T> S getItem(int position,
                               java.lang.Class<S> clazz)
```
    Returns the object of specific type S.
    
    Parameters:
    
    position - the position of the item in the list
    
    clazz - the class type expected
    
    Returns:
    
    The S object for the position provided or null if item not found
    
    Throws:
    
    java.lang.ClassCastException - if the class type doesn't match with the item type requested
    
    Since:
    
    5.0.0
  - getItemId
```
public long getItemId(int position)
```
    This method is mostly used by the adapter if items have stableIds.
    
    Parameters:
    
    position - the position of the current item
    
    Returns:
    
    Hashcode of the item at the specific position
    
    Since:
    
    5.0.0-b1
  - getItemCount
```
public int getItemCount()
```
    Returns the total number of items in the data set held by the adapter (headers and footers INCLUDED). Use getMainItemCount() with false as parameter to retrieve only real items excluding headers and footers.
    Note: This method cannot be overridden since the selection and the internal methods rely on it.
    
    Returns:
    
    the total number of items (headers and footers INCLUDED) held by the adapter
    
    Since:
    
    1.0.0
    
    See Also:
    
    getMainItemCount(), getItemCountOfTypes(Integer...), isEmpty()
  - getMainItemCount
```
public final int getMainItemCount()
```
    Returns the total number of items in the data set held by the adapter.
    - Provide true (default behavior) to count all items, same result of getItemCount().
    - Provide false to count only main items (headers and footers are EXCLUDED).
    Note: This method cannot be overridden since internal methods rely on it.
    Returns:
    
    the total number of items held by the adapter, with or without headers and footers, depending by the provided parameter
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getItemCount(), getItemCountOfTypes(Integer...)
  - getItemCountOfTypes
```
public final int getItemCountOfTypes(java.lang.Integer... viewTypes)
```
    Provides the number of items currently displayed of one or more certain types.
    
    Parameters:
    
    viewTypes - the viewTypes to count
    
    Returns:
    
    number of the viewTypes counted
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getItemCount(), getMainItemCount(), isEmpty()
  - getCurrentItems
```
public final java.util.List<T> getCurrentItems()
```
    Gets an unmodifiable view of the internal list of items.
    
    Returns:
    
    an unmodifiable view of the current adapter list
    
    Since:
    
    5.0.0-rc2
  - isEmpty
```
public boolean isEmpty()
```
    You can override this method to define your own concept of "Empty". This method is never called internally.
    
    Returns:
    
    true if the list is empty, false otherwise
    
    Since:
    
    4.2.0
    
    See Also:
    
    getItemCount(), getItemCountOfTypes(Integer...)
  - getGlobalPositionOf
```
public final int getGlobalPositionOf(IFlexible item)
```
    Retrieves the global position of the item in the Adapter list. If no scrollable Headers are added, the global position coincides with the cardinal position.
    This method cannot be overridden since the entire library relies on it.
    
    Parameters:
    
    item - the item for which the position needs to be found
    
    Returns:
    
    the global position in the Adapter if found, -1 otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getSameTypePositionOf(IFlexible)
  - getCardinalPositionOf
```
public final int getCardinalPositionOf(IFlexible item)
```
    Retrieves the position of the Main item in the Adapter list excluding the scrollable Headers. If no scrollable Headers are added, the cardinal position coincides with the global position.
    Note:
    - This method is NOT suitable to call when managing items: ALL insert, remove, move and swap operations, should done with global position getGlobalPositionOf(IFlexible).
    - This method cannot be overridden.
    
    Parameters:
    
    item - the item for which the position needs to be found
    
    Returns:
    
    the position in the Adapter excluding the Scrollable Headers, -1 otherwise
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getSameTypePositionOf(IFlexible)
  - getSameTypePositionOf
```
public final int getSameTypePositionOf(IFlexible item)
```
    Retrieves the position of any item in the Adapter counting only the items of the same view type of the provided item and excluding all the others view types.
    Tip: You can identify the number of the section (you need to add +1) of any headers OR to retrieve the position of an item as it were the only view type visible in the Adapter.
    
    Parameters:
    
    item - the item for which the position needs to be found
    
    Returns:
    
    the position in the Adapter counting only the items of the same type, -1 otherwise
    
    Since:
    
    5.0.0-rc3
    
    See Also:
    
    getSubPositionOf(IFlexible)
  - contains
```
public boolean contains(T item)
```
    This method is never called internally.
    
    Parameters:
    
    item - the item to find
    
    Returns:
    
    true if the provided item is currently displayed, false otherwise
    
    Since:
    
    2.0.0
  - calculatePositionFor
```
public int calculatePositionFor(java.lang.Object item,
                                java.util.Comparator<IFlexible> comparator)
```
    New method to extract the new position where the item should lay.
    Note: The Comparator object should be customized to support all types of items this Adapter is managing or a ClassCastException will be raised.
    If the Comparator is null the returned position is 0 (first position).
    
    Parameters:
    
    item - the item to evaluate the insertion
    
    comparator - the Comparator object with the logic to sort the list
    
    Returns:
    
    the position resulted from sorting with the provided Comparator
    
    Since:
    
    5.0.0-b7
  - getScrollableHeaders
```
public final java.util.List<T> getScrollableHeaders()
```
    Returns:
    
    unmodifiable list of Scrollable Headers currently held by the Adapter
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    addScrollableHeader(IFlexible), addScrollableHeaderWithDelay(IFlexible, long, boolean)
  - getScrollableFooters
```
public final java.util.List<T> getScrollableFooters()
```
    Returns:
    
    unmodifiable list of Scrollable Footers currently held by the Adapter
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    addScrollableFooter(IFlexible), addScrollableFooterWithDelay(IFlexible, long, boolean)
  - isScrollableHeaderOrFooter
```
public final boolean isScrollableHeaderOrFooter(int position)
```
    Checks if at the provided position, the item is a Header or Footer.
    
    Specified by:
    
    isScrollableHeaderOrFooter in class AnimatorAdapter
    
    Parameters:
    
    position - the position to check
    
    Returns:
    
    true if it's a scrollable item
  - isScrollableHeaderOrFooter
```
public final boolean isScrollableHeaderOrFooter(T item)
```
    Checks if at the provided item is a Header or Footer.
    
    Parameters:
    
    item - the item to check
    
    Returns:
    
    true if it's a scrollable item
    
    Since:
    
    5.0.0-rc2
  - addScrollableHeader
```
public final boolean addScrollableHeader(T headerItem)
```
    Adds a Scrollable Header.
    Scrollable Headers have the following characteristic:
    - lay always before any main item.
    - cannot be selectable nor draggable.
    - cannot be inserted twice, but many can be inserted.
    - any new header will be inserted before the existent.
    - can be of any type so they can be bound at runtime with any data inside.
    - won't be filtered because they won't be part of the main list, but added separately at the initialization phase
    - can be added and removed with certain delay.
    Parameters:
    
    headerItem - the header item to be added
    
    Returns:
    
    true if the header has been successfully added, false if the header already exists
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getScrollableHeaders(), addScrollableHeaderWithDelay(IFlexible, long, boolean)
  - addScrollableFooter
```
public final boolean addScrollableFooter(T footerItem)
```
    Adds a Scrollable Footer.
    Scrollable Footers have the following characteristic:
    - lay always after any main item.
    - cannot be selectable nor draggable.
    - cannot be inserted twice, but many can be inserted.
    - cannot scroll animate, when inserted for the first time.
    - any new footer will be inserted after the existent.
    - can be of any type so they can be bound at runtime with any data inside.
    - won't be filtered because they won't be part of the main list, but added separately at the initialization phase
    - can be added and removed with certain delay.
    - endless progressItem is handled as a Scrollable Footer, but it will be always displayed between the main items and the others footers.
    Parameters:
    
    footerItem - the footer item to be added
    
    Returns:
    
    true if the footer has been successfully added, false if the footer already exists
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getScrollableFooters(), addScrollableFooterWithDelay(IFlexible, long, boolean)
  - removeScrollableHeader
```
public final void removeScrollableHeader(T headerItem)
```
    Removes the provided Scrollable Header.
    
    Parameters:
    
    headerItem - the header to remove
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    removeScrollableHeaderWithDelay(IFlexible, long), removeAllScrollableHeaders()
  - removeScrollableFooter
```
public final void removeScrollableFooter(T footerItem)
```
    Removes the provided Scrollable Footer.
    
    Parameters:
    
    footerItem - the footer to remove
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    removeScrollableFooterWithDelay(IFlexible, long), removeAllScrollableFooters()
  - removeAllScrollableHeaders
```
public final void removeAllScrollableHeaders()
```
    Removes all Scrollable Headers at once.
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    removeScrollableHeader(IFlexible), removeScrollableHeaderWithDelay(IFlexible, long)
  - removeAllScrollableFooters
```
public final void removeAllScrollableFooters()
```
    Removes all Scrollable Footers at once.
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    removeScrollableFooter(IFlexible), removeScrollableFooterWithDelay(IFlexible, long)
  - addScrollableHeaderWithDelay
```
public final void addScrollableHeaderWithDelay(T headerItem,
                                               long delay,
                                               boolean scrollToPosition)
```
    Same as addScrollableHeader(IFlexible) but with a delay and the possibility to scroll to it.
    
    Parameters:
    
    headerItem - the header item to be added
    
    delay - the delay in ms
    
    scrollToPosition - true to scroll to the header item position once it has been added
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    addScrollableHeader(IFlexible)
  - addScrollableFooterWithDelay
```
public final void addScrollableFooterWithDelay(T footerItem,
                                               long delay,
                                               boolean scrollToPosition)
```
    Same as addScrollableFooter(IFlexible) but with a delay and the possibility to scroll to it.
    
    Parameters:
    
    footerItem - the footer item to be added
    
    delay - the delay in ms
    
    scrollToPosition - true to scroll to the footer item position once it has been added
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    addScrollableFooter(IFlexible)
  - removeScrollableHeaderWithDelay
```
public final void removeScrollableHeaderWithDelay(T headerItem,
                                                  long delay)
```
    Same as removeScrollableHeader(IFlexible) but with a delay.
    
    Parameters:
    
    headerItem - the header item to be removed
    
    delay - the delay in ms
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    removeScrollableHeader(IFlexible), removeAllScrollableHeaders()
  - removeScrollableFooterWithDelay
```
public final void removeScrollableFooterWithDelay(T footerItem,
                                                  long delay)
```
    Same as removeScrollableFooter(IFlexible) but with a delay.
    
    Parameters:
    
    footerItem - the footer item to be removed
    
    delay - the delay in ms
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    removeScrollableFooter(IFlexible), removeAllScrollableFooters()
  - setUnlinkAllItemsOnRemoveHeaders
```
public FlexibleAdapter<T> setUnlinkAllItemsOnRemoveHeaders(boolean unlinkOnRemoveHeader)
```
    Setting to automatically unlink the deleted header from items having that header linked.
    Default value is false.
    
    Parameters:
    
    unlinkOnRemoveHeader - true to unlink the deleted header from items having that header linked, false otherwise
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
  - getHeaderItems
```
public java.util.List<IHeader> getHeaderItems()
```
    Retrieves all the header items.
    
    Returns:
    
    non-null list with all the header items
    
    Since:
    
    5.0.0-b6
  - isHeader
```
public boolean isHeader(T item)
```
    Parameters:
    
    item - the item to check
    
    Returns:
    
    true if the item is an instance of IHeader interface, false otherwise
    
    Since:
    
    5.0.0-b6
  - hasHeader
```
public boolean hasHeader(T item)
```
    Helper method to check if an item holds a header.
    
    Parameters:
    
    item - the identified item
    
    Returns:
    
    true if the item holds a header, false otherwise
    
    Since:
    
    5.0.0-b6
  - hasSameHeader
```
public boolean hasSameHeader(T item,
                             IHeader header)
```
    Checks if the item has a header and that header is the same of the provided one.
    
    Parameters:
    
    item - the item supposing having the header
    
    header - the header to compare
    
    Returns:
    
    true if the item has a header and it is the same of the provided one, false otherwise
    
    Since:
    
    5.0.0-b6
  - getHeaderOf
```
public IHeader getHeaderOf(T item)
```
    Retrieves the header of the provided ISectionable item.
    
    Parameters:
    
    item - the ISectionable item holding a header
    
    Returns:
    
    the header of the passed Sectionable, null otherwise
    
    Since:
    
    5.0.0-b6
  - getSectionHeader
```
public IHeader getSectionHeader(int position)
```
    Retrieves the IHeader item of any specified position.
    
    Parameters:
    
    position - the item position
    
    Returns:
    
    the IHeader item linked to the specified item position
    
    Since:
    
    5.0.0-b6
  - getSectionItems
```
public java.util.List<ISectionable> getSectionItems(IHeader header)
```
    Provides all the items that belongs to the section represented by the provided header.
    
    Parameters:
    
    header - the IHeader item that represents the section
    
    Returns:
    
    NonNull list of all items in the provided section
    
    Since:
    
    5.0.0-b6
  - getSectionItemPositions
```
public java.util.List<java.lang.Integer> getSectionItemPositions(IHeader header)
```
    Provides all the item positions that belongs to the section represented by the provided header.
    
    Parameters:
    
    header - the IHeader item that represents the section
    
    Returns:
    
    NonNull list of all item positions in the provided section
    
    Since:
    
    5.0.0-b8
  - areHeadersShown
```
public boolean areHeadersShown()
```
    Evaluates if Adapter has headers shown.
    
    Returns:
    
    true if all headers are currently displayed, false otherwise
    
    Since:
    
    5.0.0-b6
  - areHeadersSticky
```
public boolean areHeadersSticky()
```
    Evaluates if Adapter can actually display sticky headers on the top.
    
    Returns:
    
    true if headers can be sticky, false if headers are scrolled together with all items
    
    Since:
    
    5.0.0-b6
  - getStickyPosition
```
public final int getStickyPosition()
```
    Returns the current position of the sticky header.
    
    Returns:
    
    the current sticky header position, -1 if no header is sticky
    
    Since:
    
    5.0.0-rc2
  - ensureHeaderParent
```
public final void ensureHeaderParent()
```
    Ensures the current sticky header view is correctly displayed in the sticky layout.
    
    Since:
    
    5.0.0-rc2
  - setStickyHeaders
```
public FlexibleAdapter<T> setStickyHeaders(boolean sticky)
```
    Enables/Disables the sticky header feature with default sticky layout container.
    Note:
    - You should consider to display headers with setDisplayHeadersAtStartUp(boolean): Feature can enabled/disabled freely, but if headers are hidden nothing will happen.
    - Only in case of "Sticky Header" items you must provide true to the constructor: FlexibleViewHolder.FlexibleViewHolder(View, FlexibleAdapter, boolean).
    - Optionally, you can set a custom sticky layout container that must be already inflated.
      Check setStickyHeaders(boolean, ViewGroup).
    - Optionally, you can set a layout elevation: Header item elevation is used first, if not set, default elevation of 21f pixel is used.
    - Sticky headers are clickable as any views, but cannot be dragged nor swiped.
    - Content and linkage are automatically updated.
    - Sticky layout container is fade-in and fade-out animated when feature is respectively enabled and disabled.
    - Sticky container can be elevated only if the header item layout has elevation (Do not exaggerate with elevation).
    Important! In order to display the Refresh circle AND the FastScroller on the Top of the sticky container, the RecyclerView must be wrapped with a FrameLayout as following:
```
 <FrameLayout
     android:layout_width="match_parent"
     android:layout_height="match_parent">

     <android.support.v7.widget.RecyclerView
         android:id="@+id/recycler_view"
         android:layout_width="match_parent"
         android:layout_height="match_parent"/>

 </FrameLayout>
 
```
    Parameters:
    
    sticky - true to initialize sticky headers with default container, false to disable them
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Throws:
    
    java.lang.IllegalStateException - if this Adapter was not attached to the RecyclerView
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    setStickyHeaders(boolean, ViewGroup), setDisplayHeadersAtStartUp(boolean), setStickyHeaderElevation(int)
  - setStickyHeaders
```
public FlexibleAdapter<T> setStickyHeaders(boolean sticky,
                                           android.view.ViewGroup stickyContainer)
```
    Enables/Disables the sticky header feature with a custom sticky layout container.
    Important: Read the javaDoc of the overloaded method setStickyHeaders(boolean).
    
    Parameters:
    
    sticky - true to initialize sticky headers, false to disable them
    
    stickyContainer - user defined and already inflated sticky layout that will hold the sticky header itemViews
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Throws:
    
    java.lang.IllegalStateException - if this Adapter was not attached to the RecyclerView
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    setStickyHeaders(boolean), setDisplayHeadersAtStartUp(boolean), setStickyHeaderElevation(int)
  - getStickyHeaderElevation
```
public int getStickyHeaderElevation()
```
    Gets the layout in dpi elevation for sticky header.
    Note: This setting is ignored if the header item has already an elevation. The header elevation overrides this setting.
    
    Returns:
    
    the elevation in pixel
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    setStickyHeaderElevation(int)
  - setStickyHeaderElevation
```
public FlexibleAdapter<T> setStickyHeaderElevation(int stickyElevation)
```
    Sets the elevation in dpi for the sticky header layout.
    Note: This setting is ignored if the header item has already an elevation. The header elevation overrides this setting.
    Default value is 0 dpi.
    
    Parameters:
    
    stickyElevation - the elevation in dpi
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getStickyHeaderElevation()
  - setDisplayHeadersAtStartUp
```
public FlexibleAdapter<T> setDisplayHeadersAtStartUp(boolean displayHeaders)
```
    Sets if all headers should be shown at startup by the Adapter automatically.
    If called, this method won't trigger notifyItemInserted() and scrolling animations are instead performed if the header item was configured with animation: Headers will be loaded/bound along with others items.
    Note: Headers can only be shown or hidden all together.
    Default value is false (headers are not shown at startup).
    
    Parameters:
    
    displayHeaders - true to display headers, false to keep them hidden
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    showAllHeaders(), AnimatorAdapter.setAnimationOnForwardScrolling(boolean)
  - setHeadersShown
```
public FlexibleAdapter<T> setHeadersShown(boolean headersShown)
```
    Manually change the flag to indicate that headers are inserted(or not) in the main list by the user and the Adapter doesn't(does) have to automatically insert them.
    Default value is false (headers are not shown at startup).
    
    Parameters:
    
    headersShown - true, if headers are already shown
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0
  - showAllHeaders
```
public FlexibleAdapter<T> showAllHeaders()
```
    Shows all headers in the RecyclerView at their linked position.
    If called at startup, this method will trigger notifyItemInserted for a different loading effect: Headers will be inserted after the items!
    Note: Headers can only be shown or hidden all together.
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    hideAllHeaders(), setDisplayHeadersAtStartUp(boolean)
  - hideAllHeaders
```
public void hideAllHeaders()
```
    Hides all headers from the RecyclerView.
    Headers can be shown or hidden all together.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    showAllHeaders(), setDisplayHeadersAtStartUp(boolean)
  - getItemViewType
```
public int getItemViewType(int position)
```
    You CANNOT override this method: FlexibleAdapter delegates the ViewType definition via IFlexible.getLayoutRes() so ViewTypes are automatically mapped (AutoMap).
    
    Parameters:
    
    position - position for which ViewType is requested
    
    Returns:
    
    layout resource defined in IFlexible#getLayoutRes()
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    IFlexible.getItemViewType()
  - onCreateViewHolder
```
public RecyclerView.ViewHolder onCreateViewHolder(android.view.ViewGroup parent,
                                                  int viewType)
```
    You CANNOT override this method to create the ViewHolder, FlexibleAdapter delegates the creation via IFlexible.createViewHolder().
    HELP: To know how to implement AutoMap for ViewTypes please refer to the FlexibleAdapter Wiki Page on GitHub.
    
    Returns:
    
    a new ViewHolder that holds a View of the given view type
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    IFlexible.createViewHolder(View, FlexibleAdapter)
  - onBindViewHolder
```
public void onBindViewHolder(RecyclerView.ViewHolder holder,
                             int position)
```
    You CANNOT override this method to bind the items. FlexibleAdapter delegates the binding to the corresponding item via IFlexible.bindViewHolder().
    HELP: To know how to implement AutoMap for ViewTypes please refer to the FlexibleAdapter Wiki Page on GitHub.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    IFlexible.bindViewHolder(FlexibleAdapter, RecyclerView.ViewHolder, int, List)
  - onBindViewHolder
```
public void onBindViewHolder(RecyclerView.ViewHolder holder,
                             int position,
                             java.util.List payloads)
```
    Same concept of #onBindViewHolder() but with Payload.
    
    Overrides:
    
    onBindViewHolder in class SelectableAdapter
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    IFlexible.bindViewHolder(FlexibleAdapter, RecyclerView.ViewHolder, int, List), onBindViewHolder(RecyclerView.ViewHolder, int)
  - onViewAttachedToWindow
```
public void onViewAttachedToWindow(RecyclerView.ViewHolder holder)
```
  - onViewDetachedFromWindow
```
public void onViewDetachedFromWindow(RecyclerView.ViewHolder holder)
```
  - onViewRecycled
```
public void onViewRecycled(RecyclerView.ViewHolder holder)
```
    Overrides:
    
    onViewRecycled in class SelectableAdapter
  - isTopEndless
```
public boolean isTopEndless()
```
    Returns:
    
    true if loading more will add items to the top, false to the bottom.
    
    Since:
    
    5.0.0-rc2
  - setTopEndless
```
public void setTopEndless(boolean topEndless)
```
    Sets endless scrolling from the top. All item will be added to the top of the list. Default value is false (bottom endless scrolling).
    
    Parameters:
    
    topEndless - true to enable endless scrolling from the top, false from the bottom
    
    Since:
    
    5.0.0-rc2
  - isEndlessScrollEnabled
```
public boolean isEndlessScrollEnabled()
```
    Evaluates if the Adapter is in Endless Scroll mode. When no more load, this method will return false. To enable again the progress item you MUST be set again.
    
    Returns:
    
    true if the progress item is set, false otherwise
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    setEndlessProgressItem(IFlexible)
  - getEndlessCurrentPage
```
public int getEndlessCurrentPage()
```
    Provides the current endless page if the page size limit is set, if not set the returned value is always 0.
    
    Returns:
    
    the current endless page
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getEndlessPageSize(), setEndlessPageSize(int)
  - getEndlessPageSize
```
public int getEndlessPageSize()
```
    The current setting for the endless page size limit.
    Tip: This limit is ignored if value is 0.
    
    Returns:
    
    the page size limit, if the limit is not set, 0 is returned.
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getEndlessCurrentPage(), setEndlessPageSize(int)
  - setEndlessPageSize
```
public FlexibleAdapter<T> setEndlessPageSize(int endlessPageSize)
```
    Sets the limit to automatically disable the endless feature when coming items size is less than the page size.
    When endless feature is disabled a #notifyItemChanged(int, Object) with payload Payload.NO_MORE_LOAD will be triggered on the progressItem, so you can display a message or change the views in this item.
    Default value is 0 (limit is ignored).
    
    Parameters:
    
    endlessPageSize - the size limit for each page
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-rc1
  - getEndlessTargetCount
```
public int getEndlessTargetCount()
```
    The current setting for the endless target item count limit.
    Tip: This limit is ignored if value is 0.
    
    Returns:
    
    the target items count limit, if the limit is not set, 0 is returned.
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    setEndlessTargetCount(int)
  - setEndlessTargetCount
```
public FlexibleAdapter<T> setEndlessTargetCount(int endlessTargetCount)
```
    Sets the limit to automatically disable the endless feature when the total items count in the Adapter is equals or bigger than the target count.
    When endless feature is disabled a #notifyItemChanged(int, Object) with payload Payload.NO_MORE_LOAD will be triggered on the progressItem, so you can display a message or change the views in this item.
    Default value is 0 (limit is ignored).
    
    Parameters:
    
    endlessTargetCount - the total items count limit
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    getEndlessTargetCount()
  - setLoadingMoreAtStartUp
```
public FlexibleAdapter<T> setLoadingMoreAtStartUp(boolean enable)
```
    Sets if Endless / Loading More should be triggered at start-up, especially when the list is empty.
    Default value is false.
    
    Parameters:
    
    enable - true to trigger a loading at start up, false to trigger loading with binding
    
    Returns:
    
    this Adapter, so the call can be chained
  - setEndlessProgressItem
```
public FlexibleAdapter<T> setEndlessProgressItem(T progressItem)
```
    Sets the progressItem to be displayed at the end of the list and activate the Loading More feature.
    Using this method, the FlexibleAdapter.EndlessScrollListener won't be called so that you can handle a click event to load more items upon a user request.
    To correctly implement "Load more upon a user request" check the Wiki page of this library.
    
    Parameters:
    
    progressItem - the item representing the progress bar
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b8
    
    See Also:
    
    isEndlessScrollEnabled(), setEndlessScrollListener(EndlessScrollListener, IFlexible)
  - setEndlessScrollListener
```
public FlexibleAdapter<T> setEndlessScrollListener(FlexibleAdapter.EndlessScrollListener endlessScrollListener,
                                                   T progressItem)
```
    Sets the progressItem to be displayed at the end of the list and Sets the callback to automatically load more items asynchronously(your duty) (no further user action is needed but the scroll).
    
    Parameters:
    
    endlessScrollListener - the callback to invoke the asynchronous loading
    
    progressItem - the item representing the progress bar
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    isEndlessScrollEnabled(), setEndlessProgressItem(IFlexible)
  - setEndlessScrollThreshold
```
public FlexibleAdapter<T> setEndlessScrollThreshold(int thresholdItems)
```
    Sets the minimum number of items still to bind to start the automatic loading.
    Default value is 1.
    
    Parameters:
    
    thresholdItems - minimum number of unbound items to start loading more items
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
  - onLoadMore
```
protected void onLoadMore(int position)
```
    This method is called automatically when an item is bound.
    
    Parameters:
    
    position - the current binding position
    
    Since:
    
    5.0.0-b6
    5.0.0-rc1 Added limits check and progressItem with Scrollable Footers
  - onLoadMoreComplete
```
public void onLoadMoreComplete(java.util.List<T> newItems)
```
    To call when more items are successfully loaded.
    When noMoreLoad OR onError OR onCancel, pass empty list or null to hide the progressItem.
    In this case the ProgressItem is removed immediately.
    
    Parameters:
    
    newItems - the list of the new items, can be empty or null
    
    Since:
    
    5.0.0-b6
  - onLoadMoreComplete
```
public void onLoadMoreComplete(java.util.List<T> newItems,
                               long delay)
```
    Call this method to complete the action of the Loading more items.
    When noMoreLoad OR onError OR onCancel, pass empty list or null to hide the progressItem. When limits are set, endless feature will be disabled. To enable again call setEndlessProgressItem(IFlexible).
    Optionally you can pass a delay time to still display the item with the latest information inside. The message has to be handled inside the bindViewHolder of the item.
    A #notifyItemChanged(int, Object) with payload Payload.NO_MORE_LOAD will be triggered on the progressItem, so you can display a message or change the views in this item.
    
    Parameters:
    
    newItems - the list of the new items, can be empty or null
    
    delay - the delay used to remove the progress item or -1 to disable the loading forever and to keep the progress item visible.
    
    Since:
    
    5.0.0-b8
    5.0.0-rc1 Added limits check and changed progressItem to Scrollable Footer
    5.0.0-rc2 Added Top Endless
  - isAutoCollapseOnExpand
```
public boolean isAutoCollapseOnExpand()
```
    Returns:
    
    true if collapseOnExpand is enabled, false otherwise
    
    Since:
    
    5.0.0-b8
  - setAutoCollapseOnExpand
```
public FlexibleAdapter<T> setAutoCollapseOnExpand(boolean collapseOnExpand)
```
    Automatically collapse all previous expanded parents before expand the new clicked parent.
    Default value is false (disabled).
    Tip: This parameter works in collaboration with setMinCollapsibleLevel(int).
    
    Parameters:
    
    collapseOnExpand - true to collapse others items, false to just expand the current
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setMinCollapsibleLevel(int)
  - isRecursiveCollapse
```
public boolean isRecursiveCollapse()
```
    Returns:
    
    true if collapseSubLevels is enabled, false otherwise
    
    Since:
    
    5.0.0-rc3
  - setRecursiveCollapse
```
public FlexibleAdapter<T> setRecursiveCollapse(boolean collapseSubLevels)
```
    Automatically collapse all inner sub expandable when higher parent is collapsed.
    By keeping this parameter false, their expanded status remains expanded=true so when the higher parent is expanded again, the sub expandables will appear again expanded.
    Default value is false (keep expanded status).
    Tip: This parameter works in collaboration with setMinCollapsibleLevel(int).
    
    Parameters:
    
    collapseSubLevels - true to allow inner sub expandable to collapse, false to keep the expanded status
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-rc3
    
    See Also:
    
    setMinCollapsibleLevel(int)
  - isAutoScrollOnExpand
```
public boolean isAutoScrollOnExpand()
```
    Returns:
    
    true if scrollOnExpand is enabled, false otherwise
    
    Since:
    
    5.0.0-b8
  - setAutoScrollOnExpand
```
public FlexibleAdapter<T> setAutoScrollOnExpand(boolean scrollOnExpand)
```
    Automatically scroll the clicked expandable item to the first visible position.
    
    Default value is false (disabled).
    Note: This works ONLY in combination with SmoothScrollLinearLayoutManager or with SmoothScrollGridLayoutManager available in UI extension.
    
    Parameters:
    
    scrollOnExpand - true to enable automatic scroll, false to disable
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
  - isExpanded
```
public boolean isExpanded(int position)
```
    Parameters:
    
    position - the position of the item to check
    
    Returns:
    
    true if the item implements IExpandable interface and its property has expanded = true
    
    Since:
    
    5.0.0-b1
  - isExpanded
```
public boolean isExpanded(T item)
```
    Checks if the provided item is an IExpandable instance and is expanded.
    
    Parameters:
    
    item - the item to check
    
    Returns:
    
    true if the item implements IExpandable interface and its property has expanded = true
    
    Since:
    
    5.0.0-b1
  - isExpandable
```
public boolean isExpandable(T item)
```
    Checks if the provided item is an IExpandable instance.
    
    Parameters:
    
    item - the item to check
    
    Returns:
    
    true if the item implements IExpandable interface, false otherwise
    
    Since:
    
    5.0.0-b1
  - getMinCollapsibleLevel
```
public int getMinCollapsibleLevel()
```
    Returns:
    
    the level of the minimum collapsible level used in MultiLevel expandable
    
    Since:
    
    5.0.0-b6
  - setMinCollapsibleLevel
```
public FlexibleAdapter<T> setMinCollapsibleLevel(int minCollapsibleLevel)
```
    Sets the minimum level which all sub expandable items will be collapsed too.
    Default value is mMinCollapsibleLevel (All levels including 0).
    Tip: This parameter works in collaboration with setRecursiveCollapse(boolean).
    
    Parameters:
    
    minCollapsibleLevel - the minimum level to auto-collapse sub expandable items
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    setRecursiveCollapse(boolean)
  - hasSubItems
```
public boolean hasSubItems(IExpandable expandable)
```
    Utility method to check if the expandable item has sub items.
    
    Parameters:
    
    expandable - the IExpandable object
    
    Returns:
    
    true if the expandable has subItems, false otherwise
    
    Since:
    
    5.0.0-b1
  - getExpandableOf
```
public IExpandable getExpandableOf(int position)
```
    Retrieves the parent of a child for the provided position.
    Only for a real child of an expanded parent.
    
    Parameters:
    
    position - the position of the child item
    
    Returns:
    
    the parent of this child item or null if item has no parent
    
    Since:
    
    5.0.0-b1
  - getExpandableOf
```
public IExpandable getExpandableOf(T child)
```
    Retrieves the parent of a child.
    Only for a real child of an expanded parent.
    
    Parameters:
    
    child - the child item
    
    Returns:
    
    the parent of this child item or null if item has no parent
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getExpandablePositionOf(IFlexible), getSubPositionOf(IFlexible)
  - getExpandablePositionOf
```
public int getExpandablePositionOf(T child)
```
    Retrieves the parent position of a child.
    Only for a real child of an expanded parent.
    
    Parameters:
    
    child - the child item
    
    Returns:
    
    the parent position of this child item or -1 if not found
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getExpandableOf(IFlexible), getSubPositionOf(IFlexible)
  - getSubPositionOf
```
public int getSubPositionOf(T child)
```
    Retrieves the sub position of any sub item in the section where it lays. First position corresponds to 0.
    Works for items under header and under expandable too.
    
    Parameters:
    
    child - any sub item of any section
    
    Returns:
    
    the position in the parent or -1 if the child is a parent/header itself or not found
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getSameTypePositionOf(IFlexible), getExpandableOf(IFlexible), getExpandablePositionOf(IFlexible)
  - getSiblingsOf
```
public java.util.List<T> getSiblingsOf(T child)
```
    Provides the full sub list where the child currently lays.
    
    Parameters:
    
    child - the child item
    
    Returns:
    
    the list of the child element, or an empty list if the child item has no parent
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getExpandableOf(IFlexible), getExpandablePositionOf(IFlexible), getSubPositionOf(IFlexible), getExpandedItems()
  - getExpandedItems
```
public java.util.List<T> getExpandedItems()
```
    Provides a list of all expandable items that are currently expanded.
    
    Returns:
    
    a list with all expanded items
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getSiblingsOf(IFlexible), getExpandedPositions()
  - getExpandedPositions
```
public java.util.List<java.lang.Integer> getExpandedPositions()
```
    Provides a list of all expandable positions that are currently expanded.
    
    Returns:
    
    a list with the global positions of all expanded items
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getSiblingsOf(IFlexible), getExpandedItems()
  - expand
```
public int expand(int position)
```
    Expands an item that is IExpandable type, not yet expanded and if has subItems.
    If configured, automatic smooth scroll will be performed when necessary.
    Parent won't be notified.
    
    Parameters:
    
    position - the position of the item to expand
    
    Returns:
    
    the number of subItems expanded
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    expand(int, boolean), expand(IFlexible), expand(IFlexible, boolean), expandAll()
  - expand
```
public int expand(int position,
                  boolean notifyParent)
```
    Expands an item that is IExpandable type, not yet expanded and if has subItems.
    If configured, automatic smooth scroll will be performed when necessary.
    
    Parameters:
    
    position - the position of the item to expand
    
    notifyParent - true to notify the parent with Payload.EXPANDED
    
    Returns:
    
    the number of subItems expanded
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    expand(int), expand(IFlexible), expand(IFlexible, boolean), expandAll()
  - expand
```
public int expand(T item)
```
    Convenience method to expand a single item. Parent will be notified.
    Expands an item that is Expandable, not yet expanded, that has subItems and no child is selected.
    If configured, automatic smooth scroll will be performed.
    
    Parameters:
    
    item - the item to expand, must be an Expandable and present in the list
    
    Returns:
    
    the number of subItems expanded
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    expand(int), expand(int, boolean), expand(IFlexible, boolean), expandAll()
  - expand
```
public int expand(T item,
                  boolean init)
```
    Convenience method to initially expand a single item. Parent won't be notified.
    Note: Must be used in combination when adding new items, those require to be initially expanded.
    WARNING!
    Expanded status is ignored if init = true: it will always attempt to expand the item: If subItems are already visible and the new item has status expanded, the subItems will appear duplicated(!) and the automatic smooth scroll will be skipped!
    
    Parameters:
    
    item - the item to expand, must be an Expandable and present in the list
    
    init - true to initially expand item
    
    Returns:
    
    the number of subItems expanded
    
    Since:
    
    5.0.0-b7
    
    See Also:
    
    expand(int), expand(int, boolean), expand(IFlexible), expandAll()
  - expandAll
```
public int expandAll()
```
    Expands all IExpandable items with minimum of level mMinCollapsibleLevel.
    
    Returns:
    
    the number of parent successfully expanded
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    expandAll(int), setMinCollapsibleLevel(int)
  - expandAll
```
public int expandAll(int level)
```
    Expands all IExpandable items with at least the specified level.
    Parents will be notified.
    
    Parameters:
    
    level - the minimum level to expand the sub expandable items
    
    Returns:
    
    the number of parent successfully expanded
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    expandAll(), setMinCollapsibleLevel(int)
  - collapse
```
public int collapse(int position)
```
    Collapses an IExpandable item that is already expanded and if no subItem is selected.
    Multilevel option behaviours:
    - IExpandable subItems, that are expanded, can be recursively collapsed, see setRecursiveCollapse(boolean).
    - You can set the minimum level to auto-collapse siblings, see setMinCollapsibleLevel(int).
    Parent won't be notified.
    Parameters:
    
    position - the position of the item to collapse
    
    Returns:
    
    the number of subItems collapsed
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    collapseAll()
  - collapse
```
public int collapse(int position,
                    boolean notifyParent)
```
    Same behaviors as collapse(int) with possibility to notify/update the parent.
    
    Parameters:
    
    position - the position of the item to collapse
    
    notifyParent - notify the parent with Payload.COLLAPSED
    
    Returns:
    
    the number of subItems collapsed
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    collapseAll()
  - collapseAll
```
public int collapseAll()
```
    Collapses all expandable items with the minimum level of mMinCollapsibleLevel.
    
    Returns:
    
    the number of parent successfully collapsed
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    collapse(int, boolean), collapseAll(int), setMinCollapsibleLevel(int)
  - collapseAll
```
public int collapseAll(int level)
```
    Collapses all expandable items with the level equals-higher than the specified level.
    Parents will be notified.
    
    Parameters:
    
    level - the level to start collapse sub expandable items
    
    Returns:
    
    the number of parent successfully collapsed
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    collapseAll()
  - updateItem
```
public void updateItem(T item)
```
    Updates/Rebounds the itemView corresponding to the current position of the provided item with the new content.
    
    Parameters:
    
    item - the item with the new content
    
    Since:
    
    2.1.0
    
    See Also:
    
    updateItem(IFlexible, Object), updateItem(int, IFlexible, Object)
  - updateItem
```
public void updateItem(T item,
                       java.lang.Object payload)
```
    Updates/Rebounds the itemView corresponding to the current position of the provided item with the new content.
    
    Parameters:
    
    item - the item with the new content
    
    payload - any non-null user object to notify the current item (the payload will be therefore passed to the bind method of the item ViewHolder to optimize the content to update); pass null to rebind all fields of this item.
    
    Since:
    
    2.1.0
    
    See Also:
    
    updateItem(IFlexible), updateItem(int, IFlexible, Object)
  - updateItem
```
public void updateItem(int position,
                       T item,
                       java.lang.Object payload)
```
    Updates/Rebounds the itemView corresponding to the current position of the provided item with the new content. Use updateItem(IFlexible, Object) if the new content should be bound on the same position.
    
    Parameters:
    
    position - the position where the new content should be updated and rebound
    
    item - the item with the new content
    
    payload - any non-null user object to notify the current item (the payload will be therefore passed to the bind method of the item ViewHolder to optimize the content to update); pass null to rebind all fields of this item.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    updateItem(IFlexible), updateItem(IFlexible, Object)
  - addItemWithDelay
```
public void addItemWithDelay(int position,
                             T item,
                             long delay,
                             boolean scrollToPosition)
```
    Inserts the given item at desired position or Add item at last position with a delay and auto-scroll to the position.
    Scrolling animation is automatically preserved, meaning that, notification for animation is ignored.
    Useful at startup, when there's an item to add after Adapter Animations is completed.
    
    Parameters:
    
    position - position of the item to add
    
    item - the item to add
    
    delay - a non-negative delay
    
    scrollToPosition - true if RecyclerView should scroll after item has been added, false otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    addItem(int, IFlexible), addItems(int, List), addSubItems(int, int, IExpandable, List, boolean, Object), removeItemWithDelay(IFlexible, long, boolean)
  - addItem
```
public boolean addItem(T item)
```
    Simply append the provided item to the end of the list.
    Convenience method of addItem(int, IFlexible) with position = getMainItemCount().
    
    Parameters:
    
    item - the item to add
    
    Returns:
    
    true if the internal list was successfully modified, false otherwise
  - addItem
```
public boolean addItem(int position,
                       T item)
```
    Inserts the given item at the specified position or Adds the item to the end of the list (no matters if the new position is out of bounds!).
    
    Parameters:
    
    position - position inside the list, if negative, items will be added to the end
    
    item - the item to add
    
    Returns:
    
    true if the internal list was successfully modified, false otherwise
    
    Since:
    
    1.0.0
    
    See Also:
    
    addItem(IFlexible), addItems(int, List), addSubItems(int, int, IExpandable, List, boolean, Object), addItemWithDelay(int, IFlexible, long, boolean)
  - addItems
```
public boolean addItems(int position,
                        java.util.List<T> items)
```
    Inserts a set of items at specified position or Adds the items to the end of the list (no matters if the new position is out of bounds!).
    Note:
    - When all headers are shown, if exists, the header of this item will be shown as well, unless it's already shown, so it won't be shown twice.
    - Items will be always added between any scrollable header and footers.
    
    Parameters:
    
    position - position inside the list, if negative, items will be added to the end
    
    items - the set of items to add
    
    Returns:
    
    true if the internal list was successfully modified, false otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    addItem(IFlexible), addItem(int, IFlexible), addSubItems(int, int, IExpandable, List, boolean, Object)
  - addSubItem
```
public boolean addSubItem(int parentPosition,
                          int subPosition,
                          T item)
```
    Convenience method of addSubItem(int, int, IFlexible, boolean, Object).
    In this case parent item will never be expanded if it is collapsed.
    
    Returns:
    
    true if the internal list was successfully modified, false otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    addSubItems(int, int, IExpandable, List, boolean, Object)
  - addSubItem
```
public boolean addSubItem(int parentPosition,
                          int subPosition,
                          T item,
                          boolean expandParent,
                          java.lang.Object payload)
```
    Convenience method of addSubItems(int, int, IExpandable, List, boolean, Object).
    Optionally you can pass any payload to notify the parent about the change and optimize the view binding.
    
    Parameters:
    
    parentPosition - position of the expandable item that shall contain the subItem
    
    subPosition - the position of the subItem in the expandable list
    
    item - the subItem to add in the expandable list
    
    expandParent - true to initially expand the parent (if needed) and after to add the subItem, false to simply add the subItem to the parent
    
    payload - any non-null user object to notify the parent (the payload will be therefore passed to the bind method of the parent ViewHolder), pass null to not notify the parent
    
    Returns:
    
    true if the internal list was successfully modified, false otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    addSubItems(int, int, IExpandable, List, boolean, Object)
  - addSubItems
```
public boolean addSubItems(int parentPosition,
                           int subPosition,
                           java.util.List<T> items)
```
    Convenience method of addSubItems(int, int, List, boolean, Object).
    In this case parent item will never be expanded if it is collapsed.
    
    Returns:
    
    true if the internal list was successfully modified, false otherwise
    
    Since:
    
    5.0.0-rc3
    
    See Also:
    
    addSubItems(int, int, IExpandable, List, boolean, Object)
  - addSubItems
```
public boolean addSubItems(int parentPosition,
                           int subPosition,
                           java.util.List<T> items,
                           boolean expandParent,
                           java.lang.Object payload)
```
    Convenience method of addSubItems(int, int, IExpandable, List, boolean, Object).
    Optionally you can pass any payload to notify the parent about the change and optimize the view binding.
    
    Parameters:
    
    parentPosition - position of the expandable item that shall contain the subItems
    
    subPosition - the start position in the parent where the new items shall be inserted
    
    items - the list of the subItems to add
    
    expandParent - true to initially expand the parent (if needed) and after to add the subItems, false to simply add the subItems to the parent
    
    payload - any non-null user object to notify the parent (the payload will be therefore passed to the bind method of the parent ViewHolder), pass null to not notify the parent
    
    Returns:
    
    true if the internal list was successfully modified, false otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    addSubItems(int, int, IExpandable, List, boolean, Object)
  - addSection
```
public int addSection(IHeader header)
```
    Adds and shows an empty section to the top (position = 0).
    
    Returns:
    
    the calculated position for the new item
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    addSection(IHeader, Comparator)
  - addSection
```
public int addSection(IHeader header,
                      java.util.Comparator<IFlexible> comparator)
```
    Adds and shows an empty section. The new section is a IHeader item and the position is calculated after sorting the data set.
    - To add Sections to the top, set null the Comparator object or simply call addSection(IHeader);
    - To add Sections to the bottom or in the middle, implement a Comparator object able to support all the item types this Adapter is displaying or a ClassCastException will be raised.
    
    Parameters:
    
    header - the section header item to add
    
    comparator - the criteria to sort the Data Set used to extract the correct position of the new header
    
    Returns:
    
    the calculated position for the new item
    
    Since:
    
    5.0.0-b7
  - addItemToSection
```
public int addItemToSection(ISectionable sectionable,
                            IHeader header,
                            java.util.Comparator<IFlexible> comparator)
```
    Adds a new item in a section when the relative position is unknown.
    The header can be a IExpandable type or IHeader type.
    The Comparator object must support all the item types this Adapter is displaying or a ClassCastException will be raised.
    
    Parameters:
    
    sectionable - the item to add
    
    header - the section receiving the new item
    
    comparator - the criteria to sort the sectionItems used to extract the correct position of the new item in the section
    
    Returns:
    
    the calculated final position for the new item
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    addItemToSection(ISectionable, IHeader, int)
  - addItemToSection
```
public int addItemToSection(ISectionable sectionable,
                            IHeader header,
                            int index)
```
    Adds a new item in a section when the relative position is known.
    The header can be a IExpandable type or IHeader type.
    
    Parameters:
    
    sectionable - the item to add
    
    header - the section receiving the new item
    
    index - the known relative position where to add the new item into the section
    
    Returns:
    
    the calculated final position for the new item
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    addItemToSection(ISectionable, IHeader, Comparator)
  - clear
```
public void clear()
```
    This method clears everything: main items, Scrollable Headers and Footers and everything else is displayed.
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    clearAllBut(Integer...), removeRange(int, int), removeItemsOfType(Integer...)
  - clearAllBut
```
public void clearAllBut(java.lang.Integer... viewTypes)
```
    Clears the Adapter list retaining Scrollable Headers and Footers and all items of the type provided as parameter.
    Tip:- This method is opposite of removeItemsOfType(Integer...).
    
    Parameters:
    
    viewTypes - the viewTypes to retain
    
    Since:
    
    5.0.0-rc1
    
    See Also:
    
    clear(), removeItems(List), removeItemsOfType(Integer...)
  - removeItemWithDelay
```
public void removeItemWithDelay(T item,
                                long delay,
                                boolean permanent)
```
    Removes the given item after the given delay.
    Scrolling animation is automatically preserved, meaning that notification for animation is ignored.
    
    Parameters:
    
    item - the item to add
    
    delay - a non-negative delay
    
    permanent - true to permanently delete the item (no undo), false otherwise
    
    Since:
    
    5.0.0-b7
    
    See Also:
    
    removeItem(int), removeItems(List), removeItemsOfType(Integer...), removeRange(int, int), removeAllSelectedItems(), addItemWithDelay(int, IFlexible, long, boolean)
  - removeSection
```
public void removeSection(IHeader header)
```
    Removes all items of a section, header included.
    For header that is also expandable, it's equivalent to remove a single item.
    
    Parameters:
    
    header - the head of the section
    
    Since:
    
    5.0.5
    
    See Also:
    
    removeItem(int)
  - removeItem
```
public void removeItem(int position)
```
    Convenience method of removeItem(int, Object) providing Payload.CHANGE as payload for the parent item.
    
    Parameters:
    
    position - the position of item to remove
    
    Since:
    
    1.0.0
    
    See Also:
    
    removeItems(List), removeItemsOfType(Integer...), removeRange(int, int), removeAllSelectedItems(), removeItemWithDelay(IFlexible, long, boolean), removeItem(int, Object)
  - removeItem
```
public void removeItem(int position,
                       java.lang.Object payload)
```
    Removes an item from the internal list and notify the change.
    The item is retained for an eventual Undo.
    This method delegates the removal to removeRange.
    
    Parameters:
    
    position - The position of item to remove
    
    payload - any non-null user object to notify the parent (the payload will be therefore passed to the bind method of the parent ViewHolder), pass null to not notify the parent
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    removeItems(List, Object), removeRange(int, int, Object), removeAllSelectedItems(Object), removeItem(int)
  - removeItems
```
public void removeItems(java.util.List<java.lang.Integer> selectedPositions)
```
    Convenience method of removeItems(List, Object) providing the default Payload.CHANGE for the parent items.
    
    Since:
    
    1.0.0
    
    See Also:
    
    removeItem(int), removeItemsOfType(Integer...), removeRange(int, int), removeAllSelectedItems(), removeItems(List, Object)
  - removeItems
```
public void removeItems(java.util.List<java.lang.Integer> selectedPositions,
                        java.lang.Object payload)
```
    Removes items by ranges, auto-collapse expanded items and notify the change.
    Every item is retained for an eventual Undo.
    Optionally you can pass any payload to notify the parent items about the change to optimize the view binding.
    This method delegates the removal to removeRange.
    
    Parameters:
    
    selectedPositions - list with item positions to remove
    
    payload - any non-null user object to notify the parent (the payload will be therefore passed to the bind method of the parent ViewHolder), pass null to not notify the parent
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    removeItem(int, Object), removeRange(int, int, Object), removeAllSelectedItems(Object), removeItems(List)
  - removeItemsOfType
```
public void removeItemsOfType(java.lang.Integer... viewTypes)
```
    Selectively removes all items of the type provided as parameter.
    Tips:
    - This method is opposite of clearAllBut(Integer...).
    - View types of Scrollable Headers and Footers are ignored!
    
    Parameters:
    
    viewTypes - the viewTypes to remove
    
    Since:
    
    5.0.0-b5
    
    See Also:
    
    clear(), clearAllBut(Integer...), removeItem(int, Object), removeItems(List), removeAllSelectedItems()
  - removeRange
```
public void removeRange(int positionStart,
                        int itemCount)
```
    Same as removeRange(int, int, Object), but in this case the parent will not be notified about the change, if children are removed.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    clear(), clearAllBut(Integer...), removeItem(int, Object), removeItems(List), removeItemsOfType(Integer...), removeAllSelectedItems(), removeRange(int, int, Object)
  - removeRange
```
public void removeRange(int positionStart,
                        int itemCount,
                        java.lang.Object payload)
```
    Removes a list of consecutive items and notify the change.
    If the item, resulting from the provided position:
    - is not expandable with no parent, it is removed as usual.
    - is not expandable with a parent, it is removed only if the parent is expanded.
    - is expandable implementing IExpandable, it is removed as usual, but it will be collapsed if expanded.
    - has a IHeader item, the header will be automatically linked to the first item after the range or can remain orphan.
    Optionally you can pass any payload to notify the parent or the header about the change and optimize the view binding.
    
    Parameters:
    
    positionStart - the start position of the first item
    
    itemCount - how many items should be removed
    
    payload - any non-null user object to notify the parent (the payload will be therefore passed to the bind method of the parent ViewHolder), pass null to not notify the parent
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    clear(), clearAllBut(Integer...), removeItem(int, Object), removeItems(List, Object), removeRange(int, int), removeAllSelectedItems(Object), setPermanentDelete(boolean), setRestoreSelectionOnUndo(boolean), getDeletedItems(), getDeletedChildren(IExpandable), restoreDeletedItems(), emptyBin()
  - removeAllSelectedItems
```
public void removeAllSelectedItems()
```
    Convenience method to remove all items that are currently selected.
    Parent will not be notified about the change if a child is removed.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    clear(), clearAllBut(Integer...), removeItem(int), removeItems(List), removeRange(int, int), removeItemsOfType(Integer...), removeAllSelectedItems(Object)
  - removeAllSelectedItems
```
public void removeAllSelectedItems(java.lang.Object payload)
```
    Convenience method to remove all items that are currently selected.
    Optionally, the parent item can be notified about the change if a child is removed, by providing any non-null payload.
    
    Parameters:
    
    payload - any non-null user object to notify the parent (the payload will be therefore passed to the bind method of the parent ViewHolder), pass null to not notify the parent
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    clear(), clearAllBut(Integer...), removeItem(int, Object), removeItems(List, Object), removeRange(int, int, Object), removeAllSelectedItems()
  - isPermanentDelete
```
public boolean isPermanentDelete()
```
    Returns if items will be deleted immediately when deletion is requested.
    Default value is true (Undo mechanism is disabled).
    
    Returns:
    
    true if the items are deleted immediately, false if items are retained for an eventual restoration
    
    Since:
    
    5.0.0-b6
  - setPermanentDelete
```
public FlexibleAdapter<T> setPermanentDelete(boolean permanentDelete)
```
    Sets if the deleted items should be deleted immediately or if Adapter should cache them to restore them when requested by the user.
    Default value is true (Undo mechanism is disabled).
    
    Parameters:
    
    permanentDelete - true to delete items forever, false to use the cache for Undo feature
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b6
  - isRestoreWithSelection
```
public boolean isRestoreWithSelection()
```
    Returns the current configuration to restore selections on Undo.
    Default value is false (selection is NOT restored).
    
    Returns:
    
    true if selection will be restored, false otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setRestoreSelectionOnUndo(boolean)
  - setRestoreSelectionOnUndo
```
public FlexibleAdapter<T> setRestoreSelectionOnUndo(boolean restoreSelection)
```
    Gives the possibility to restore the selection on Undo, when restoreDeletedItems() is called.
    To use in combination with ActionMode in order to not disable it.
    Default value is false (selection is NOT restored).
    
    Parameters:
    
    restoreSelection - true to have restored items still selected, false to empty selections
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
  - restoreDeletedItems
```
public void restoreDeletedItems()
```
    Restore items just removed.
    Tip: If filter is active, only items that match that filter will be shown(restored).
    
    Since:
    
    3.0.0
    
    See Also:
    
    setRestoreSelectionOnUndo(boolean)
  - confirmDeletion
```
public void confirmDeletion()
```
    Performs removal confirmation and cleans memory by synchronizing the internal list from deletion.
    Note: This method is automatically called after timer is over in UndoHelper.
    
    Since:
    
    5.0.1
  - emptyBin
```
public void emptyBin()
```
    Cleans memory from items just removed.
    Note: This method is automatically called after timer is over in UndoHelper and after a restoration.
    
    Since:
    
    3.0.0
  - isRestoreInTime
```
public final boolean isRestoreInTime()
```
    Returns:
    
    true if the restore list is not empty, false otherwise
    
    Since:
    
    4.0.0
  - getDeletedItems
```
public java.util.List<T> getDeletedItems()
```
    Returns:
    
    the list of deleted items
    
    Since:
    
    4.0.0
  - getUndoPositions
```
public java.util.List<java.lang.Integer> getUndoPositions()
```
    Returns:
    
    the list of positions to undo
    
    Since:
    
    5.0.0-rc4
  - saveUndoPositions
```
public void saveUndoPositions(java.util.List<java.lang.Integer> undoPositions)
```
    Parameters:
    
    undoPositions - the positions to Undo with UndoHelper when Action.UPDATE.
    
    Since:
    
    5.0.0-rc4
  - getExpandableOfDeletedChild
```
public final IExpandable getExpandableOfDeletedChild(T child)
```
    Retrieves the expandable of the deleted child.
    
    Parameters:
    
    child - the deleted child
    
    Returns:
    
    the expandable(parent) of this child, or null if no parent found.
    
    Since:
    
    5.0.0-b1
  - getDeletedChildren
```
public final java.util.List<T> getDeletedChildren(IExpandable expandable)
```
    Retrieves only the deleted children of the specified parent.
    
    Parameters:
    
    expandable - the parent item
    
    Returns:
    
    the list of deleted children
    
    Since:
    
    5.0.0-b1
  - getCurrentChildren
```
public final java.util.List<T> getCurrentChildren(IExpandable expandable)
```
    Retrieves all the original children of the specified parent, filtering out all the deleted children if any.
    
    Parameters:
    
    expandable - the parent item
    
    Returns:
    
    a non-null list of the original children minus the deleted children if some are pending removal.
    
    Since:
    
    5.0.0-b1
  - hasFilter
```
public boolean hasFilter()
```
    Returns:
    
    true if the current filter is not null
    
    Since:
    
    5.0.0
  - hasNewFilter
```
public boolean hasNewFilter(java.io.Serializable constraint)
```
    Checks if the filter is changed.
    
    Parameters:
    
    constraint - the new filter entity
    
    Returns:
    
    true if the old filter is different than the new one, false if not changed
    
    Since:
    
    5.0.0
  - setFilter
```
public void setFilter(java.io.Serializable filter)
```
    Sets the new filter entity.
    Note:
    - Filter object must implement Serializable (String does).
    - In case of free text (String), filter is automatically trimmed and lowercase.
    Tip: You can highlight filtered Text or Words using FlexibleUtils from UI extension:
    - FlexibleUtils#highlightText(TextView, String, String)
    - FlexibleUtils#highlightWords(TextView, String, String)
    Parameters:
    
    filter - the new filter entity for the items
    
    Since:
    
    5.0.0
  - getFilter
```
public <F extends java.io.Serializable> F getFilter(java.lang.Class<F> clazz)
```
    Gets the current filter.
    
    Parameters:
    
    clazz - The class type of filter to return (eg. String.class)
    
    Returns:
    
    the current filter entity
    
    Throws:
    
    java.lang.ClassCastException - if the class type doesn't match with the filter type previously set
    
    Since:
    
    5.0.0
  - setNotifyChangeOfUnfilteredItems
```
public final FlexibleAdapter<T> setNotifyChangeOfUnfilteredItems(boolean notifyChange)
```
    With this setting, we can skip the check of the implemented method IFlexible.shouldNotifyChange(IFlexible).
    By setting false all items will be skipped by an update.
    Default value is true (items will always be notified of a change).
    
    Parameters:
    
    notifyChange - true to trigger #notifyItemChanged(int), false to not update the items' content.
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
  - setNotifyMoveOfFilteredItems
```
public final FlexibleAdapter<T> setNotifyMoveOfFilteredItems(boolean notifyMove)
```
    This method performs a further step to nicely animate the moved items. When false, the items are not moved but removed, to be added at the correct position.
    The process is very slow on big list of the order of ~3-5000 items and higher, due to the calculation of the correct position for each item to be shifted. Use with caution!
    The slowness is higher when the filter is cleared out.
    Default value is false.
    
    Parameters:
    
    notifyMove - true to animate move changes after filtering or update data set, false otherwise
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b8
  - filterItems
```
public void filterItems()
```
    Filters the current list with the filter previously set with setFilter(Serializable).
    
    Since:
    
    5.0.0-rc2
    
    See Also:
    
    filterItems(long), filterItems(List), onPostFilter(), setAnimateToLimit(int)
  - filterItems
```
public void filterItems(long delay)
```
    Same as filterItems() but with a delay in the execution, useful to grab more characters from user before starting the search.
    
    Parameters:
    
    delay - any non-negative delay
    
    Since:
    
    5.0.0-rc2
    
    See Also:
    
    setFilter(Serializable), filterItems(), filterItems(List, long), onPostFilter(), setAnimateToLimit(int)
  - filterItems
```
public void filterItems(java.util.List<T> unfilteredItems,
                        long delay)
```
    WATCH OUT! ADAPTER ALREADY CREATES A COPY OF THE PROVIDED LIST: due to internal mechanism, items are removed and/or added in order to animate items in the final list.
    Same as filterItems(List), but with a delay in the execution, useful to grab more characters from user before starting the search.
    
    Parameters:
    
    unfilteredItems - the list to filter
    
    delay - any non-negative delay
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setFilter(Serializable), filterItems(long), filterItems(List), onPostFilter(), setAnimateToLimit(int)
  - filterItems
```
public void filterItems(java.util.List<T> unfilteredItems)
```
    WATCH OUT! ADAPTER ALREADY CREATES A COPY OF THE PROVIDED LIST: due to internal mechanism, items are removed and/or added in order to animate items in the final list.
    This method filters the provided list with the filter previously set with setFilter(Serializable). Filter object can be of any type.
    Important notes:
    1. The Filter is always executed in background, asynchronously. The method onPostFilter() is called after the filter task is completed.
    2. This method calls filterObject(IFlexible, Serializable) for each filterable item.
    3. Any pending deleted items are always deleted before filter is performed: FlexibleAdapter.OnDeleteCompleteListener.onDeleteConfirmed(int) (implemented in UndoHelper) is therefore invoked.
    4. Expandable items are picked up and displayed if at least a child is collected by the current filter.
    5. Filter is skipped while endless feature is active (loading).
    6. If filter is null, the provided list is the new list plus any Scrollable Headers and Footers if existent.
    7. Items are animated thanks to animateTo(List, Payload) BUT a limit of (default) items is set. Tip: Above this limit, #notifyDataSetChanged() will be called to improve performance. You can change this limit by calling setAnimateToLimit(int).
    Parameters:
    
    unfilteredItems - the list to filter
    
    Since:
    
    4.1.0 Created
    5.0.0-b1 Expandable + Child filtering
    5.0.0-b8 Synchronization animations limit + AsyncFilter
    5.0.0-rc1 Scrollable Headers and Footers adaptation
    5.0.0-rc2 Copy of the Original List is done internally
    5.0.0-rc2 Removal of Undo in combination with Filter
    5.0.0 Use of any filter object, instead of only String
    
    See Also:
    
    setFilter(Serializable), filterItems(), filterItems(List, long), onPostFilter(), setAnimateToLimit(int)
  - isFiltering
```
public boolean isFiltering()
```
    Returns:
    
    true if the filter is currently running, false otherwise.
  - filterObject
```
protected boolean filterObject(T item,
                               java.io.Serializable constraint)
```
    This method checks if the provided object is a type of IFilterable interface, if yes, performs the filter on the implemented method IFilterable.filter(Serializable).
    Note:
    - The item will be collected if the implemented method returns true.
    - IExpandable items are automatically picked up and displayed if at least a child is collected by the current filter. You DON'T NEED to implement the scan for the children: this is already done :-)
    - If you don't want to implement the IFilterable interface on each item, then you can override this method to have another filter logic!
    
    Parameters:
    
    item - the object to be inspected
    
    constraint - constraint, that the object has to fulfil
    
    Returns:
    
    true, if the object returns true as well, and so if it should be in the filteredResult, false otherwise
    
    Since:
    
    3.1.0 Created
    5.0.0-b1 Expandable + Child filtering
  - setAnimateToLimit
```
public FlexibleAdapter<T> setAnimateToLimit(int limit)
```
    Tunes the limit after the which the synchronization animations, occurred during updateDataSet and filter operations, are skipped and #notifyDataSetChanged() will be called instead.
    Default value is items, number new items.
    
    Parameters:
    
    limit - the number of new items that, when reached, will skip synchronization animations
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b8
  - isAnimateChangesWithDiffUtil
```
public boolean isAnimateChangesWithDiffUtil()
```
    Returns:
    
    true to calculate animation changes with DiffUtil, false to use default calculation.
    
    See Also:
    
    setAnimateChangesWithDiffUtil(boolean)
  - setAnimateChangesWithDiffUtil
```
public FlexibleAdapter<T> setAnimateChangesWithDiffUtil(boolean useDiffUtil)
```
    Whether use DiffUtil to calculate the changes between 2 lists after Update or Filter operations. If disabled, the advanced default calculation will be used instead.
    A time, to compare the 2 different approaches, is calculated and displayed in the log. To see the logs call SelectableAdapter.enableLogs(int) before creating the Adapter instance!
    Default value is false (default calculation is used).
    
    Parameters:
    
    useDiffUtil - true to switch the calculation and use DiffUtil, false to use the default calculation.
    
    Returns:
    
    this Adapter, so the call can be chained
    
    See Also:
    
    setDiffUtilCallback(DiffUtilCallback)
  - setDiffUtilCallback
```
public FlexibleAdapter<T> setDiffUtilCallback(FlexibleAdapter.DiffUtilCallback diffUtilCallback)
```
    Sets a custom implementation of FlexibleAdapter.DiffUtilCallback for the DiffUtil.
    
    Parameters:
    
    diffUtilCallback - the custom callback that DiffUtil will call
    
    Returns:
    
    this Adapter, so the call can be chained
    
    See Also:
    
    setAnimateChangesWithDiffUtil(boolean)
  - getTime
```
public long getTime()
```
    Returns:
    
    the time (in ms) of the last update or filter operation.
  - getItemTouchHelper
```
public final ItemTouchHelper getItemTouchHelper()
```
    Used by FlexibleViewHolder.onTouch(View, MotionEvent) to start Drag or Swipe when HandleView is touched.
    
    Returns:
    
    the ItemTouchHelper instance already initialized.
    
    Since:
    
    5.0.0-b1
  - getItemTouchHelperCallback
```
public final ItemTouchHelperCallback getItemTouchHelperCallback()
```
    Returns the customization of the ItemTouchHelperCallback or the default if it wasn't set before.
    
    Returns:
    
    the ItemTouchHelperCallback instance already initialized
    
    Since:
    
    5.0.0-b7
    
    See Also:
    
    setItemTouchHelperCallback(ItemTouchHelperCallback)
  - setItemTouchHelperCallback
```
public final FlexibleAdapter<T> setItemTouchHelperCallback(ItemTouchHelperCallback itemTouchHelperCallback)
```
    Sets a custom callback implementation for item touch.
    If called, Helper will be reinitialized.
    If not called, the default Helper will be used.
    
    Parameters:
    
    itemTouchHelperCallback - the custom callback implementation for item touch
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-rc1
  - isLongPressDragEnabled
```
public final boolean isLongPressDragEnabled()
```
    Returns whether ItemTouchHelper should start a drag and drop operation if an item is long pressed.
    Default value is false.
    
    Returns:
    
    true if ItemTouchHelper should start dragging an item when it is long pressed, false otherwise. Default value is false.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setLongPressDragEnabled(boolean)
  - setLongPressDragEnabled
```
public final FlexibleAdapter<T> setLongPressDragEnabled(boolean longPressDragEnabled)
```
    Enables / Disables the drag of the item when long-press the entire itemView.
    Note: This will skip LongClick on the view in order to handle the LongPress, however the LongClick listener will be called if necessary in the new FlexibleViewHolder.onActionStateChanged(int, int).
    Requires the Adapter being attached to the RecyclerView. Default value is false.
    
    Parameters:
    
    longPressDragEnabled - true to activate, false otherwise
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
  - isHandleDragEnabled
```
public final boolean isHandleDragEnabled()
```
    Returns whether ItemTouchHelper should start a drag and drop operation by touching its handle.
    Default value is false.
    To use, it is sufficient to set the HandleView by calling FlexibleViewHolder.setDragHandleView(View).
    
    Returns:
    
    true if active, false otherwise
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setHandleDragEnabled(boolean)
  - setHandleDragEnabled
```
public final FlexibleAdapter<T> setHandleDragEnabled(boolean handleDragEnabled)
```
    Enables / Disables the drag of the item with a handle view. Requires the Adapter being attached to the RecyclerView.
    Default value is false.
    
    Parameters:
    
    handleDragEnabled - true to activate, false otherwise
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
  - isSwipeEnabled
```
public final boolean isSwipeEnabled()
```
    Returns whether ItemTouchHelper should start a swipe operation if a pointer is swiped over the View.
    Default value is false.
    
    Returns:
    
    true if ItemTouchHelper should start swiping an item when user swipes a pointer over the View, false otherwise. Default value is false.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setSwipeEnabled(boolean)
  - setSwipeEnabled
```
public final FlexibleAdapter<T> setSwipeEnabled(boolean swipeEnabled)
```
    Enables full the swipe of the items.
    Note:
    - Requires the Adapter being attached to the RecyclerView.
    - Must override getFrontView and at least a rear View: getRearLeftView and/or getRearRightView in the FlexibleViewHolder.
    Default value is false.
    Parameters:
    
    swipeEnabled - true to activate, false otherwise
    
    Returns:
    
    this Adapter, so the call can be chained
    
    Since:
    
    5.0.0-b1
  - moveItem
```
public void moveItem(int fromPosition,
                     int toPosition)
```
    Moves the item placed at position fromPosition to the position toPosition.
    - Selection of moved element is preserved.
    - If item is an expandable, it is collapsed and then expanded at the new position.
    
    Parameters:
    
    fromPosition - previous position of the item
    
    toPosition - new position of the item
    
    Since:
    
    5.0.0-b7
    
    See Also:
    
    moveItem(int, int, Object)
  - moveItem
```
public void moveItem(int fromPosition,
                     int toPosition,
                     java.lang.Object payload)
```
    Moves the item placed at position fromPosition to the position toPosition.
    - Selection of moved element is preserved.
    - If item is an expandable, it is collapsed and then expanded at the new position.
    
    Parameters:
    
    fromPosition - previous position of the item
    
    toPosition - new position of the item
    
    payload - allows to update the content of the item just moved
    
    Since:
    
    5.0.0-b7
  - swapItems
```
public void swapItems(java.util.List<T> list,
                      int fromPosition,
                      int toPosition)
```
    Swaps the elements of list at indices fromPosition and toPosition and notify the change.
    Selection of swiped elements is automatically updated.
    
    Parameters:
    
    fromPosition - previous position of the item.
    
    toPosition - new position of the item.
    
    Since:
    
    5.0.0-b7
  - onActionStateChanged
```
public void onActionStateChanged(RecyclerView.ViewHolder viewHolder,
                                 int actionState)
```
    Called when the ItemTouchHelper first registers an item as being moved or swiped or when has been released.
    Override this method to receive touch events with its state.
    
    Specified by:
    
    onActionStateChanged in interface ItemTouchHelperCallback.AdapterCallback
    
    Parameters:
    
    viewHolder - the viewHolder touched
    
    actionState - one of ItemTouchHelper#ACTION_STATE_SWIPE or ItemTouchHelper#ACTION_STATE_DRAG or ItemTouchHelper#ACTION_STATE_IDLE.
    
    Since:
    
    5.0.0-b7
  - shouldMove
```
public boolean shouldMove(int fromPosition,
                          int toPosition)
```
    Evaluate if positions are compatible for swapping.
    
    Specified by:
    
    shouldMove in interface ItemTouchHelperCallback.AdapterCallback
    
    Parameters:
    
    fromPosition - the start position of the moving item
    
    toPosition - the potential target position of the moving item
    
    Returns:
    
    true if the from-item is allowed to swap with the to-item
    
    Since:
    
    5.0.0-b1
  - onItemMove
```
public boolean onItemMove(int fromPosition,
                          int toPosition)
```
    Called when an item has been dragged far enough to trigger a move. This is called every time an item is shifted, and not at the end of a "drop" event.
    Implementations should call Adapter#notifyItemMoved(int, int) after adjusting the underlying data to reflect this move.
    
    Specified by:
    
    onItemMove in interface ItemTouchHelperCallback.AdapterCallback
    
    Parameters:
    
    fromPosition - the start position of the moved item
    
    toPosition - the resolved position of the moved item
    
    Returns:
    
    true if the from-item has been swapped with the to-item
    
    Since:
    
    5.0.0-b1
  - onItemSwiped
```
public void onItemSwiped(int position,
                         int direction)
```
    Called when an item has been dismissed by a swipe.
    Implementations should decide to call or not Adapter#notifyItemRemoved(int) after adjusting the underlying data to reflect this removal.
    
    Specified by:
    
    onItemSwiped in interface ItemTouchHelperCallback.AdapterCallback
    
    Parameters:
    
    position - the position of the item dismissed
    
    direction - the direction to which the ViewHolder is swiped
    
    Since:
    
    5.0.0-b1
  - smoothScrollToPosition
```
public void smoothScrollToPosition(int position)
```
    Performs safe smooth scroll with a delay of ms.
    
    Parameters:
    
    position - the position to scroll to.
    
    Since:
    
    5.0.5
  - invalidateItemDecorations
```
public final void invalidateItemDecorations(long delay)
```
    Helper method to post invalidate the item decorations after the provided delay.
    The delay will give time to the LayoutManagers to complete the layout of the child views.
    Tip: A delay of 100ms should be enough, anyway it can be customized.
    
    Parameters:
    
    delay - delay to invalidate the decorations
  - onSaveInstanceState
```
public void onSaveInstanceState(android.os.Bundle outState)
```
    Save the state of the current expanded items.
    
    Overrides:
    
    onSaveInstanceState in class SelectableAdapter
    
    Parameters:
    
    outState - Current state
    
    Since:
    
    5.0.0-b1
  - onRestoreInstanceState
```
public void onRestoreInstanceState(android.os.Bundle savedInstanceState)
```
    Restore the previous state of the expanded items.
    
    Overrides:
    
    onRestoreInstanceState in class SelectableAdapter
    
    Parameters:
    
    savedInstanceState - Previous state
    
    Since:
    
    5.0.0-b1
  - onPostUpdate
```
protected void onPostUpdate()
```
    This method is called only in case of granular notifications (not when notifyDataSetChanged) and after the execution of Async Update, it calls the implementation of the FlexibleAdapter.OnUpdateListener for the emptyView.
    
    See Also:
    
    updateDataSet(List, boolean)
  - onPostFilter
```
protected void onPostFilter()
```
    This method is called after the execution of Async Filter, it calls the implementation of the FlexibleAdapter.OnFilterListener for the filterView.
    
    See Also:
    
    filterItems(List)

Class FlexibleAdapter<T extends IFlexible>

Nested Class Summary

Nested classes/interfaces inherited from class eu.davidea.flexibleadapter.SelectableAdapter

Field Summary

Fields inherited from class eu.davidea.flexibleadapter.SelectableAdapter

Constructor Summary

Method Summary

Methods inherited from class eu.davidea.flexibleadapter.AnimatorAdapter

Methods inherited from class eu.davidea.flexibleadapter.SelectableAdapter

Methods inherited from class java.lang.Object

Field Detail

UPDATE

FILTER

LOAD_MORE_COMPLETE

mHandler

mInflater

mItemClickListener

mItemLongClickListener

mUpdateListener

mFilterListener

mItemMoveListener

mItemSwipeListener

mEndlessScrollListener

mDeleteCompleteListener

mStickyHeaderChangeListener

Constructor Detail

FlexibleAdapter

FlexibleAdapter

FlexibleAdapter

Method Detail

addListener

removeListener

onAttachedToRecyclerView

onDetachedFromRecyclerView

expandItemsAtStartUp

isEnabled

isItemEnabled

isSelectable

toggleSelection

selectAll

clearSelection

isAnyParentSelected

isAnyChildSelected

updateDataSet

updateDataSet

getItem

getItem

getItemId

getItemCount

getMainItemCount

getItemCountOfTypes

getCurrentItems

isEmpty

getGlobalPositionOf

getCardinalPositionOf

getSameTypePositionOf

contains

calculatePositionFor

getScrollableHeaders

getScrollableFooters

isScrollableHeaderOrFooter

isScrollableHeaderOrFooter

addScrollableHeader

addScrollableFooter

removeScrollableHeader

removeScrollableFooter

removeAllScrollableHeaders

removeAllScrollableFooters

addScrollableHeaderWithDelay

addScrollableFooterWithDelay

removeScrollableHeaderWithDelay

removeScrollableFooterWithDelay

setUnlinkAllItemsOnRemoveHeaders

getHeaderItems

isHeader

hasHeader

hasSameHeader

getHeaderOf

getSectionHeader

getSectionItems