SwipeHelper (smart-swipe API)

java.lang.Object
- com.billy.android.swipe.internal.SwipeHelper

```
public class SwipeHelper
extends java.lang.Object
```
This class is copy and modified from ViewDragHelper 1. mCapturedView removed. use mClampedDistanceX and mClampedDistanceY instead 2. Callback removed. use SwipeConsumer to consume the motion event

字段概要

字段
限定符和类型	字段和说明
`static int`	`INVALID_POINTER` A null/invalid pointer ID.
`static int`	`POINTER_NESTED_FLY`
`static int`	`POINTER_NESTED_SCROLL`
`static int`	`STATE_DRAGGING` A view is currently being dragged.
`static int`	`STATE_IDLE` A view is not currently being dragged or animating as a result of a fling/snap.
`static int`	`STATE_NONE_TOUCH`
`static int`	`STATE_SETTLING` A view is currently settling into place as a result of a fling or predefined non-interactive motion.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`abort()` `cancel()`, but also abort all motion in progress and snap to the end of any animation.
`void`	`cancel()` The result of a call to this method is equivalent to `processTouchEvent(android.view.MotionEvent)` receiving an ACTION_CANCEL event.
`boolean`	`continueSettling()`
`static SwipeHelper`	`create(android.view.ViewGroup forParent, float sensitivity, SwipeConsumer cb)`
`static SwipeHelper`	`create(android.view.ViewGroup forParent, float sensitivity, SwipeConsumer consumer, android.view.animation.Interpolator interpolator)` Factory method to create a new SwipeHelper.
`static SwipeHelper`	`create(android.view.ViewGroup forParent, SwipeConsumer consumer)`
`static SwipeHelper`	`create(android.view.ViewGroup forParent, SwipeConsumer consumer, android.view.animation.Interpolator interpolator)` Factory method to create a new SwipeHelper.
`void`	`dispatchViewReleased(float xvel, float yvel)` Like all callback events this must happen on the UI thread, but release involves some extra semantics.
`int`	`getActivePointerId()`
`int`	`getDragState()` Retrieve the current drag state of this helper.
`int`	`getMaxSettleDuration()`
`float`	`getMinVelocity()` Return the currently configured minimum velocity.
`SwipeConsumer`	`getSwipeConsumer()`
`int`	`getTouchSlop()`
`boolean`	`isPointerDown(int pointerId)` Check if the given pointer ID represents a pointer that is currently down (to the best of the SwipeHelper's knowledge).
`boolean`	`nestedScrollingDrag(int dx, int dy, int[] consumed, boolean fly)`
`void`	`nestedScrollingRelease()`
`boolean`	`nestedScrollingTrySwipe(int dx, int dy, boolean fly)`
`void`	`processTouchEvent(android.view.MotionEvent ev)` Process a touch event received by the parent view.
`void`	`setInterpolator(android.content.Context context, android.view.animation.Interpolator interpolator)`
`void`	`setMaxSettleDuration(int maxSettleDuration)`
`SwipeHelper`	`setMinVelocity(float minVel)` Set the minimum velocity that will be detected as having a magnitude greater than zero in pixels per second.
`void`	`setSensitivity(float sensitivity)`
`boolean`	`settleCapturedViewAt(int finalX, int finalY)` Settle the captured view at the given (left, top) position.
`boolean`	`shouldInterceptTouchEvent(android.view.MotionEvent ev)` Check if this event as provided to the parent view's onInterceptTouchEvent should cause the parent to intercept the touch event stream.
`boolean`	`smoothSlideTo(int finalX, int finalY)`
`boolean`	`smoothSlideTo(int startX, int startY, int finalX, int finalY)` Animate the view `child` to the given (left, top) position.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - INVALID_POINTER
```
public static final int INVALID_POINTER
```
    A null/invalid pointer ID.
    
    另请参阅:
    
    常量字段值
  - POINTER_NESTED_SCROLL
```
public static final int POINTER_NESTED_SCROLL
```
    另请参阅:
    
    常量字段值
  - POINTER_NESTED_FLY
```
public static final int POINTER_NESTED_FLY
```
    另请参阅:
    
    常量字段值
  - STATE_IDLE
```
public static final int STATE_IDLE
```
    A view is not currently being dragged or animating as a result of a fling/snap.
    
    另请参阅:
    
    常量字段值
  - STATE_DRAGGING
```
public static final int STATE_DRAGGING
```
    A view is currently being dragged. The position is currently changing as a result of user input or simulated user input.
    
    另请参阅:
    
    常量字段值
  - STATE_SETTLING
```
public static final int STATE_SETTLING
```
    A view is currently settling into place as a result of a fling or predefined non-interactive motion.
    
    另请参阅:
    
    常量字段值
  - STATE_NONE_TOUCH
```
public static final int STATE_NONE_TOUCH
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - create
```
public static SwipeHelper create(android.view.ViewGroup forParent,
                                 SwipeConsumer consumer,
                                 android.view.animation.Interpolator interpolator)
```
    Factory method to create a new SwipeHelper.
    
    参数:
    
    forParent - Parent view to monitor
    
    consumer - Callback to provide information and receive events
    
    interpolator - interpolator for animation
    
    返回:
    
    a new SwipeHelper instance
  - create
```
public static SwipeHelper create(android.view.ViewGroup forParent,
                                 SwipeConsumer consumer)
```
  - create
```
public static SwipeHelper create(android.view.ViewGroup forParent,
                                 float sensitivity,
                                 SwipeConsumer consumer,
                                 android.view.animation.Interpolator interpolator)
```
    Factory method to create a new SwipeHelper.
    
    参数:
    
    forParent - Parent view to monitor
    
    sensitivity - Multiplier for how sensitive the helper should be about detecting the start of a drag. Larger values are more sensitive. 1.0f is normal.
    
    consumer - Callback to provide information and receive events
    
    interpolator - interpolator for animation
    
    返回:
    
    a new SwipeHelper instance
  - create
```
public static SwipeHelper create(android.view.ViewGroup forParent,
                                 float sensitivity,
                                 SwipeConsumer cb)
```
  - setSensitivity
```
public void setSensitivity(float sensitivity)
```
  - setInterpolator
```
public void setInterpolator(android.content.Context context,
                            android.view.animation.Interpolator interpolator)
```
  - setMinVelocity
```
public SwipeHelper setMinVelocity(float minVel)
```
    Set the minimum velocity that will be detected as having a magnitude greater than zero in pixels per second. Callback methods accepting a velocity will be clamped appropriately.
    
    参数:
    
    minVel - Minimum velocity to detect
    
    返回:
    
    this
  - getMinVelocity
```
public float getMinVelocity()
```
    Return the currently configured minimum velocity. Any flings with a magnitude less than this value in pixels per second. Callback methods accepting a velocity will receive zero as a velocity value if the real detected velocity was below this threshold.
    
    返回:
    
    the minimum velocity that will be detected
  - getDragState
```
public int getDragState()
```
    Retrieve the current drag state of this helper. This will return one of STATE_IDLE, STATE_DRAGGING or STATE_SETTLING or STATE_NONE_TOUCH.
    
    返回:
    
    The current drag state
  - getActivePointerId
```
public int getActivePointerId()
```
    返回:
    
    The ID of the pointer currently dragging or INVALID_POINTER.
  - getTouchSlop
```
public int getTouchSlop()
```
    返回:
    
    The minimum distance in pixels that the user must travel to initiate a drag
  - cancel
```
public void cancel()
```
    The result of a call to this method is equivalent to processTouchEvent(android.view.MotionEvent) receiving an ACTION_CANCEL event.
  - abort
```
public void abort()
```
    cancel(), but also abort all motion in progress and snap to the end of any animation.
  - smoothSlideTo
```
public boolean smoothSlideTo(int startX,
                             int startY,
                             int finalX,
                             int finalY)
```
    Animate the view child to the given (left, top) position. If this method returns true, the caller should invoke continueSettling() on each subsequent frame to continue the motion until it returns false. If this method returns false there is no further work to do to complete the movement.
    
    参数:
    
    startX - start x position
    
    startY - start y position
    
    finalX - Final x position
    
    finalY - Final y position
    
    返回:
    
    true if animation should continue through continueSettling() calls
  - smoothSlideTo
```
public boolean smoothSlideTo(int finalX,
                             int finalY)
```
  - settleCapturedViewAt
```
public boolean settleCapturedViewAt(int finalX,
                                    int finalY)
```
    Settle the captured view at the given (left, top) position. The appropriate velocity from prior motion will be taken into account. If this method returns true, the caller should invoke continueSettling() on each subsequent frame to continue the motion until it returns false. If this method returns false there is no further work to do to complete the movement.
    
    参数:
    
    finalX - Settled left edge position for the captured view
    
    finalY - Settled top edge position for the captured view
    
    返回:
    
    true if animation should continue through continueSettling() calls
  - continueSettling
```
public boolean continueSettling()
```
  - dispatchViewReleased
```
public void dispatchViewReleased(float xvel,
                                 float yvel)
```
    Like all callback events this must happen on the UI thread, but release involves some extra semantics. During a release (mReleaseInProgress) is the only time it is valid to call settleCapturedViewAt(int, int)
    
    参数:
    
    xvel - x velocity
    
    yvel - y velocity
  - isPointerDown
```
public boolean isPointerDown(int pointerId)
```
    Check if the given pointer ID represents a pointer that is currently down (to the best of the SwipeHelper's knowledge).
    The state used to report this information is populated by the methods shouldInterceptTouchEvent(android.view.MotionEvent) or processTouchEvent(android.view.MotionEvent). If one of these methods has not been called for all relevant MotionEvents to track, the information reported by this method may be stale or incorrect.
    
    参数:
    
    pointerId - pointer ID to check; corresponds to IDs provided by MotionEvent
    
    返回:
    
    true if the pointer with the given ID is still down
  - shouldInterceptTouchEvent
```
public boolean shouldInterceptTouchEvent(android.view.MotionEvent ev)
```
    Check if this event as provided to the parent view's onInterceptTouchEvent should cause the parent to intercept the touch event stream.
    
    参数:
    
    ev - MotionEvent provided to onInterceptTouchEvent
    
    返回:
    
    true if the parent view should return true from onInterceptTouchEvent
  - processTouchEvent
```
public void processTouchEvent(android.view.MotionEvent ev)
```
    Process a touch event received by the parent view. This method will dispatch callback events as needed before returning. The parent view's onTouchEvent implementation should call this.
    
    参数:
    
    ev - The touch event received by the parent view
  - nestedScrollingTrySwipe
```
public boolean nestedScrollingTrySwipe(int dx,
                                       int dy,
                                       boolean fly)
```
  - nestedScrollingDrag
```
public boolean nestedScrollingDrag(int dx,
                                   int dy,
                                   int[] consumed,
                                   boolean fly)
```
  - nestedScrollingRelease
```
public void nestedScrollingRelease()
```
  - getSwipeConsumer
```
public SwipeConsumer getSwipeConsumer()
```
  - getMaxSettleDuration
```
public int getMaxSettleDuration()
```
  - setMaxSettleDuration
```
public void setMaxSettleDuration(int maxSettleDuration)
```

类 SwipeHelper

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

INVALID_POINTER

POINTER_NESTED_SCROLL

POINTER_NESTED_FLY

STATE_IDLE

STATE_DRAGGING

STATE_SETTLING

STATE_NONE_TOUCH

方法详细资料

create

create

create

create

setSensitivity

setInterpolator

setMinVelocity

getMinVelocity

getDragState

getActivePointerId

getTouchSlop

cancel

abort

smoothSlideTo

smoothSlideTo

settleCapturedViewAt

continueSettling

dispatchViewReleased

isPointerDown

shouldInterceptTouchEvent

processTouchEvent

nestedScrollingTrySwipe

nestedScrollingDrag

nestedScrollingRelease

getSwipeConsumer

getMaxSettleDuration

setMaxSettleDuration