# ItemTouchHelper.SimpleCallback

Artifact: [androidx.recyclerview:recyclerview](https://developer.android.com/jetpack/androidx/releases/recyclerview) [View Source](https://cs.android.com/search?q=file:androidx/recyclerview/widget/ItemTouchHelper.java+class:androidx.recyclerview.widget.ItemTouchHelper.SimpleCallback) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

*** ** * ** ***


```
public abstract class ItemTouchHelper.SimpleCallback extends ItemTouchHelper.Callback
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.recyclerview.widget.ItemTouchHelper.Callback](https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback) ||
|   | ↳ | [androidx.recyclerview.widget.ItemTouchHelper.SimpleCallback](https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback) |

*** ** * ** ***

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 boolean onMove(RecyclerView recyclerView,
            ViewHolder viewHolder, ViewHolder target) {
            final int fromPos = viewHolder.getAdapterPosition();
            final int toPos = target.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

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#SimpleCallback(int,int)(int dragDirs, int swipeDirs)` Creates a Callback for the given drag and swipe allowance. |

| ### Public methods |
|---|---|
| `int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#getDragDirs(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder )` Returns the drag directions for the provided ViewHolder. |
| `int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#getMovementFlags(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder )` Should return a composite flag which defines the enabled move directions in each state (idle, swiping, dragging). |
| `int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#getSwipeDirs(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder )` Returns the swipe directions for the provided ViewHolder. |
| `void` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#setDefaultDragDirs(int)(int defaultDragDirs)` Updates the default drag directions. |
| `void` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#setDefaultSwipeDirs(int)(int defaultSwipeDirs)` Updates the default swipe directions. |

| ### Inherited Constants |
|---|
| From [androidx.recyclerview.widget.ItemTouchHelper.Callback](https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback) |---|---| | `static final int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#DEFAULT_DRAG_ANIMATION_DURATION() = 200` | | `static final int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#DEFAULT_SWIPE_ANIMATION_DURATION() = 250` | |

| ### Inherited methods |
|---|
| From [androidx.recyclerview.widget.ItemTouchHelper.Callback](https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback) |---|---| | `boolean` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#canDropOver(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder,androidx.recyclerview.widget.RecyclerView.ViewHolder)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder current, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder target )` Return true if the current ViewHolder can be dropped over the the target ViewHolder. | | `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#chooseDropTarget(androidx.recyclerview.widget.RecyclerView.ViewHolder,java.util.List<androidx.recyclerview.widget.RecyclerView.ViewHolder>,int,int)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder selected, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/recyclerview/widget/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` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#clearView(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder )` Called by the ItemTouchHelper when the user interaction with an element is over and it also completed its animation. | | `int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#convertToAbsoluteDirection(int,int)(int flags, int layoutDirection)` Converts a given set of flags to absolution direction which means `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#START()` and `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#END()` are replaced with `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#LEFT()` and `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#RIGHT()` depending on the layout direction. | | `static int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#convertToRelativeDirection(int,int)(int flags, int layoutDirection)` Replaces a movement direction with its relative version by taking layout direction into account. | | `long` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#getAnimationDuration(androidx.recyclerview.widget.RecyclerView,int,float,float)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/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` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#getBoundingBoxMargin()()` When finding views under a dragged view, by default, ItemTouchHelper searches for views that overlap with the dragged View. | | `static @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchUIUtil` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#getDefaultUIUtil()()` Returns the `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchUIUtil` that is used by the `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback` class for visual changes on Views in response to user interactions. | | `float` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#getMoveThreshold(androidx.recyclerview.widget.RecyclerView.ViewHolder)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder)` Returns the fraction that the user should move the View to be considered as it is dragged. | | `float` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#getSwipeEscapeVelocity(float)(float defaultValue)` Defines the minimum velocity which will be considered as a swipe action by the user. | | `float` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#getSwipeThreshold(androidx.recyclerview.widget.RecyclerView.ViewHolder)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder)` Returns the fraction that the user should move the View to be considered as swiped. | | `float` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#getSwipeVelocityThreshold(float)(float defaultValue)` Defines the maximum velocity ItemTouchHelper will ever calculate for pointer movements. | | `int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#interpolateOutOfBoundsScroll(androidx.recyclerview.widget.RecyclerView,int,int,int,long)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, int viewSize, int viewSizeOutOfBounds, int totalSize, long msSinceStartScroll )` Called by the ItemTouchHelper when user is dragging a view out of bounds. | | `boolean` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#isItemViewSwipeEnabled()()` Returns whether ItemTouchHelper should start a swipe operation if a pointer is swiped over the View. | | `boolean` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#isLongPressDragEnabled()()` Returns whether ItemTouchHelper should start a drag and drop operation if an item is long pressed. | | `static int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#makeFlag(int,int)(int actionState, int directions)` Shifts the given direction flags to the offset of the given action state. | | `static int` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#makeMovementFlags(int,int)(int dragFlags, int swipeFlags)` Convenience method to create movement flags. | | `void` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#onChildDraw(android.graphics.Canvas,androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder,float,float,int,boolean)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Canvas.html c, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive )` Called by ItemTouchHelper on RecyclerView's onDraw callback. | | `void` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#onChildDrawOver(android.graphics.Canvas,androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder,float,float,int,boolean)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Canvas.html c, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive )` Called by ItemTouchHelper on RecyclerView's onDraw callback. | | `abstract boolean` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#onMove(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder,androidx.recyclerview.widget.RecyclerView.ViewHolder)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder target )` Called when ItemTouchHelper wants to move the dragged item from its old position to the new position. | | `void` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#onMoved(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder,int,androidx.recyclerview.widget.RecyclerView.ViewHolder,int,int,int)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder, int fromPos, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder target, int toPos, int x, int y )` Called when `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#onMove(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder,androidx.recyclerview.widget.RecyclerView.ViewHolder)` returns true. | | `void` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#onSelectedChanged(androidx.recyclerview.widget.RecyclerView.ViewHolder,int)( @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder, int actionState )` Called when the ViewHolder swiped or dragged by the ItemTouchHelper is changed. | | `abstract void` | `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#onSwiped(androidx.recyclerview.widget.RecyclerView.ViewHolder,int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder, int direction)` Called when a ViewHolder is swiped by the user. | |

## Public constructors

### SimpleCallback

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
public 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 `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#getSwipeDirs(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder)` and / or `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#getDragDirs(androidx.recyclerview.widget.RecyclerView,androidx.recyclerview.widget.RecyclerView.ViewHolder)`.

| Parameters |
|---|---|
| `int dragDirs` | Binary OR of direction flags in which the Views can be dragged. Must be composed of `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#LEFT()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#RIGHT()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#START()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#END()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#UP()` and `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#DOWN()`. |
| `int swipeDirs` | Binary OR of direction flags in which the Views can be swiped. Must be composed of `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#LEFT()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#RIGHT()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#START()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#END()`, `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#UP()` and `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#DOWN()`. |

## Public methods

### getDragDirs

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
public int getDragDirs(
    @NonNull RecyclerView recyclerView,
    @NonNull RecyclerView.ViewHolder viewHolder
)
```

Returns the drag directions for the provided ViewHolder. Default implementation returns the drag directions that was set via constructor or `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#setDefaultDragDirs(int)`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView` | The RecyclerView to which the ItemTouchHelper is attached to. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder` | The ViewHolder for which the swipe direction is queried. |

| Returns |
|---|---|
| `int` | A binary OR of direction flags. |

### getMovementFlags

Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.4.0)

```
public int getMovementFlags(
    @NonNull RecyclerView recyclerView,
    @NonNull 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 `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#makeMovementFlags(int,int)` or `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#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 `https://developer.android.com/reference/androidx/recyclerview/widget/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 |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView` | The RecyclerView to which ItemTouchHelper is attached. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder` | The ViewHolder for which the movement information is necessary. |

| Returns |
|---|---|
| `int` | flags specifying which movements are allowed on this ViewHolder. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#makeMovementFlags(int,int)` |   |
| `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.Callback#makeFlag(int,int)` |   |

### getSwipeDirs

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
public int getSwipeDirs(
    @NonNull RecyclerView recyclerView,
    @NonNull RecyclerView.ViewHolder viewHolder
)
```

Returns the swipe directions for the provided ViewHolder. Default implementation returns the swipe directions that was set via constructor or `https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper.SimpleCallback#setDefaultSwipeDirs(int)`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView recyclerView` | The RecyclerView to which the ItemTouchHelper is attached to. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.ViewHolder viewHolder` | The ViewHolder for which the swipe direction is queried. |

| Returns |
|---|---|
| `int` | A binary OR of direction flags. |

### setDefaultDragDirs

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
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 |
|---|---|
| `int defaultDragDirs` | Binary OR of directions in which the ViewHolders can be dragged. |

### setDefaultSwipeDirs

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/recyclerview#1.0.0)

```
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 |
|---|---|
| `int defaultSwipeDirs` | Binary OR of directions in which the ViewHolders can be swiped. |