eu.davidea.flexibleadapter.helpers

Class ItemTouchHelperCallback

java.lang.Object

Callback

eu.davidea.flexibleadapter.helpers.ItemTouchHelperCallback

public class ItemTouchHelperCallback
extends Callback

This class is an implementation of Callback that enables Drag & Drop and Swipe actions. Drag and Swipe events are started depending by the configuration.

Since:

23/01/2016 Created

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ItemTouchHelperCallback.AdapterCallback Internal interface for Adapter to listen for a move or swipe dismissal event from a ItemTouchHelperCallback.
static interface	ItemTouchHelperCallback.ViewHolderCallback Internal Interface for ViewHolder to notify of relevant callbacks from Callback.

Field Summary

Fields

Modifier and Type	Field and Description
protected static float	ALPHA_FULL
protected boolean	handleDragEnabled
protected boolean	longPressDragEnabled
protected ItemTouchHelperCallback.AdapterCallback	mAdapterCallback
protected long	mDragAnimationDuration
protected float	mMoveThreshold
protected long	mSwipeAnimationDuration
protected int	mSwipeFlags
protected float	mSwipeThreshold
protected boolean	swipeEnabled

Constructor Summary

Constructors

Constructor and Description
ItemTouchHelperCallback(ItemTouchHelperCallback.AdapterCallback adapterCallback)

Method Summary

Modifier and Type	Method and Description
boolean	canDropOver(RecyclerView recyclerView, RecyclerView.ViewHolder current, RecyclerView.ViewHolder target)
void	clearView(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder)
long	getAnimationDuration(RecyclerView recyclerView, int animationType, float animateDx, float animateDy) Provides the animation duration for Drag and Swipe previously set with setDragAnimationDuration(long) and setSwipeAnimationDuration(long).
int	getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder)
float	getMoveThreshold(RecyclerView.ViewHolder viewHolder)
float	getSwipeThreshold(RecyclerView.ViewHolder viewHolder) Returns the fraction that the user should move the View to be considered as swiped.
boolean	isHandleDragEnabled()
boolean	isItemViewSwipeEnabled()
boolean	isLongPressDragEnabled()
void	onChildDraw(android.graphics.Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive)
boolean	onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target)
void	onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState)
void	onSwiped(RecyclerView.ViewHolder viewHolder, int direction)
void	setDragAnimationDuration(long animationDuration) Sets the animation duration of Drag event, starting when the items is released.
void	setHandleDragEnabled(boolean handleDragEnabled) Enable / Disable the drag of the itemView with a handle view.
void	setLongPressDragEnabled(boolean isLongPressDragEnabled) Enable / Disable the drag operation with long press on the ViewHolder.
void	setMoveThreshold(float moveThreshold) Configures the fraction that the user should move the View to be considered as it is dragged.
void	setSwipeAnimationDuration(long animationDuration) Sets the animation duration of Swipe removal event, starting when the items is released.
void	setSwipeEnabled(boolean isSwipeEnabled) Enable the swipe operation on the ViewHolder.
void	setSwipeFlags(int swipeFlags) Configures the directions in which the item can be swiped.
void	setSwipeThreshold(float threshold) Configures the fraction that the user should move the View to be considered as swiped.

Methods inherited from class java.lang.Object

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

Field Detail

ALPHA_FULL

protected static final float ALPHA_FULL

See Also:

Constant Field Values

mAdapterCallback

protected ItemTouchHelperCallback.AdapterCallback mAdapterCallback

longPressDragEnabled

protected boolean longPressDragEnabled

handleDragEnabled

protected boolean handleDragEnabled

swipeEnabled

protected boolean swipeEnabled

mSwipeAnimationDuration

protected long mSwipeAnimationDuration

mDragAnimationDuration

protected long mDragAnimationDuration

mSwipeThreshold

protected float mSwipeThreshold

mMoveThreshold

protected float mMoveThreshold

mSwipeFlags

protected int mSwipeFlags

Constructor Detail

ItemTouchHelperCallback

public ItemTouchHelperCallback(ItemTouchHelperCallback.AdapterCallback adapterCallback)

Method Detail

setLongPressDragEnabled

public void setLongPressDragEnabled(boolean isLongPressDragEnabled)

Enable / Disable the drag operation with long press on the ViewHolder.

Default value is false.

Parameters:

isLongPressDragEnabled - true to enable, false to disable

isLongPressDragEnabled

public boolean isLongPressDragEnabled()

isHandleDragEnabled

public boolean isHandleDragEnabled()

Returns:

true if handle drag is enabled, false otherwise

setHandleDragEnabled

public void setHandleDragEnabled(boolean handleDragEnabled)

Enable / Disable the drag of the itemView with a handle view.

Default value is false.

Parameters:

handleDragEnabled - true to activate, false to disable

Since:

5.0.0-b1

canDropOver

public boolean canDropOver(RecyclerView recyclerView,
                           RecyclerView.ViewHolder current,
                           RecyclerView.ViewHolder target)

setMoveThreshold

public void setMoveThreshold(float moveThreshold)

Configures the fraction that the user should move the View to be considered as it is dragged. After a view is moved this amount, ItemTouchHelper starts checking for Views below it for a possible drop.

Default value is 0.5f.

Parameters:

moveThreshold - A float value that denotes the fraction of the View size.

getMoveThreshold

public float getMoveThreshold(RecyclerView.ViewHolder viewHolder)

setSwipeEnabled

public void setSwipeEnabled(boolean isSwipeEnabled)

Enable the swipe operation on the ViewHolder.

Default value is false.

Parameters:

isSwipeEnabled - true to enable swipe, false to disable

isItemViewSwipeEnabled

public boolean isItemViewSwipeEnabled()

setSwipeThreshold

public void setSwipeThreshold(float threshold)

Configures the fraction that the user should move the View to be considered as swiped.

Default value is 0.5f.

Parameters:

threshold - A float value that denotes the fraction of the View size.

setSwipeFlags

public void setSwipeFlags(int swipeFlags)

Configures the directions in which the item can be swiped.

Default values are ItemTouchHelper#LEFT, ItemTouchHelper#RIGHT for VERTICAL LinearLayout.

NOTE: Swipe is not supported in case of GridLayout and StaggeredGridLayout.

Parameters:

swipeFlags - flags directions, a combination of: ItemTouchHelper#LEFT, ItemTouchHelper#RIGHT, ItemTouchHelper#UP, ItemTouchHelper#DOWN

getSwipeThreshold

public float getSwipeThreshold(RecyclerView.ViewHolder viewHolder)

Returns the fraction that the user should move the View to be considered as swiped. The fraction is calculated with respect to RecyclerView's bounds.

Default value is 0.5f, which means, to swipe a View, user must move the View at least half of RecyclerView's width or height, depending on the swipe direction.

Parameters:

viewHolder - The ViewHolder that is being dragged.

Returns:

A float value that denotes the fraction of the View size.

setDragAnimationDuration

public void setDragAnimationDuration(long animationDuration)

Sets the animation duration of Drag event, starting when the items is released.

Default value is 400ms.

Parameters:

animationDuration - duration in milliseconds

setSwipeAnimationDuration

public void setSwipeAnimationDuration(long animationDuration)

Sets the animation duration of Swipe removal event, starting when the items is released.

Default value is 300ms.

Parameters:

animationDuration - duration in milliseconds

getAnimationDuration

public long getAnimationDuration(RecyclerView recyclerView,
                                 int animationType,
                                 float animateDx,
                                 float animateDy)

Provides the animation duration for Drag and Swipe previously set with setDragAnimationDuration(long) and setSwipeAnimationDuration(long).

Returns:

Drag or Swipe animation duration depending the animationType

See Also:

setDragAnimationDuration(long), setSwipeAnimationDuration(long)

onMove

public boolean onMove(RecyclerView recyclerView,
                      RecyclerView.ViewHolder viewHolder,
                      RecyclerView.ViewHolder target)

onSwiped

public void onSwiped(RecyclerView.ViewHolder viewHolder,
                     int direction)

getMovementFlags

public int getMovementFlags(RecyclerView recyclerView,
                            RecyclerView.ViewHolder viewHolder)

onSelectedChanged

public void onSelectedChanged(RecyclerView.ViewHolder viewHolder,
                              int actionState)

clearView

public void clearView(RecyclerView recyclerView,
                      RecyclerView.ViewHolder viewHolder)

onChildDraw

public void onChildDraw(android.graphics.Canvas c,
                        RecyclerView recyclerView,
                        RecyclerView.ViewHolder viewHolder,
                        float dX,
                        float dY,
                        int actionState,
                        boolean isCurrentlyActive)