ItemTouchHelper.SimpleCallback - Android SDK

Interfaces
- ItemTouchHelper.ViewDropHandler
- ItemTouchUIUtil
Classes

Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

public static abstract class

ItemTouchHelper.SimpleCallback

extends ItemTouchHelper.Callback

java.lang.Object
↳	android.support.v7.widget.helper.ItemTouchHelper.Callback
	↳	android.support.v7.widget.helper.ItemTouchHelper.SimpleCallback

Class Overview

A simple wrapper to the default Callback which you can construct with drag and swipe directions and this class will handle the flag callbacks. You should still override onMove or onSwiped depending on your use case.

 ItemTouchHelper mIth = new ItemTouchHelper(
     new ItemTouchHelper.SimpleCallback(ItemTouchHelper.UP | ItemTouchHelper.DOWN,
         ItemTouchHelper.LEFT) {
         public abstract boolean onMove(RecyclerView recyclerView,
             ViewHolder viewHolder, ViewHolder target) {
             final int fromPos = viewHolder.getAdapterPosition();
             final int toPos = viewHolder.getAdapterPosition();
             // move item in `fromPos` to `toPos` in adapter.
             return true;// true if moved, false otherwise
         }
         public void onSwiped(ViewHolder viewHolder, int direction) {
             // remove from adapter
         }
 });

Summary

[Expand]

Inherited Constants

From class android.support.v7.widget.helper.ItemTouchHelper.Callback

Public Constructors
	ItemTouchHelper.SimpleCallback(int dragDirs, int swipeDirs) Creates a Callback for the given drag and swipe allowance.

Public Methods
int	getDragDirs(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) Returns the drag directions for the provided ViewHolder.
int	getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) Should return a composite flag which defines the enabled move directions in each state (idle, swiping, dragging).
int	getSwipeDirs(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) Returns the swipe directions for the provided ViewHolder.
void	setDefaultDragDirs(int defaultDragDirs) Updates the default drag directions.
void	setDefaultSwipeDirs(int defaultSwipeDirs) Updates the default swipe directions.

[Expand]

Inherited Methods

From class android.support.v7.widget.helper.ItemTouchHelper.Callback

boolean	canDropOver(RecyclerView recyclerView, RecyclerView.ViewHolder current, RecyclerView.ViewHolder target) Return true if the current ViewHolder can be dropped over the the target ViewHolder.
RecyclerView.ViewHolder	chooseDropTarget(RecyclerView.ViewHolder selected, List<RecyclerView.ViewHolder> dropTargets, int curX, int curY) Called by ItemTouchHelper to select a drop target from the list of ViewHolders that are under the dragged View.
void	clearView(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) Called by the ItemTouchHelper when the user interaction with an element is over and it also completed its animation.
int	convertToAbsoluteDirection(int flags, int layoutDirection) Converts a given set of flags to absolution direction which means `START` and `END` are replaced with `LEFT` and `RIGHT` depending on the layout direction.
static int	convertToRelativeDirection(int flags, int layoutDirection) Replaces a movement direction with its relative version by taking layout direction into account.
long	getAnimationDuration(RecyclerView recyclerView, int animationType, float animateDx, float animateDy) Called by the ItemTouchHelper when user action finished on a ViewHolder and now the View will be animated to its final position.
int	getBoundingBoxMargin() When finding views under a dragged view, by default, ItemTouchHelper searches for views that overlap with the dragged View.
static ItemTouchUIUtil	getDefaultUIUtil() Returns the `ItemTouchUIUtil` that is used by the `ItemTouchHelper.Callback` class for visual changes on Views in response to user interactions.
float	getMoveThreshold(RecyclerView.ViewHolder viewHolder) Returns the fraction that the user should move the View to be considered as it is dragged.
abstract int	getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) Should return a composite flag which defines the enabled move directions in each state (idle, swiping, dragging).
float	getSwipeThreshold(RecyclerView.ViewHolder viewHolder) Returns the fraction that the user should move the View to be considered as swiped.
int	interpolateOutOfBoundsScroll(RecyclerView recyclerView, int viewSize, int viewSizeOutOfBounds, int totalSize, long msSinceStartScroll) Called by the ItemTouchHelper when user is dragging a view out of bounds.
boolean	isItemViewSwipeEnabled() Returns whether ItemTouchHelper should start a swipe operation if a pointer is swiped over the View.
boolean	isLongPressDragEnabled() Returns whether ItemTouchHelper should start a drag and drop operation if an item is long pressed.
static int	makeFlag(int actionState, int directions) Shifts the given direction flags to the offset of the given action state.
static int	makeMovementFlags(int dragFlags, int swipeFlags) Convenience method to create movement flags.
void	onChildDraw(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) Called by ItemTouchHelper on RecyclerView's onDraw callback.
void	onChildDrawOver(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) Called by ItemTouchHelper on RecyclerView's onDraw callback.
abstract boolean	onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) Called when ItemTouchHelper wants to move the dragged item from its old position to the new position.
void	onMoved(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, int fromPos, RecyclerView.ViewHolder target, int toPos, int x, int y) Called when `onMove(RecyclerView, ViewHolder, ViewHolder)` returns true.
void	onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState) Called when the ViewHolder swiped or dragged by the ItemTouchHelper is changed.
abstract void	onSwiped(RecyclerView.ViewHolder viewHolder, int direction) Called when a ViewHolder is swiped by the user.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public ItemTouchHelper.SimpleCallback (int dragDirs, int swipeDirs)

Creates a Callback for the given drag and swipe allowance. These values serve as defaults and if you want to customize behavior per ViewHolder, you can override getSwipeDirs(RecyclerView, ViewHolder) and / or getDragDirs(RecyclerView, ViewHolder).

Parameters

dragDirs	Binary OR of direction flags in which the Views can be dragged. Must be composed of `LEFT`, `RIGHT`, `START`, `END`, `UP` and `DOWN`.
swipeDirs	Binary OR of direction flags in which the Views can be swiped. Must be composed of `LEFT`, `RIGHT`, `START`, `END`, `UP` and `DOWN`.

Public Methods

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

Returns the drag directions for the provided ViewHolder. Default implementation returns the drag directions that was set via constructor or setDefaultDragDirs(int).

Parameters

recyclerView	The RecyclerView to which the ItemTouchHelper is attached to.
viewHolder	The RecyclerView for which the swipe drection is queried.

Returns

A binary OR of direction flags.

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

Should return a composite flag which defines the enabled move directions in each state (idle, swiping, dragging).

Instead of composing this flag manually, you can use makeMovementFlags(int, int) or makeFlag(int, int).

This flag is composed of 3 sets of 8 bits, where first 8 bits are for IDLE state, next 8 bits are for SWIPE state and third 8 bits are for DRAG state. Each 8 bit sections can be constructed by simply OR'ing direction flags defined in ItemTouchHelper.

For example, if you want it to allow swiping LEFT and RIGHT but only allow starting to swipe by swiping RIGHT, you can return:

      makeFlag(ACTION_STATE_IDLE, RIGHT) | makeFlag(ACTION_STATE_SWIPE, LEFT | RIGHT);

This means, allow right movement while IDLE and allow right and left movement while swiping.

Parameters

recyclerView	The RecyclerView to which ItemTouchHelper is attached.
viewHolder	The ViewHolder for which the movement information is necessary.

Returns

flags specifying which movements are allowed on this ViewHolder.

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

Returns the swipe directions for the provided ViewHolder. Default implementation returns the swipe directions that was set via constructor or setDefaultSwipeDirs(int).

Parameters

recyclerView	The RecyclerView to which the ItemTouchHelper is attached to.
viewHolder	The RecyclerView for which the swipe drection is queried.

Returns

A binary OR of direction flags.

public void setDefaultDragDirs (int defaultDragDirs)

Updates the default drag directions. For example, you can use this method to toggle certain directions depending on your use case.

Parameters

defaultDragDirs	Binary OR of directions in which the ViewHolders can be dragged.

public void setDefaultSwipeDirs (int defaultSwipeDirs)

Updates the default swipe directions. For example, you can use this method to toggle certain directions depending on your use case.

Parameters

defaultSwipeDirs	Binary OR of directions in which the ViewHolders can be swiped.

Results

Interfaces

Classes

ItemTouchHelper.SimpleCallback

Class Overview

Summary

Public Constructors

public ItemTouchHelper.SimpleCallback (int dragDirs, int swipeDirs)

Parameters

Public Methods

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

public void setDefaultDragDirs (int defaultDragDirs)

Parameters

public void setDefaultSwipeDirs (int defaultSwipeDirs)

Parameters