eu.davidea.flexibleadapter.helpers

Class ActionModeHelper

java.lang.Object

eu.davidea.flexibleadapter.helpers.ActionModeHelper

public class ActionModeHelper
extends java.lang.Object

Helper Class to coordinate the MULTI selection with FlexibleAdapter.

Since:

30/04/2016 Created in main package
23/08/2017 Option to disable swipe/drag capabilities
17/12/2017 Moved into UI package

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionMode	mActionMode

Constructor Summary

Constructors

Constructor and Description
ActionModeHelper(FlexibleAdapter adapter, int cabMenu) Default constructor with internal callback.
ActionModeHelper(FlexibleAdapter adapter, int cabMenu, ActionMode.Callback callback) Constructor with internal callback + custom callback.

Method Summary

Modifier and Type	Method and Description
boolean	destroyActionModeIfCan() Utility method to be called from Activity in many occasions such as: onBackPressed, onRefresh for SwipeRefreshLayout, after deleting all selected items.
ActionModeHelper	disableDragOnActionMode(boolean disableDrag) Automatically disables LongPress drag and Handle drag capability when ActionMode is activated and enable it again when ActionMode is destroyed.
ActionModeHelper	disableSwipeOnActionMode(boolean disableSwipe) Automatically disables Swipe capability when ActionMode is activated and enable it again when ActionMode is destroyed.
ActionMode	getActionMode()
int	getActivatedPosition() Gets the activated position only when mode is SINGLE.
boolean	onActionItemClicked(ActionMode actionMode, android.view.MenuItem item)
boolean	onClick(int position) Implements the basic behavior of a CAB and multi select behavior.
boolean	onCreateActionMode(ActionMode actionMode, android.view.Menu menu)
void	onDestroyActionMode(ActionMode actionMode) With FlexibleAdapter v5.0.0 the default mode is Mode#IDLE, if you want single selection enabled change default mode with withDefaultMode(int).
ActionMode	onLongClick(AppCompatActivity activity, int position) Implements the basic behavior of a CAB and multi select behavior onLongClick.
boolean	onPrepareActionMode(ActionMode actionMode, android.view.Menu menu)
void	restoreSelection(AppCompatActivity activity) Helper method to restart the action mode after a restoration of deleted items and after screen rotation.
void	toggleSelection(int position) Toggle the selection state of an item.
void	updateContextTitle(int count) Updates the title of the Context Menu.
ActionModeHelper	withDefaultMode(int defaultMode) Changes the default mode to apply when the ActionMode is destroyed and normal selection is again active.

Methods inherited from class java.lang.Object

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

Field Detail

mActionMode

protected ActionMode mActionMode

Constructor Detail

ActionModeHelper

public ActionModeHelper(FlexibleAdapter adapter,
                        int cabMenu)

Default constructor with internal callback.

Parameters:

adapter - the FlexibleAdapter instance

cabMenu - the Contextual Action Bar menu resourceId

Since:

1.0.0-b1

See Also:

ActionModeHelper(FlexibleAdapter, int, ActionMode.Callback)

ActionModeHelper

public ActionModeHelper(FlexibleAdapter adapter,
                        int cabMenu,
                        ActionMode.Callback callback)

Constructor with internal callback + custom callback.

Parameters:

adapter - the FlexibleAdapter instance

cabMenu - the Contextual Action Bar menu resourceId

callback - the custom androidx.appcompat.view.ActionMode.Callback

Since:

1.0.0-b1

See Also:

ActionModeHelper(FlexibleAdapter, int)

Method Detail

withDefaultMode

public final ActionModeHelper withDefaultMode(int defaultMode)

Changes the default mode to apply when the ActionMode is destroyed and normal selection is again active.

Default value is Mode#IDLE.

Parameters:

defaultMode - the new default mode when ActionMode is off, accepted values: IDLE, SINGLE

Returns:

this object, so it can be chained

Since:

1.0.0-b1

disableDragOnActionMode

public final ActionModeHelper disableDragOnActionMode(boolean disableDrag)

Automatically disables LongPress drag and Handle drag capability when ActionMode is activated and enable it again when ActionMode is destroyed.

Parameters:

disableDrag - true to disable the drag, false to maintain the drag during ActionMode

Returns:

this object, so it can be chained

Since:

1.0.0-b1

disableSwipeOnActionMode

public final ActionModeHelper disableSwipeOnActionMode(boolean disableSwipe)

Automatically disables Swipe capability when ActionMode is activated and enable it again when ActionMode is destroyed.

Parameters:

disableSwipe - true to disable the swipe, false to maintain the swipe during ActionMode

Returns:

this object, so it can be chained

Since:

1.0.0-b1

getActionMode

public ActionMode getActionMode()

Returns:

the current instance of the ActionMode, null if ActionMode is off.

Since:

1.0.0-b1

getActivatedPosition

public int getActivatedPosition()

Gets the activated position only when mode is SINGLE.

Returns:

the activated position when SINGLE. -1 if no item is selected

Since:

1.0.0-b1

onClick

public boolean onClick(int position)

Implements the basic behavior of a CAB and multi select behavior.

Parameters:

position - the current item position

Returns:

true if selection is changed, false if the click event should ignore the ActionMode and continue

Since:

1.0.0-b1

onLongClick

public ActionMode onLongClick(AppCompatActivity activity,
                              int position)

Implements the basic behavior of a CAB and multi select behavior onLongClick.

Parameters:

activity - the current Activity

position - the position of the clicked item

Returns:

the initialized ActionMode or null if nothing was done

Since:

1.0.0-b1

toggleSelection

public void toggleSelection(int position)

Toggle the selection state of an item.

If the item was the last one in the selection and is unselected, the selection is stopped. Note that the selection must already be started (actionMode must not be null).

Parameters:

position - position of the item to toggle the selection state

Since:

1.0.0-b1

updateContextTitle

public void updateContextTitle(int count)

Updates the title of the Context Menu.

Override to customize the title and subtitle.

Parameters:

count - the current number of selected items

Since:

1.0.0-b1

restoreSelection

public void restoreSelection(AppCompatActivity activity)

Helper method to restart the action mode after a restoration of deleted items and after screen rotation. The ActionMode will be activated only if FlexibleAdapter#getSelectedItemCount() has selections.

To be called in the onUndo method after the restoration is done or at the end of onRestoreInstanceState.

Parameters:

activity - the current Activity

Since:

1.0.0-b1

onCreateActionMode

public boolean onCreateActionMode(ActionMode actionMode,
                                  android.view.Menu menu)

onPrepareActionMode

public boolean onPrepareActionMode(ActionMode actionMode,
                                   android.view.Menu menu)

onActionItemClicked

public boolean onActionItemClicked(ActionMode actionMode,
                                   android.view.MenuItem item)

onDestroyActionMode

public void onDestroyActionMode(ActionMode actionMode)

With FlexibleAdapter v5.0.0 the default mode is Mode#IDLE, if you want single selection enabled change default mode with withDefaultMode(int).

destroyActionModeIfCan

public boolean destroyActionModeIfCan()

Utility method to be called from Activity in many occasions such as: onBackPressed, onRefresh for SwipeRefreshLayout, after deleting all selected items.

Returns:

true if ActionMode was active (in case it is also terminated), false otherwise

Since:

1.0.0-b1