# OnSwipe

Artifact: [androidx.constraintlayout:constraintlayout-core](https://developer.android.com/jetpack/androidx/releases/constraintlayout) [View Source](https://cs.android.com/search?q=file:androidx/constraintlayout/core/dsl/OnSwipe.java+class:androidx.constraintlayout.core.dsl.OnSwipe) Added in [1.1.2](https://developer.android.com/jetpack/androidx/releases/constraintlayout#1.1.2)

*** ** * ** ***


```
public class OnSwipe
```

<br />

*** ** * ** ***

Create automatic swipe handling object

## Summary

| ### Nested types |
|---|
| `public enum https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Boundary` |
| `public enum https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Drag` |
| `public enum https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Mode` |
| `public enum https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Side` |
| `public enum https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.TouchUp` |

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#FLAG_DISABLE_POST_SCROLL() = 1` |
| `static final int` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#FLAG_DISABLE_SCROLL() = 2` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#OnSwipe()()` |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#OnSwipe(java.lang.String,androidx.constraintlayout.core.dsl.OnSwipe.Side,androidx.constraintlayout.core.dsl.OnSwipe.Drag)(https://developer.android.com/reference/java/lang/String.html anchor, https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Side side, https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Drag dragDirection)` |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Mode` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getAutoCompleteMode()()` |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Drag` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getDragDirection()()` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getDragScale()()` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getDragThreshold()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getLimitBoundsTo()()` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getMaxAcceleration()()` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getMaxVelocity()()` |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.TouchUp` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getOnTouchUp()()` |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getRotationCenterId()()` |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Boundary` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getSpringBoundary()()` The behaviour at the boundaries 0 and 1 |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getSpringDamping()()` |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getSpringMass()()` Get the mass of the spring. the m in "a = (-k\*x-c\*v)/m" equation for the acceleration of a spring |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getSpringStiffness()()` get the stiffness of the spring |
| `float` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getSpringStopThreshold()()` The threshold for spring motion to stop. |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getTouchAnchorId()()` |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Side` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#getTouchAnchorSide()()` |
| `void` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setAutoCompleteMode(androidx.constraintlayout.core.dsl.OnSwipe.Mode)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Mode autoCompleteMode)` sets the behaviour at the boundaries 0 and 1 COMPLETE_MODE_CONTINUOUS_VELOCITY = 0; COMPLETE_MODE_SPRING = 1; |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setDragDirection(androidx.constraintlayout.core.dsl.OnSwipe.Drag)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Drag dragDirection)` The direction of the drag. |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setDragScale(int)(int dragScale)` Normally 1 this can be tweaked to make the acceleration faster |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setDragThreshold(int)(int dragThreshold)` This sets the threshold before the animation is kicked off. |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setLimitBoundsTo(java.lang.String)(https://developer.android.com/reference/java/lang/String.html id)` Only allow touch actions to be initiated within this region |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setMaxAcceleration(int)(int maxAcceleration)` The maximum acceleration and deceleration of the animation (Change in Change in progress per second) Faster makes the object seem lighter and quicker |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setMaxVelocity(int)(int maxVelocity)` The maximum velocity (Change in progress per second) animation can achieve |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setOnTouchUp(androidx.constraintlayout.core.dsl.OnSwipe.TouchUp)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.TouchUp mode)` Configures what happens when the user releases on mouse up. |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setRotateCenter(java.lang.String)(https://developer.android.com/reference/java/lang/String.html rotationCenterId)` The view to center the rotation about |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setSpringBoundary(androidx.constraintlayout.core.dsl.OnSwipe.Boundary)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Boundary springBoundary)` The behaviour at the boundaries 0 and 1. |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setSpringDamping(float)(float springDamping)` Set the damping of the spring if using spring. c in "a = (-k\*x-c\*v)/m" equation for the acceleration of a spring |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setSpringMass(float)(float springMass)` Set the Mass of the spring if using spring. m in "a = (-k\*x-c\*v)/m" equation for the acceleration of a spring |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setSpringStiffness(float)(float springStiffness)` set the stiffness of the spring if using spring. |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setSpringStopThreshold(float)(float springStopThreshold)` set the threshold for spring motion to stop. |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setTouchAnchorId(java.lang.String)(https://developer.android.com/reference/java/lang/String.html id)` The id of the view who's movement is matched to your drag If not specified it will map to a linear movement across the width of the motionLayout |
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#setTouchAnchorSide(androidx.constraintlayout.core.dsl.OnSwipe.Side)(https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Side side)` This side of the view that matches the drag movement. |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe#toString()()` |

## Constants

### FLAG_DISABLE_POST_SCROLL

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

```
public static final int FLAG_DISABLE_POST_SCROLL = 1
```

### FLAG_DISABLE_SCROLL

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

```
public static final int FLAG_DISABLE_SCROLL = 2
```

## Public constructors

### OnSwipe

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

```
public OnSwipe()
```

### OnSwipe

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

```
public OnSwipe(String anchor, OnSwipe.Side side, OnSwipe.Drag dragDirection)
```

## Public methods

### getAutoCompleteMode

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

```
public OnSwipe.Mode getAutoCompleteMode()
```

### getDragDirection

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

```
public OnSwipe.Drag getDragDirection()
```

### getDragScale

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

```
public float getDragScale()
```

### getDragThreshold

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

```
public float getDragThreshold()
```

### getLimitBoundsTo

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

```
public String getLimitBoundsTo()
```

### getMaxAcceleration

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

```
public float getMaxAcceleration()
```

### getMaxVelocity

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

```
public float getMaxVelocity()
```

### getOnTouchUp

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

```
public OnSwipe.TouchUp getOnTouchUp()
```

### getRotationCenterId

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

```
public String getRotationCenterId()
```

### getSpringBoundary

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

```
public OnSwipe.Boundary getSpringBoundary()
```

The behaviour at the boundaries 0 and 1

### getSpringDamping

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

```
public float getSpringDamping()
```

### getSpringMass

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

```
public float getSpringMass()
```

Get the mass of the spring. the m in "a = (-k\*x-c\*v)/m" equation for the acceleration of a spring

### getSpringStiffness

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

```
public float getSpringStiffness()
```

get the stiffness of the spring

| Returns |
|---|---|
| `float` | NaN if not set |

### getSpringStopThreshold

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

```
public float getSpringStopThreshold()
```

The threshold for spring motion to stop.

### getTouchAnchorId

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

```
public String getTouchAnchorId()
```

### getTouchAnchorSide

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

```
public OnSwipe.Side getTouchAnchorSide()
```

### setAutoCompleteMode

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

```
public void setAutoCompleteMode(OnSwipe.Mode autoCompleteMode)
```

sets the behaviour at the boundaries 0 and 1 COMPLETE_MODE_CONTINUOUS_VELOCITY = 0; COMPLETE_MODE_SPRING = 1;

### setDragDirection

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

```
public OnSwipe setDragDirection(OnSwipe.Drag dragDirection)
```

The direction of the drag.

### setDragScale

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

```
public OnSwipe setDragScale(int dragScale)
```

Normally 1 this can be tweaked to make the acceleration faster

### setDragThreshold

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

```
public OnSwipe setDragThreshold(int dragThreshold)
```

This sets the threshold before the animation is kicked off. It is important when have multi state animations the have some play before the System decides which animation to jump on.

### setLimitBoundsTo

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

```
public OnSwipe setLimitBoundsTo(String id)
```

Only allow touch actions to be initiated within this region

### setMaxAcceleration

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

```
public OnSwipe setMaxAcceleration(int maxAcceleration)
```

The maximum acceleration and deceleration of the animation (Change in Change in progress per second) Faster makes the object seem lighter and quicker

### setMaxVelocity

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

```
public OnSwipe setMaxVelocity(int maxVelocity)
```

The maximum velocity (Change in progress per second) animation can achieve

### setOnTouchUp

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

```
public OnSwipe setOnTouchUp(OnSwipe.TouchUp mode)
```

Configures what happens when the user releases on mouse up. One of: ON_UP_AUTOCOMPLETE, ON_UP_AUTOCOMPLETE_TO_START, ON_UP_AUTOCOMPLETE_TO_END, ON_UP_STOP, ON_UP_DECELERATE, ON_UP_DECELERATE_AND_COMPLETE

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.TouchUp mode` | default = ON_UP_AUTOCOMPLETE |

### setRotateCenter

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

```
public OnSwipe setRotateCenter(String rotationCenterId)
```

The view to center the rotation about

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | this |

### setSpringBoundary

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

```
public OnSwipe setSpringBoundary(OnSwipe.Boundary springBoundary)
```

The behaviour at the boundaries 0 and 1.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe.Boundary springBoundary` | behaviour at the boundaries |

### setSpringDamping

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

```
public OnSwipe setSpringDamping(float springDamping)
```

Set the damping of the spring if using spring. c in "a = (-k\*x-c\*v)/m" equation for the acceleration of a spring

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | this |

### setSpringMass

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

```
public OnSwipe setSpringMass(float springMass)
```

Set the Mass of the spring if using spring. m in "a = (-k\*x-c\*v)/m" equation for the acceleration of a spring

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/constraintlayout/core/dsl/OnSwipe` | this |

### setSpringStiffness

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

```
public OnSwipe setSpringStiffness(float springStiffness)
```

set the stiffness of the spring if using spring. If this is set the swipe will use a spring return system. If set to NaN it will revert to the norm system. K in "a = (-k\*x-c\*v)/m" equation for the acceleration of a spring

### setSpringStopThreshold

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

```
public OnSwipe setSpringStopThreshold(float springStopThreshold)
```

set the threshold for spring motion to stop. This is in change in progress / second If the spring will never go above that threshold again it will stop.

| Parameters |
|---|---|
| `float springStopThreshold` | when to stop. |

### setTouchAnchorId

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

```
public OnSwipe setTouchAnchorId(String id)
```

The id of the view who's movement is matched to your drag If not specified it will map to a linear movement across the width of the motionLayout

### setTouchAnchorSide

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

```
public OnSwipe setTouchAnchorSide(OnSwipe.Side side)
```

This side of the view that matches the drag movement. Only meaning full if the object changes size during the movement. (rotation is not considered)

### toString

```
public String toString()
```