eu.davidea.flexibleadapter.helpers

Class UndoHelper

java.lang.Object

Snackbar.Callback

eu.davidea.flexibleadapter.helpers.UndoHelper

public class UndoHelper
extends Snackbar.Callback

Helper Class to simplify the Undo operation with FlexibleAdapter.

Since:

30/04/2016 Created in main package
07/12/2017 Better use of OnActionListener
17/12/2017 Moved into UI package

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UndoHelper.Action Annotation interface for Undo actions.
static interface	UndoHelper.OnActionListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNDO_TIMEOUT Default undo timeout of 5''.

Constructor Summary

Constructors

Constructor and Description
UndoHelper(FlexibleAdapter adapter, UndoHelper.OnActionListener undoListener) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	onDeleteConfirmed(int event) Note: This method is also invoked by FlexibleAdapter#filterItems(List) before applying the filter.
void	onDismissed(Snackbar snackbar, int event)
void	onShown(Snackbar snackbar)
Snackbar	start(java.util.List<java.lang.Integer> positions, android.view.View mainView, java.lang.CharSequence message, java.lang.CharSequence actionText, int duration) Performs the action on the specified positions and displays a SnackBar to Undo the operation.
Snackbar	start(java.util.List<java.lang.Integer> positions, android.view.View mainView, int messageStringResId, int actionStringResId, int duration) As start(List, View, CharSequence, CharSequence, int) but with String resources instead of CharSequence.
UndoHelper	withAction(int action) By default UndoHelper.Action.REMOVE is performed.
UndoHelper	withActionTextColor(int color) Sets the text color of the action.
UndoHelper	withConsecutive(boolean consecutive) Allows to commit previous action before next consecutive Undo request.
UndoHelper	withPayload(java.lang.Object payload) Sets the payload to inform other linked items about the change in action.

Methods inherited from class java.lang.Object

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

Field Detail

UNDO_TIMEOUT

public static final int UNDO_TIMEOUT

Default undo timeout of 5''.

See Also:

Constant Field Values

Constructor Detail

UndoHelper

public UndoHelper(FlexibleAdapter adapter,
                  UndoHelper.OnActionListener undoListener)

Default constructor.

By calling this constructor, FlexibleAdapter#setPermanentDelete(boolean) is set false automatically.

Parameters:

adapter - the instance of FlexibleAdapter

undoListener - the callback for the Undo and Delete confirmation

Method Detail

withPayload

public UndoHelper withPayload(java.lang.Object payload)

Sets the payload to inform other linked items about the change in action.

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

Returns:

this object, so it can be chained

withAction

public UndoHelper withAction(int action)

By default UndoHelper.Action.REMOVE is performed.

Parameters:

action - the action, one of UndoHelper.Action.REMOVE, UndoHelper.Action.UPDATE

Returns:

this object, so it can be chained

withActionTextColor

public UndoHelper withActionTextColor(int color)

Sets the text color of the action.

Parameters:

color - the color for the action button

Returns:

this object, so it can be chained

withConsecutive

public UndoHelper withConsecutive(boolean consecutive)

Allows to commit previous action before next consecutive Undo request.

Default value is false (accumulate items).

Parameters:

consecutive - true to commit deletion at each Undo request to undo last action, false to accumulate the deleted items and Undo all in one shot.

Returns:

this object, so it can be chained

start

public Snackbar start(java.util.List<java.lang.Integer> positions,
                      android.view.View mainView,
                      int messageStringResId,
                      int actionStringResId,
                      int duration)

As start(List, View, CharSequence, CharSequence, int) but with String resources instead of CharSequence.

start

public Snackbar start(java.util.List<java.lang.Integer> positions,
                      android.view.View mainView,
                      java.lang.CharSequence message,
                      java.lang.CharSequence actionText,
                      int duration)

Performs the action on the specified positions and displays a SnackBar to Undo the operation. To customize the UPDATE event, please set a custom listener with withAction(int) method.

By default the DELETE action will be performed.

Parameters:

positions - the position to delete or update

mainView - the view to find a parent from

message - the text to show. Can be formatted text

actionText - the action text to display

duration - How long to display the message. Either Snackbar#LENGTH_SHORT or Snackbar#LENGTH_LONG or any custom Integer.

Returns:

The SnackBar instance

See Also:

start(List, View, int, int, int)

onDeleteConfirmed

public void onDeleteConfirmed(int event)

Note: This method is also invoked by FlexibleAdapter#filterItems(List) before applying the filter.

onDismissed

public void onDismissed(Snackbar snackbar,
                        int event)

onShown

public void onShown(Snackbar snackbar)