SelectableAdapter (flexible-adapter 5.1.0 API)

java.lang.Object
- RecyclerView.Adapter
- - eu.davidea.flexibleadapter.SelectableAdapter

All Implemented Interfaces:

FastScroller.AdapterInterface, FastScroller.BubbleTextCreator, FastScroller.OnScrollStateChangeListener

Direct Known Subclasses:

AnimatorAdapter
```
public abstract class SelectableAdapter
extends RecyclerView.Adapter
implements FastScroller.BubbleTextCreator, FastScroller.OnScrollStateChangeListener, FastScroller.AdapterInterface
```
This class provides a set of standard methods to handle the selection on the items of an Adapter.
Also it manages the FastScroller.
This class is extended by AnimatorAdapter.

Since:

03/05/2015 Created
27/01/2016 Improved Selection, SelectAll, FastScroller
29/05/2016 Use of TreeSet instead of ArrayList
04/04/2017 Use of FastScrollerDelegate
05/06/2017 Improved Log system

See Also:

FlexibleAdapter, AnimatorAdapter

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SelectableAdapter.Mode` Annotation interface for selection modes: `SelectableAdapter.Mode.IDLE`, `SelectableAdapter.Mode.SINGLE`, `SelectableAdapter.Mode.MULTI`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`isFastScroll` Flag when fast scrolling is active.
`protected FastScroller.Delegate`	`mFastScrollerDelegate`
`protected boolean`	`mLastItemInActionMode` ActionMode selection flag LastItemInActionMode.
`protected RecyclerView`	`mRecyclerView`
`protected boolean`	`mSelectAll` ActionMode selection flag SelectAll.

Constructor Summary

Constructors
Constructor and Description

SelectableAdapter()

Constructors
Constructor and Description
`SelectableAdapter()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addSelection(int position)` Adds the selection status for the given position without notifying the change.
`void`	`clearSelection()` Clears the selection status for all items one by one and it doesn't stop animations in the items.
`static void`	`enableLogs(int level)` Call this once, to enable or disable internal logs with custom level.
`java.util.Set<FlexibleViewHolder>`	`getAllBoundViewHolders()` Usually `RecyclerView` binds 3 items more than the visible items.
`FastScroller`	`getFastScroller()`
`IFlexibleLayoutManager`	`getFlexibleLayoutManager()` Current instance of the wrapper class for LayoutManager suitable for FlexibleAdapter.
`int`	`getMode()` The current selection mode of the Adapter.
`RecyclerView`	`getRecyclerView()`
`int`	`getSelectedItemCount()` Counts the selected items.
`java.util.List<java.lang.Integer>`	`getSelectedPositions()` Retrieves the list of selected items.
`java.util.Set<java.lang.Integer>`	`getSelectedPositionsAsSet()` Retrieves the set of selected items.
`boolean`	`isFastScrollerEnabled()`
`boolean`	`isLastItemInActionMode()`
`abstract boolean`	`isSelectable(int position)` Checks if the current item has the property `selectable = true`.
`boolean`	`isSelectAll()`
`boolean`	`isSelected(int position)` Indicates if the item, at the provided position, is selected.
`void`	`onAttachedToRecyclerView(RecyclerView recyclerView)` Attaches the `FastScrollerDelegate` to the RecyclerView if necessary.
`void`	`onBindViewHolder(RecyclerView.ViewHolder holder, int position, java.util.List payloads)`
`java.lang.String`	`onCreateBubbleText(int position)`
`void`	`onDetachedFromRecyclerView(RecyclerView recyclerView)` Detaches the `FastScrollerDelegate` from the RecyclerView if necessary.
`void`	`onFastScrollerStateChange(boolean scrolling)` Triggered when FastScroller State is changed.
`void`	`onRestoreInstanceState(android.os.Bundle savedInstanceState)` Restores the previous state of the selection on the items.
`void`	`onSaveInstanceState(android.os.Bundle outState)` Saves the state of the current selection on the items.
`void`	`onViewRecycled(RecyclerView.ViewHolder holder)`
`boolean`	`removeSelection(int position)` Removes the selection status for the given position without notifying the change.
`void`	`selectAll(java.lang.Integer... viewTypes)` Sets the selection status for all items which the ViewTypes are included in the specified array.
`void`	`setFastScroller(FastScroller fastScroller)` Sets up the `FastScroller` with automatic fetch of accent color.
`void`	`setFlexibleLayoutManager(IFlexibleLayoutManager flexibleLayoutManager)` Allow to use a custom LayoutManager.
`void`	`setMode(int mode)` Sets the mode of the selection: `SelectableAdapter.Mode.IDLE` Default.
`protected void`	`swapSelection(int fromPosition, int toPosition)` Helper method to easily swap selection between 2 positions only if one of the positions is not selected.
`void`	`toggleFastScroller()` Displays or Hides the `FastScroller` if previously configured.
`void`	`toggleSelection(int position)` Toggles the selection status of the item at a given position.
`static void`	`useTag(java.lang.String tag)`

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

- Field Detail
  - mRecyclerView
```
protected RecyclerView mRecyclerView
```
  - mFastScrollerDelegate
```
protected FastScroller.Delegate mFastScrollerDelegate
```
  - isFastScroll
```
protected boolean isFastScroll
```
    Flag when fast scrolling is active.
    Used to know if user is fast scrolling.
  - mSelectAll
```
protected boolean mSelectAll
```
    ActionMode selection flag SelectAll.
    Used when user click on selectAll action button in ActionMode.
  - mLastItemInActionMode
```
protected boolean mLastItemInActionMode
```
    ActionMode selection flag LastItemInActionMode.
    Used when user returns to SelectableAdapter.Mode.IDLE and no selection is active.
- Constructor Detail
  - SelectableAdapter
```
public SelectableAdapter()
```
    Since:
    
    1.0.0
- Method Detail
  - enableLogs
```
public static void enableLogs(int level)
```
    Call this once, to enable or disable internal logs with custom level.
    Logs are disabled by default.
    
    Parameters:
    
    level - One of Log.Level value
    
    Since:
    
    5.0.0-b1
  - useTag
```
public static void useTag(java.lang.String tag)
```
  - onAttachedToRecyclerView
```
public void onAttachedToRecyclerView(RecyclerView recyclerView)
```
    Attaches the FastScrollerDelegate to the RecyclerView if necessary.
    
    Since:
    
    5.0.0-b6
  - onDetachedFromRecyclerView
```
public void onDetachedFromRecyclerView(RecyclerView recyclerView)
```
    Detaches the FastScrollerDelegate from the RecyclerView if necessary.
    
    Since:
    
    5.0.0-b6
  - getRecyclerView
```
public RecyclerView getRecyclerView()
```
    Returns:
    
    the RecyclerView instance
    
    Since:
    
    5.0.0-b6
  - getFlexibleLayoutManager
```
public IFlexibleLayoutManager getFlexibleLayoutManager()
```
    Current instance of the wrapper class for LayoutManager suitable for FlexibleAdapter. LayoutManager must be already initialized in the RecyclerView.
    return wrapper class for any non-conventional LayoutManagers or null if not initialized.
    
    Since:
    
    5.0.0-rc2
  - setFlexibleLayoutManager
```
public void setFlexibleLayoutManager(IFlexibleLayoutManager flexibleLayoutManager)
```
    Allow to use a custom LayoutManager.
    
    Parameters:
    
    flexibleLayoutManager - the custom LayoutManager suitable for FlexibleAdapter
    
    Since:
    
    5.0.0-rc2
  - setMode
```
public void setMode(int mode)
```
    Sets the mode of the selection:
    - SelectableAdapter.Mode.IDLE Default. Configures the adapter so that no item can be selected;
    - SelectableAdapter.Mode.SINGLE configures the adapter to react at the single tap over an item (previous selection is cleared automatically);
    - SelectableAdapter.Mode.MULTI configures the adapter to save the position to the list of the selected items.
    Parameters:
    
    mode - one of SelectableAdapter.Mode.IDLE, SelectableAdapter.Mode.SINGLE, SelectableAdapter.Mode.MULTI
    
    Since:
    
    2.0.0
  - getMode
```
public int getMode()
```
    The current selection mode of the Adapter.
    
    Returns:
    
    current mode
    
    Since:
    
    2.1.0
    
    See Also:
    
    SelectableAdapter.Mode.IDLE, SelectableAdapter.Mode.SINGLE, SelectableAdapter.Mode.MULTI
  - isSelectAll
```
public boolean isSelectAll()
```
    Returns:
    
    true if user clicks on SelectAll on action button in ActionMode.
    
    Since:
    
    5.0.0-b1
  - isLastItemInActionMode
```
public boolean isLastItemInActionMode()
```
    Returns:
    
    true if user returns to SelectableAdapter.Mode.IDLE or SelectableAdapter.Mode.SINGLE and no selection is active, false otherwise
    
    Since:
    
    5.0.0-b1
  - isSelected
```
public boolean isSelected(int position)
```
    Indicates if the item, at the provided position, is selected.
    
    Parameters:
    
    position - Position of the item to check.
    
    Returns:
    
    true if the item is selected, false otherwise.
    
    Since:
    
    1.0.0
  - isSelectable
```
public abstract boolean isSelectable(int position)
```
    Checks if the current item has the property selectable = true.
    
    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 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).
    Parameters:
    
    position - Position of the item to toggle the selection status for.
    
    Since:
    
    1.0.0
  - addSelection
```
public final boolean addSelection(int position)
```
    Adds the selection status for the given position without notifying the change.
    
    Parameters:
    
    position - Position of the item to add the selection status for.
    
    Returns:
    
    true if the set is modified, false otherwise or position is not currently selectable
    
    Since:
    
    5.0.0-b7
    
    See Also:
    
    isSelectable(int)
  - removeSelection
```
public final boolean removeSelection(int position)
```
    Removes the selection status for the given position without notifying the change.
    
    Parameters:
    
    position - Position of the item to remove the selection status for.
    
    Returns:
    
    true if the set is modified, false otherwise
    
    Since:
    
    5.0.0-b7
  - swapSelection
```
protected void swapSelection(int fromPosition,
                             int toPosition)
```
    Helper method to easily swap selection between 2 positions only if one of the positions is not selected.
    
    Parameters:
    
    fromPosition - first position
    
    toPosition - second position
  - selectAll
```
public void selectAll(java.lang.Integer... viewTypes)
```
    Sets the selection status for all items which the ViewTypes are included in the specified array.
    
    Parameters:
    
    viewTypes - The ViewTypes for which we want the selection, pass nothing to select all
    
    Since:
    
    1.0.0
  - 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.
    
    Since:
    
    1.0.0
  - onBindViewHolder
```
public void onBindViewHolder(RecyclerView.ViewHolder holder,
                             int position,
                             java.util.List payloads)
```
  - onViewRecycled
```
public void onViewRecycled(RecyclerView.ViewHolder holder)
```
  - getAllBoundViewHolders
```
public java.util.Set<FlexibleViewHolder> getAllBoundViewHolders()
```
    Usually RecyclerView binds 3 items more than the visible items.
    
    Returns:
    
    a Set with all bound FlexibleViewHolders
    
    Since:
    
    5.0.0-rc1
  - getSelectedItemCount
```
public int getSelectedItemCount()
```
    Counts the selected items.
    
    Returns:
    
    Selected items count
    
    Since:
    
    1.0.0
  - getSelectedPositions
```
public java.util.List<java.lang.Integer> getSelectedPositions()
```
    Retrieves the list of selected items.
    The list is a copy and it's sorted.
    
    Returns:
    
    A copied List of selected items ids from the Set
    
    Since:
    
    5.0.0-b2
  - getSelectedPositionsAsSet
```
public java.util.Set<java.lang.Integer> getSelectedPositionsAsSet()
```
    Retrieves the set of selected items.
    The set is sorted.
    
    Returns:
    
    Set of selected items ids
  - onSaveInstanceState
```
public void onSaveInstanceState(android.os.Bundle outState)
```
    Saves the state of the current selection on the items.
    
    Parameters:
    
    outState - Current state
    
    Since:
    
    1.0.0
  - onRestoreInstanceState
```
public void onRestoreInstanceState(android.os.Bundle savedInstanceState)
```
    Restores the previous state of the selection on the items.
    
    Parameters:
    
    savedInstanceState - Previous state
    
    Since:
    
    1.0.0
  - toggleFastScroller
```
public void toggleFastScroller()
```
    Displays or Hides the FastScroller if previously configured.
    The action is animated.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setFastScroller(FastScroller)
  - isFastScrollerEnabled
```
public boolean isFastScrollerEnabled()
```
    Returns:
    
    true if FastScroller is configured and shown, false otherwise
    
    Since:
    
    5.0.0-b1
  - getFastScroller
```
public FastScroller getFastScroller()
```
    Returns:
    
    the current instance of the FastScroller object
    
    Since:
    
    5.0.0-b1
  - setFastScroller
```
public void setFastScroller(FastScroller fastScroller)
```
    Sets up the FastScroller with automatic fetch of accent color.
    IMPORTANT: Call this method after the adapter is added to the RecyclerView.
    NOTE: If the device has at least Lollipop, the Accent color is fetched, otherwise for previous version, the default value is used.
    
    Specified by:
    
    setFastScroller in interface FastScroller.AdapterInterface
    
    Parameters:
    
    fastScroller - instance of FastScroller
    
    Since:
    
    5.0.0-b6
  - onCreateBubbleText
```
public java.lang.String onCreateBubbleText(int position)
```
    Specified by:
    
    onCreateBubbleText in interface FastScroller.BubbleTextCreator
    
    Parameters:
    
    position - the position of the handle
    
    Returns:
    
    the value of the item, default value is: position + 1
    
    Since:
    
    5.0.0-b1
  - onFastScrollerStateChange
```
public void onFastScrollerStateChange(boolean scrolling)
```
    Triggered when FastScroller State is changed.
    
    Specified by:
    
    onFastScrollerStateChange in interface FastScroller.OnScrollStateChangeListener
    
    Parameters:
    
    scrolling - true if the user is actively scrolling, false when idle
    
    Since:
    
    5.0.0-b1

Class SelectableAdapter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mRecyclerView

mFastScrollerDelegate

isFastScroll

mSelectAll

mLastItemInActionMode

Constructor Detail

SelectableAdapter

Method Detail

enableLogs

useTag

onAttachedToRecyclerView

onDetachedFromRecyclerView

getRecyclerView

getFlexibleLayoutManager

setFlexibleLayoutManager

setMode

getMode

isSelectAll

isLastItemInActionMode

isSelected

isSelectable

toggleSelection

addSelection

removeSelection

swapSelection

selectAll

clearSelection

onBindViewHolder

onViewRecycled

getAllBoundViewHolders

getSelectedItemCount

getSelectedPositions

getSelectedPositionsAsSet

onSaveInstanceState

onRestoreInstanceState

toggleFastScroller

isFastScrollerEnabled

getFastScroller

setFastScroller

onCreateBubbleText

onFastScrollerStateChange