DragHelper (library API)

java.lang.Object
- de.mrapp.android.util.gesture.DragHelper

```
public class DragHelper
extends java.lang.Object
```
A helper class, which may be used to measure the distance and speed of drag gestures.

Since:

1.4.0

Constructor Summary

Constructors
Constructor and Description

DragHelper(int threshold)
Creates a new helper class, which may be used to measure the distance and speed of drag gestures.

Constructors
Constructor and Description
`DragHelper(int threshold)` Creates a new helper class, which may be used to measure the distance and speed of drag gestures.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getDistance()` Deprecated. Use `getDragDistance`-method instead
`float`	`getDragDistance()` Returns the distance, which has been passed while dragging, in pixels.
`float`	`getDragSpeed()` Returns the speed of the drag gesture in pixels per millisecond.
`float`	`getDragStartPosition()` Returns the position, where the drag gesture has been started at.
`float`	`getMaxDragDistance()` Returns the maximum drag distance.
`float`	`getMinDragDistance()` Returns the minimum drag distance.
`int`	`getStartPosition()` Deprecated. Use `getDragStartPosition`-method instead
`int`	`getThreshold()` Returns the distance in pixels, the gesture must last until it is recognized.
`boolean`	`hasThresholdBeenReached()` Returns, whether the threshold has already been reached, or not.
`boolean`	`isReset()` Returns, whether the instance has been marked to be reset, since the method `update(float):void` has been called the last time.
`boolean`	`isReseted()` Deprecated. Use `isReset`-method instead
`void`	`reset()` Marks the instance to be reset.
`void`	`reset(int threshold)` Marks the instance to be reset.
`void`	`setMaxDragDistance(float maxDragDistance)` Sets the maximum drag distance.
`void`	`setMinDragDistance(float minDragDistance)` Sets the minimum drag distance.
`void`	`update(float position)` Updates the instance by adding a new position.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DragHelper
```
public DragHelper(int threshold)
```
    Creates a new helper class, which may be used to measure the distance and speed of drag gestures.
    
    Parameters:
    
    threshold - The distance in pixels, the gesture must last until it is recognized, as an Integer value. The value must be at least 0
- Method Detail
  - getThreshold
```
public final int getThreshold()
```
    Returns the distance in pixels, the gesture must last until it is recognized.
    
    Returns:
    
    The distance in pixels, the gesture must last until it is recognized, as an Integer value. The value must be at least 0
  - reset
```
public final void reset()
```
    Marks the instance to be reset. This will cause all properties to be reset to default values, when a value is added by calling the method update(float):void the next time. Therefore this method may be used to start recognizing a new drag gesture, whenever a value is added the next time, while the values of the previous recognition can be still retrieved until recognizing the new gesture begins.
  - reset
```
public final void reset(int threshold)
```
    Marks the instance to be reset. This will cause all properties to be reset to default values, when a value is added by calling the method update(float):void the next time. Therefore this method may be used to start recognizing a new drag gesture, whenever a value is added the next time, while the values of the previous recognition can be still retrieved until recognizing the new gesture begins. Furthermore, this method changes the threshold, which is used by the instance.
    
    Parameters:
    
    threshold - The distance in pixels, the gesture must last until it is recognized, as an Integer value. The value must be at least 0
  - isReseted
```
@Deprecated
public final boolean isReseted()
```
    Deprecated. Use isReset-method instead
    
    Returns, whether the instance has been marked to be reset, since the method update(float):void has been called the last time. See method reset():void for further information.
    
    Returns:
    
    True, if the instance has been marked to be reset, false otherwise
  - isReset
```
public final boolean isReset()
```
    Returns, whether the instance has been marked to be reset, since the method update(float):void has been called the last time. See method reset():void for further information.
    
    Returns:
    
    True, if the instance has been marked to be reset, false otherwise
  - update
```
public final void update(float position)
```
    Updates the instance by adding a new position. This will cause all properties to be re-calculated, depending on the new position.
    
    Parameters:
    
    position - The position, which should be added, as a Float value
  - getMaxDragDistance
```
public final float getMaxDragDistance()
```
    Returns the maximum drag distance.
    
    Returns:
    
    The maximum drag distance in pixels as a Float value or 0, if no maximum drag distance is set
  - setMaxDragDistance
```
public final void setMaxDragDistance(float maxDragDistance)
```
    Sets the maximum drag distance.
    
    Parameters:
    
    maxDragDistance - The maximum drag distance, which should be set, in pixels as a Float value or 0, if no maximum drag distance should be set
  - getMinDragDistance
```
public final float getMinDragDistance()
```
    Returns the minimum drag distance.
    
    Returns:
    
    The minimum drag distance in pixels as a Float value or 0, if no minimum drag distance is set
  - setMinDragDistance
```
public final void setMinDragDistance(float minDragDistance)
```
    Sets the minimum drag distance.
    
    Parameters:
    
    minDragDistance - The minimum drag distance, which should be set, in pixels as a Float value or 0, if no minimum drag distance should be set
  - hasThresholdBeenReached
```
public final boolean hasThresholdBeenReached()
```
    Returns, whether the threshold has already been reached, or not.
    
    Returns:
    
    True, if the threshold has been already reached, false otherwise
  - getDistance
```
@Deprecated
public final int getDistance()
```
    Deprecated. Use getDragDistance-method instead
    
    Returns the distance, which has been passed while dragging, in pixels.
    
    Returns:
    
    The distance, which has been passed while dragging, as an Integer value or 0, if the threshold has not been reached yet
  - getDragDistance
```
public final float getDragDistance()
```
    Returns the distance, which has been passed while dragging, in pixels.
    
    Returns:
    
    The distance, which has been passed while dragging, as a Float value or 0, if the threshold has not been reached yet
  - getStartPosition
```
@Deprecated
public final int getStartPosition()
```
    Deprecated. Use getDragStartPosition-method instead
    
    Returns the position, where the gesture has been started at.
    
    Returns:
    
    The position, where the gesture has been started at, as an Integer value or -1, if no gesture has been started yet
  - getDragStartPosition
```
public final float getDragStartPosition()
```
    Returns the position, where the drag gesture has been started at.
    
    Returns:
    
    The position, where the drag gesture has been started at, as a Float value or -1, if no gesture has been started yet
  - getDragSpeed
```
public final float getDragSpeed()
```
    Returns the speed of the drag gesture in pixels per millisecond.
    
    Returns:
    
    The speed of the drag gesture as a Float value or -1, if the threshold has not been reached yet

Class DragHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DragHelper

Method Detail

getThreshold

reset

reset

isReseted

isReset

update

getMaxDragDistance

setMaxDragDistance

getMinDragDistance

setMinDragDistance

hasThresholdBeenReached

getDistance

getDragDistance

getStartPosition

getDragStartPosition

getDragSpeed