eu.davidea.flexibleadapter.helpers

Interface ItemTouchHelperCallback.AdapterCallback

All Known Implementing Classes:

FlexibleAdapter

Enclosing class:

ItemTouchHelperCallback

public static interface ItemTouchHelperCallback.AdapterCallback

Internal interface for Adapter to listen for a move or swipe dismissal event from a ItemTouchHelperCallback.

Since:

23/01/2016

Method Summary

Modifier and Type	Method and Description
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.
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.
boolean	shouldMove(int fromPosition, int toPosition) Evaluate if positions are compatible for swapping.

Method Detail

onActionStateChanged

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.

Parameters:

viewHolder - the viewHolder touched

actionState - one of ItemTouchHelper#ACTION_STATE_SWIPE or ItemTouchHelper#ACTION_STATE_DRAG or ItemTouchHelper#ACTION_STATE_IDLE.

shouldMove

boolean shouldMove(int fromPosition,
                   int toPosition)

Evaluate if positions are compatible for swapping.

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

onItemMove

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.

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

onItemSwiped

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.

Parameters:

position - the position of the item dismissed

direction - the direction to which the ViewHolder is swiped