SwipeConsumer (smart-swipe API)

java.lang.Object
- com.billy.android.swipe.SwipeConsumer

直接已知子类:: BezierBackConsumer, DrawerConsumer, ShuttersConsumer, SpaceConsumer, StayConsumer, StretchConsumer

public abstract class SwipeConsumer
extends java.lang.Object

Base class to consume swipe motion event, all subclasses should manage the following 4 direction swipes:

  1. DIRECTION_LEFT
  2. DIRECTION_RIGHT
  3. DIRECTION_TOP
  4. DIRECTION_BOTTOM

 To consume Motion Event via:
  when contentView is idle, SwipeConsumer hold the swipe motion event via tryAcceptMoving(int, float, float, float, float)
  In other cases, when contentView is settling, SwipeConsumer hold the swipe motion event via tryAcceptSettling(int, float, float)

字段概要

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_OPEN_DISTANCE_IN_DP`
`static int`	`DIRECTION_ALL`
`static int`	`DIRECTION_BOTTOM`
`static int`	`DIRECTION_HORIZONTAL`
`static int`	`DIRECTION_LEFT`
`static int`	`DIRECTION_NONE`
`static int`	`DIRECTION_RIGHT`
`static int`	`DIRECTION_TOP`
`static int`	`DIRECTION_VERTICAL`
`protected int`	`mCachedSwipeDistanceX` cached distance by last swipe
`protected int`	`mCachedSwipeDistanceY` cached distance by last swipe
`protected int`	`mCurDisplayDistanceX` distance to display for subclass to show UI these value is the calculate result by `SwipeDistanceCalculator`
`protected int`	`mCurDisplayDistanceY` distance to display for subclass to show UI these value is the calculate result by `SwipeDistanceCalculator`
`protected int`	`mCurSwipeDistanceX` distance by current swipe
`protected int`	`mCurSwipeDistanceY` distance by current swipe
`protected int`	`mDirection` current swipe direction
`protected boolean`	`mDisableSwipeOnSettling`
`protected int`	`mEdgeSize` The edge pixel size for SwipeConsumer to consume touch event
`protected int`	`mEnableNested` by default: enable nested scroll and nested fly for all direction
`protected int`	`mHeight` the wrapper height, it`s value assigned via `onMeasure(int, int)`
`protected android.view.animation.Interpolator`	`mInterpolator` The interpolator when touch released, it would be used by `SwipeHelper.setInterpolator(Context, Interpolator)`
`protected java.util.List<SwipeListener>`	`mListeners`
`protected java.lang.Integer`	`mMaxSettleDuration`
`protected int`	`mOpenDistance` to open this SwipeConsumer, distance should not less than this value
`protected boolean`	`mOpenDistanceSpecified`
`protected float`	`mOverSwipeFactor`
`protected float`	`mProgress`
`protected int`	`mReleaseMode`
`protected SwipeDistanceCalculator`	`mSwipeDistanceCalculator`
`protected SwipeHelper`	`mSwipeHelper`
`protected int`	`mSwipeMaxDistance`
`protected int`	`mSwipeOpenDistance`
`protected boolean`	`mSwiping`
`protected java.lang.Object`	`mTag`
`protected int`	`mWidth` the wrapper width, it`s value assigned via `onMeasure(int, int)`
`protected SmartSwipeWrapper`	`mWrapper` The wrapper which this SwipeConsumer attached to, it would not be null
`static float`	`PROGRESS_CLOSE`
`static float`	`PROGRESS_OPEN`
`static int`	`RELEASE_MODE_AUTO_CLOSE`
`static int`	`RELEASE_MODE_AUTO_OPEN`
`static int`	`RELEASE_MODE_AUTO_OPEN_CLOSE`
`static int`	`RELEASE_MODE_HOLE_OPEN`
`static int`	`RELEASE_MODE_NONE`

构造器概要

构造器
构造器和说明

SwipeConsumer()

构造器
构造器和说明
`SwipeConsumer()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`<T extends SwipeConsumer> T`	`addConsumer(T consumer)`
`SwipeConsumer`	`addListener(SwipeListener listener)` add a `SwipeListener` as an observer of swipe details
`SwipeConsumer`	`addToExclusiveGroup(SwipeConsumerExclusiveGroup group)`
`<T extends SwipeConsumer> T`	`as(java.lang.Class<T> clazz)`
`int`	`calSwipeDirection(int pointerId, float downX, float downY, float dx, float dy)`
`protected boolean`	`canChildScroll(android.view.ViewGroup parentView, int direction, int pointerId, float downX, float downY, float dx, float dy)`
`int`	`clampDistanceHorizontal(int distanceX, int dx)`
`int`	`clampDistanceVertical(int distanceY, int dy)`
`SwipeConsumer`	`close()`
`SwipeConsumer`	`close(boolean smooth)`
`SwipeConsumer`	`disableAllDirections()`
`SwipeConsumer`	`disableBottom()`
`SwipeConsumer`	`disableDirection(int direction)`
`SwipeConsumer`	`disableHorizontal()`
`SwipeConsumer`	`disableLeft()`
`SwipeConsumer`	`disableRight()`
`SwipeConsumer`	`disableTop()`
`SwipeConsumer`	`disableVertical()`
`void`	`dispatchDraw(android.graphics.Canvas canvas)` Called when Wrapper#dispatchDraw(Canvas) called
`SwipeConsumer`	`enableAllDirections()`
`SwipeConsumer`	`enableBottom()`
`SwipeConsumer`	`enableDirection(int direction)`
`SwipeConsumer`	`enableDirection(int direction, boolean enable)`
`SwipeConsumer`	`enableHorizontal()`
`SwipeConsumer`	`enableLeft()`
`SwipeConsumer`	`enableNestedFlyAllDirections(boolean enable)`
`SwipeConsumer`	`enableNestedFlyBottom(boolean enable)`
`SwipeConsumer`	`enableNestedFlyHorizontal(boolean enable)`
`SwipeConsumer`	`enableNestedFlyLeft(boolean enable)`
`SwipeConsumer`	`enableNestedFlyRight(boolean enable)`
`SwipeConsumer`	`enableNestedFlyTop(boolean enable)`
`SwipeConsumer`	`enableNestedFlyVertical(boolean enable)`
`SwipeConsumer`	`enableNestedScrollAllDirections(boolean enable)`
`SwipeConsumer`	`enableNestedScrollBottom(boolean enable)`
`SwipeConsumer`	`enableNestedScrollHorizontal(boolean enable)`
`SwipeConsumer`	`enableNestedScrollLeft(boolean enable)`
`SwipeConsumer`	`enableNestedScrollRight(boolean enable)`
`SwipeConsumer`	`enableNestedScrollTop(boolean enable)`
`SwipeConsumer`	`enableNestedScrollVertical(boolean enable)`
`SwipeConsumer`	`enableRight()`
`SwipeConsumer`	`enableTop()`
`SwipeConsumer`	`enableVertical()`
`android.view.View`	`findTopChildUnder(android.view.ViewGroup parentView, int x, int y)` Find the topmost child under the given point within the parent view's coordinate system.
`int`	`getDirection()`
`int`	`getDragState()`
`int`	`getEdgeSize()`
`int`	`getHeight()`
`int`	`getHorizontalRange(float dx, float dy)`
`android.view.animation.Interpolator`	`getInterpolator()`
`java.lang.Integer`	`getMaxSettleDuration()`
`int`	`getOpenDistance()`
`float`	`getOverSwipeFactor()`
`float`	`getProgress()`
`int`	`getReleaseMode()`
`float`	`getSensitivity()`
`SwipeDistanceCalculator`	`getSwipeDistanceCalculator()`
`SwipeHelper`	`getSwipeHelper()`
`int`	`getSwipeOpenDistance()`
`java.lang.Object`	`getTag()` Get the binding extension object
`int`	`getVerticalRange(float dx, float dy)`
`int`	`getWidth()`
`SmartSwipeWrapper`	`getWrapper()`
`protected void`	`initChildrenFormXml()` init children via xml usage of `SmartSwipeWrapper`
`boolean`	`isAllDirectionsEnable()`
`boolean`	`isAllDirectionsLocked()`
`boolean`	`isBottomEnable()`
`boolean`	`isBottomLocked()`
`boolean`	`isClosed()`
`boolean`	`isDirectionEnable(int direction)`
`boolean`	`isDirectionLocked(int direction)`
`boolean`	`isDisableSwipeOnSetting()`
`boolean`	`isHorizontalDirection()`
`boolean`	`isHorizontalEnable()`
`boolean`	`isHorizontalLocked()`
`boolean`	`isLeftEnable()`
`boolean`	`isLeftLocked()`
`protected boolean`	`isNestedAndDisabled(int pointerId, int direction)`
`boolean`	`isNestedFlyEnable(int direction)`
`boolean`	`isNestedScrollEnable(int direction)`
`boolean`	`isOpened()`
`boolean`	`isRightEnable()`
`boolean`	`isRightLocked()`
`boolean`	`isSwiping()`
`boolean`	`isTopEnable()`
`boolean`	`isTopLocked()`
`boolean`	`isVerticalDirection()`
`boolean`	`isVerticalEnable()`
`boolean`	`isVerticalLocked()`
`boolean`	`isViewUnder(android.view.View view, int x, int y)` Determine if the supplied view is under the given point in the parent view's coordinate system.
`SwipeConsumer`	`lockAllDirections()`
`SwipeConsumer`	`lockBottom()`
`SwipeConsumer`	`lockDirection(int direction)`
`SwipeConsumer`	`lockDirection(int direction, boolean lock)`
`SwipeConsumer`	`lockHorizontal()`
`SwipeConsumer`	`lockLeft()`
`SwipeConsumer`	`lockRight()`
`SwipeConsumer`	`lockTop()`
`SwipeConsumer`	`lockVertical()`
`protected void`	`notifyAttachToWrapper()`
`protected void`	`notifyDetachFromWrapper()`
`protected void`	`notifySwipeClosed()`
`protected void`	`notifySwipeOpened()`
`protected void`	`notifySwipeProgress(boolean settling)`
`protected void`	`notifySwipeRelease(float xVelocity, float yVelocity)`
`protected void`	`notifySwipeStart()`
`protected void`	`notifySwipeStateChanged(int state)`
`void`	`onAttachToWrapper(SmartSwipeWrapper wrapper, SwipeHelper swipeHelper)` Called when SwipeConsumer add to Wrapper
`protected void`	`onClosed()`
`void`	`onDetachFromWrapper()` Called when removed from Wrapper
`protected abstract void`	`onDisplayDistanceChanged(int distanceXToDisplay, int distanceYToDisplay, int dx, int dy)` Called to refresh UI when swipe distance is changed. final value has clamped and modified by Resistor(if it not null)
`void`	`onDraw(android.graphics.Canvas canvas)` Called when Wrapper#onDraw(Canvas) called
`boolean`	`onLayout(boolean changed, int left, int top, int right, int bottom)` Called when Wrapper#onLayout(boolean, int, int, int, int) called
`void`	`onMeasure(int widthMeasureSpec, int heightMeasureSpec)` Called when Wrapper#onMeasure(int, int) called
`protected void`	`onOpened()`
`void`	`onStateChanged(int state)`
`void`	`onSwipeAccepted(int activePointerId, boolean settling, float initialMotionX, float initialMotionY)`
`void`	`onSwipeDistanceChanged(int clampedDistanceX, int clampedDistanceY, int dx, int dy)` The core function to change layouts
`void`	`onSwipeReleased(float xVelocity, float yVelocity)`
`SwipeConsumer`	`open(boolean smooth, int direction)`
`SwipeConsumer`	`removeAllListeners()` remove all `SwipeListener` added via `addListener(SwipeListener)`
`SwipeConsumer`	`removeListener(SwipeListener listener)`
`protected void`	`reset()`
`SwipeConsumer`	`setBottomOpen()`
`void`	`setCurrentStateAsClosed()`
`SwipeConsumer`	`setDisableSwipeOnSettling(boolean disable)` disable to handle swipe event via user touch when automatically swipe is processing
`SwipeConsumer`	`setEdgeSize(int edgeSize)`
`SwipeConsumer`	`setHeight(int height)` set height to the ui, it works before SmartSwipeWrapper.onMeasure(int, int) invoked.
`SwipeConsumer`	`setInterpolator(android.view.animation.Interpolator interpolator)`
`SwipeConsumer`	`setLeftOpen()`
`SwipeConsumer`	`setMaxSettleDuration(int maxSettleDuration)`
`SwipeConsumer`	`setOpenDistance(int openDistance)`
`SwipeConsumer`	`setOverSwipeFactor(float overSwipeFactor)` set over swipe factor.
`SwipeConsumer`	`setReleaseMode(int releaseMode)` set the mode when released (default value: `RELEASE_MODE_AUTO_CLOSE`)
`SwipeConsumer`	`setRightOpen()`
`SwipeConsumer`	`setSensitivity(float sensitivity)` set the sensitivity of swipe touch event. it should be positive.
`SwipeConsumer`	`setSwipeDistanceCalculator(SwipeDistanceCalculator calculator)` set a calculator of swipe distance.
`SwipeConsumer`	`setTag(java.lang.Object tag)` Bind an extension object if necessary
`SwipeConsumer`	`setTopOpen()`
`SwipeConsumer`	`setWidth(int width)` set width to the ui, it works before SmartSwipeWrapper.onMeasure(int, int) invoked.
`SwipeConsumer`	`slideTo(boolean smooth, float progress)`
`SwipeConsumer`	`smoothBottomOpen()`
`SwipeConsumer`	`smoothClose()`
`SwipeConsumer`	`smoothLeftOpen()`
`protected void`	`smoothOpenOrClose(float xVelocity, float yVelocity)`
`SwipeConsumer`	`smoothRightOpen()`
`SwipeConsumer`	`smoothSlideTo(float progress)`
`void`	`smoothSlideTo(int finalX, int finalY)`
`void`	`smoothSlideTo(int startX, int startY, int finalX, int finalY)`
`SwipeConsumer`	`smoothTopOpen()`
`boolean`	`tryAcceptMoving(int pointerId, float downX, float downY, float dx, float dy)`
`boolean`	`tryAcceptSettling(int pointerId, float downX, float downY)` always swipe by default when settling
`SwipeConsumer`	`unlockAllDirections()`
`SwipeConsumer`	`unlockBottom()`
`SwipeConsumer`	`unlockDirection(int direction)`
`SwipeConsumer`	`unlockHorizontal()`
`SwipeConsumer`	`unlockLeft()`
`SwipeConsumer`	`unlockRight()`
`SwipeConsumer`	`unlockTop()`
`SwipeConsumer`	`unlockVertical()`

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

字段详细资料
- DEFAULT_OPEN_DISTANCE_IN_DP
```
public static int DEFAULT_OPEN_DISTANCE_IN_DP
```
- DIRECTION_NONE
```
public static final int DIRECTION_NONE
```
  另请参阅:
  
  常量字段值
- DIRECTION_LEFT
```
public static final int DIRECTION_LEFT
```
  另请参阅:
  
  常量字段值
- DIRECTION_RIGHT
```
public static final int DIRECTION_RIGHT
```
  另请参阅:
  
  常量字段值
- DIRECTION_TOP
```
public static final int DIRECTION_TOP
```
  另请参阅:
  
  常量字段值
- DIRECTION_BOTTOM
```
public static final int DIRECTION_BOTTOM
```
  另请参阅:
  
  常量字段值
- DIRECTION_HORIZONTAL
```
public static final int DIRECTION_HORIZONTAL
```
  另请参阅:
  
  常量字段值
- DIRECTION_VERTICAL
```
public static final int DIRECTION_VERTICAL
```
  另请参阅:
  
  常量字段值
- DIRECTION_ALL
```
public static final int DIRECTION_ALL
```
  另请参阅:
  
  常量字段值
- RELEASE_MODE_NONE
```
public static final int RELEASE_MODE_NONE
```
  另请参阅:
  
  常量字段值
- RELEASE_MODE_AUTO_CLOSE
```
public static final int RELEASE_MODE_AUTO_CLOSE
```
  另请参阅:
  
  常量字段值
- RELEASE_MODE_AUTO_OPEN
```
public static final int RELEASE_MODE_AUTO_OPEN
```
  另请参阅:
  
  常量字段值
- RELEASE_MODE_AUTO_OPEN_CLOSE
```
public static final int RELEASE_MODE_AUTO_OPEN_CLOSE
```
  另请参阅:
  
  常量字段值
- RELEASE_MODE_HOLE_OPEN
```
public static final int RELEASE_MODE_HOLE_OPEN
```
  另请参阅:
  
  常量字段值
- mWrapper
```
protected SmartSwipeWrapper mWrapper
```
  The wrapper which this SwipeConsumer attached to, it would not be null
- PROGRESS_CLOSE
```
public static final float PROGRESS_CLOSE
```
  另请参阅:
  
  常量字段值
- PROGRESS_OPEN
```
public static final float PROGRESS_OPEN
```
  另请参阅:
  
  常量字段值
- mDirection
```
protected int mDirection
```
  current swipe direction
- mCachedSwipeDistanceX
```
protected int mCachedSwipeDistanceX
```
  cached distance by last swipe
- mCachedSwipeDistanceY
```
protected int mCachedSwipeDistanceY
```
  cached distance by last swipe
- mCurSwipeDistanceX
```
protected int mCurSwipeDistanceX
```
  distance by current swipe
- mCurSwipeDistanceY
```
protected int mCurSwipeDistanceY
```
  distance by current swipe
- mSwipeOpenDistance
```
protected int mSwipeOpenDistance
```
- mOpenDistanceSpecified
```
protected boolean mOpenDistanceSpecified
```
- mSwipeMaxDistance
```
protected int mSwipeMaxDistance
```
- mCurDisplayDistanceX
```
protected int mCurDisplayDistanceX
```
  distance to display for subclass to show UI these value is the calculate result by SwipeDistanceCalculator
  
  另请参阅:
  
  SwipeDistanceCalculator
- mCurDisplayDistanceY
```
protected int mCurDisplayDistanceY
```
  distance to display for subclass to show UI these value is the calculate result by SwipeDistanceCalculator
  
  另请参阅:
  
  SwipeDistanceCalculator
- mProgress
```
protected float mProgress
```
- mSwiping
```
protected volatile boolean mSwiping
```
- mSwipeHelper
```
protected SwipeHelper mSwipeHelper
```
- mInterpolator
```
protected android.view.animation.Interpolator mInterpolator
```
  The interpolator when touch released, it would be used by SwipeHelper.setInterpolator(Context, Interpolator)
- mEdgeSize
```
protected int mEdgeSize
```
  The edge pixel size for SwipeConsumer to consume touch event
  
  另请参阅:
  
  tryAcceptMoving(int, float, float, float, float)
- mReleaseMode
```
protected int mReleaseMode
```
- mListeners
```
protected final java.util.List<SwipeListener> mListeners
```
- mOpenDistance
```
protected int mOpenDistance
```
  to open this SwipeConsumer, distance should not less than this value
- mOverSwipeFactor
```
protected float mOverSwipeFactor
```
- mSwipeDistanceCalculator
```
protected SwipeDistanceCalculator mSwipeDistanceCalculator
```
- mDisableSwipeOnSettling
```
protected boolean mDisableSwipeOnSettling
```
- mTag
```
protected java.lang.Object mTag
```
- mMaxSettleDuration
```
protected java.lang.Integer mMaxSettleDuration
```
- mEnableNested
```
protected int mEnableNested
```
  by default: enable nested scroll and nested fly for all direction
- mWidth
```
protected int mWidth
```
  the wrapper width, it`s value assigned via onMeasure(int, int)
- mHeight
```
protected int mHeight
```
  the wrapper height, it`s value assigned via onMeasure(int, int)

构造器详细资料
- SwipeConsumer
```
public SwipeConsumer()
```

方法详细资料

tryAcceptSettling
```
public boolean tryAcceptSettling(int pointerId,
                                 float downX,
                                 float downY)
```
always swipe by default when settling

参数:

pointerId - pointer id

downX - motion event x for pointerId

downY - motion event y for pointerId

返回:

swipe or not

tryAcceptMoving

public boolean tryAcceptMoving(int pointerId,
                               float downX,
                               float downY,
                               float dx,
                               float dy)

calSwipeDirection

public int calSwipeDirection(int pointerId,
                             float downX,
                             float downY,
                             float dx,
                             float dy)

isNestedAndDisabled

protected boolean isNestedAndDisabled(int pointerId,
                                      int direction)

canChildScroll

protected boolean canChildScroll(android.view.ViewGroup parentView,
                                 int direction,
                                 int pointerId,
                                 float downX,
                                 float downY,
                                 float dx,
                                 float dy)

onSwipeAccepted

public void onSwipeAccepted(int activePointerId,
                            boolean settling,
                            float initialMotionX,
                            float initialMotionY)

onSwipeReleased

public void onSwipeReleased(float xVelocity,
                            float yVelocity)

smoothOpenOrClose

protected void smoothOpenOrClose(float xVelocity,
                                 float yVelocity)

setCurrentStateAsClosed
```
public void setCurrentStateAsClosed()
```

notifySwipeOpened
```
protected void notifySwipeOpened()
```

notifySwipeClosed
```
protected void notifySwipeClosed()
```

notifyAttachToWrapper

protected void notifyAttachToWrapper()

notifyDetachFromWrapper

protected void notifyDetachFromWrapper()

notifySwipeStateChanged

protected void notifySwipeStateChanged(int state)

notifySwipeStart
```
protected void notifySwipeStart()
```

notifySwipeRelease

protected void notifySwipeRelease(float xVelocity,
                                  float yVelocity)

notifySwipeProgress

protected void notifySwipeProgress(boolean settling)

getHorizontalRange

public int getHorizontalRange(float dx,
                              float dy)

getVerticalRange

public int getVerticalRange(float dx,
                            float dy)

clampDistanceHorizontal

public int clampDistanceHorizontal(int distanceX,
                                   int dx)

clampDistanceVertical

public int clampDistanceVertical(int distanceY,
                                 int dy)

onSwipeDistanceChanged
```
public void onSwipeDistanceChanged(int clampedDistanceX,
                                   int clampedDistanceY,
                                   int dx,
                                   int dy)
```
The core function to change layouts

参数:

clampedDistanceX - swipe horizontal distance clamped via clampDistanceHorizontal(int, int)

clampedDistanceY - swipe vertical distance clamped via clampDistanceVertical(int, int)

dx - delta x distance from last call

dy - delta y distance from last call

另请参阅:

clampDistanceHorizontal(int, int), clampDistanceVertical(int, int)

onDisplayDistanceChanged
```
protected abstract void onDisplayDistanceChanged(int distanceXToDisplay,
                                                 int distanceYToDisplay,
                                                 int dx,
                                                 int dy)
```
Called to refresh UI when swipe distance is changed. final value has clamped and modified by Resistor(if it not null)

参数:

distanceXToDisplay - distance changed in pixels along the X axis to show UI

distanceYToDisplay - distance changed in pixels along the Y axis to show UI

dx - Change in X position from the last call

dy - Change in Y position from the last call

另请参阅:

SwipeDistanceCalculator

onAttachToWrapper

public void onAttachToWrapper(SmartSwipeWrapper wrapper,
                              SwipeHelper swipeHelper)

Called when SwipeConsumer add to Wrapper

参数:: wrapper - Wrapper to add to; swipeHelper - SwipeHelper bind to this SwipeConsumer

initChildrenFormXml
```
protected void initChildrenFormXml()
```
init children via xml usage of SmartSwipeWrapper

另请参阅:

DrawerConsumer, SlidingConsumer

onDetachFromWrapper
```
public void onDetachFromWrapper()
```
Called when removed from Wrapper

dispatchDraw
```
public void dispatchDraw(android.graphics.Canvas canvas)
```
Called when Wrapper#dispatchDraw(Canvas) called

参数:

canvas - canvas

onDraw
```
public void onDraw(android.graphics.Canvas canvas)
```
Called when Wrapper#onDraw(Canvas) called

参数:

canvas - canvas

onMeasure
```
public void onMeasure(int widthMeasureSpec,
                      int heightMeasureSpec)
```
Called when Wrapper#onMeasure(int, int) called

参数:

widthMeasureSpec - widthMeasureSpec

heightMeasureSpec - heightMeasureSpec

onLayout
```
public boolean onLayout(boolean changed,
                        int left,
                        int top,
                        int right,
                        int bottom)
```
Called when Wrapper#onLayout(boolean, int, int, int, int) called

参数:

changed - changed or not

left - left position

top - top position

right - right position

bottom - bottom position

返回:

true: Wrapper will not call super.onLayout(...), false: Wrapper will call super.onLayout(...) to layout children

isViewUnder
```
public boolean isViewUnder(android.view.View view,
                           int x,
                           int y)
```
Determine if the supplied view is under the given point in the parent view's coordinate system.

参数:

view - Child view of the parent to hit test

x - X position to test in the parent's coordinate system

y - Y position to test in the parent's coordinate system

返回:

true if the supplied view is under the given point, false otherwise

findTopChildUnder
```
public android.view.View findTopChildUnder(android.view.ViewGroup parentView,
                                           int x,
                                           int y)
```
Find the topmost child under the given point within the parent view's coordinate system.

参数:

parentView - the parent view

x - X position to test in the parent's coordinate system

y - Y position to test in the parent's coordinate system

返回:

The topmost child view under (x, y) or null if none found.

onStateChanged

public void onStateChanged(int state)

onOpened
```
protected void onOpened()
```

onClosed
```
protected void onClosed()
```

reset
```
protected void reset()
```

getInterpolator

public android.view.animation.Interpolator getInterpolator()

setInterpolator

public SwipeConsumer setInterpolator(android.view.animation.Interpolator interpolator)

getSensitivity
```
public float getSensitivity()
```

setSensitivity
```
public SwipeConsumer setSensitivity(float sensitivity)
```
set the sensitivity of swipe touch event. it should be positive. touchSlope /= sensitivity

参数:

sensitivity - more bigger more sensitivity

返回:

this

getReleaseMode
```
public int getReleaseMode()
```

setReleaseMode
```
public SwipeConsumer setReleaseMode(int releaseMode)
```
set the mode when released (default value: RELEASE_MODE_AUTO_CLOSE)

参数:

releaseMode - RELEASE_MODE_NONE / RELEASE_MODE_AUTO_CLOSE / RELEASE_MODE_AUTO_OPEN / RELEASE_MODE_AUTO_OPEN_CLOSE / RELEASE_MODE_HOLE_OPEN

返回:

this

getEdgeSize
```
public int getEdgeSize()
```

setEdgeSize

public SwipeConsumer setEdgeSize(int edgeSize)

getWrapper
```
public SmartSwipeWrapper getWrapper()
```

getSwipeHelper
```
public SwipeHelper getSwipeHelper()
```

getDragState
```
public int getDragState()
```

getProgress
```
public float getProgress()
```

isSwiping
```
public boolean isSwiping()
```

getSwipeOpenDistance
```
public int getSwipeOpenDistance()
```

getOpenDistance
```
public int getOpenDistance()
```

setOpenDistance

public SwipeConsumer setOpenDistance(int openDistance)

removeAllListeners
```
public SwipeConsumer removeAllListeners()
```
remove all SwipeListener added via addListener(SwipeListener)

返回:

this

另请参阅:

addListener(SwipeListener)

removeListener

public SwipeConsumer removeListener(SwipeListener listener)

addListener
```
public SwipeConsumer addListener(SwipeListener listener)
```
add a SwipeListener as an observer of swipe details

参数:

listener - will be called when swipe event happens

返回:

this

另请参阅:

SwipeListener, SimpleSwipeListener

setSwipeDistanceCalculator
```
public SwipeConsumer setSwipeDistanceCalculator(SwipeDistanceCalculator calculator)
```
set a calculator of swipe distance. by default: swipe distance is the same as drag distance, calculator can change this role

参数:

calculator - calculator

返回:

this

另请参阅:

SwipeDistanceCalculator, ScaledCalculator

getSwipeDistanceCalculator

public SwipeDistanceCalculator getSwipeDistanceCalculator()

isDisableSwipeOnSetting

public boolean isDisableSwipeOnSetting()

setDisableSwipeOnSettling
```
public SwipeConsumer setDisableSwipeOnSettling(boolean disable)
```
disable to handle swipe event via user touch when automatically swipe is processing

参数:

disable - disable or not

返回:

this

getOverSwipeFactor
```
public float getOverSwipeFactor()
```

setOverSwipeFactor
```
public SwipeConsumer setOverSwipeFactor(float overSwipeFactor)
```
set over swipe factor. max swipe distance = getSwipeOpenDistance() * (1 + overSwipeFactor)

参数:

overSwipeFactor - over swipe factor

返回:

this

getTag
```
public java.lang.Object getTag()
```
Get the binding extension object

返回:

extension object

setTag
```
public SwipeConsumer setTag(java.lang.Object tag)
```
Bind an extension object if necessary

参数:

tag - The extension object

返回:

this

getMaxSettleDuration

public java.lang.Integer getMaxSettleDuration()

setMaxSettleDuration

public SwipeConsumer setMaxSettleDuration(int maxSettleDuration)

getWidth
```
public int getWidth()
```

setWidth
```
public SwipeConsumer setWidth(int width)
```
set width to the ui, it works before SmartSwipeWrapper.onMeasure(int, int) invoked. this value will be reset by onMeasure(int, int)

参数:

width - the width of SmartSwipeWrapper

返回:

this

getHeight
```
public int getHeight()
```

setHeight
```
public SwipeConsumer setHeight(int height)
```
set height to the ui, it works before SmartSwipeWrapper.onMeasure(int, int) invoked. this value will be reset by onMeasure(int, int)

参数:

height - the height of SmartSwipeWrapper

返回:

this

setLeftOpen
```
public SwipeConsumer setLeftOpen()
```

setRightOpen
```
public SwipeConsumer setRightOpen()
```

setTopOpen
```
public SwipeConsumer setTopOpen()
```

setBottomOpen
```
public SwipeConsumer setBottomOpen()
```

smoothLeftOpen
```
public SwipeConsumer smoothLeftOpen()
```

smoothRightOpen

public SwipeConsumer smoothRightOpen()

smoothTopOpen
```
public SwipeConsumer smoothTopOpen()
```

smoothBottomOpen

public SwipeConsumer smoothBottomOpen()

open

public SwipeConsumer open(boolean smooth,
                          int direction)

close
```
public SwipeConsumer close()
```

smoothClose
```
public SwipeConsumer smoothClose()
```

close

public SwipeConsumer close(boolean smooth)

smoothSlideTo

public SwipeConsumer smoothSlideTo(float progress)

slideTo

public SwipeConsumer slideTo(boolean smooth,
                             float progress)

addToExclusiveGroup

public SwipeConsumer addToExclusiveGroup(SwipeConsumerExclusiveGroup group)

getDirection
```
public int getDirection()
```

enableDirection

public SwipeConsumer enableDirection(int direction,
                                     boolean enable)

enableLeft
```
public SwipeConsumer enableLeft()
```

enableRight
```
public SwipeConsumer enableRight()
```

enableTop
```
public SwipeConsumer enableTop()
```

enableBottom
```
public SwipeConsumer enableBottom()
```

enableHorizontal

public SwipeConsumer enableHorizontal()

enableVertical
```
public SwipeConsumer enableVertical()
```

enableAllDirections

public SwipeConsumer enableAllDirections()

disableLeft
```
public SwipeConsumer disableLeft()
```

disableRight
```
public SwipeConsumer disableRight()
```

disableTop
```
public SwipeConsumer disableTop()
```

disableBottom
```
public SwipeConsumer disableBottom()
```

disableHorizontal

public SwipeConsumer disableHorizontal()

disableVertical

public SwipeConsumer disableVertical()

disableAllDirections

public SwipeConsumer disableAllDirections()

enableDirection

public SwipeConsumer enableDirection(int direction)

disableDirection

public SwipeConsumer disableDirection(int direction)

isDirectionEnable

public boolean isDirectionEnable(int direction)

isAllDirectionsEnable

public boolean isAllDirectionsEnable()

isVerticalEnable
```
public boolean isVerticalEnable()
```

isHorizontalEnable
```
public boolean isHorizontalEnable()
```

isLeftEnable
```
public boolean isLeftEnable()
```

isRightEnable
```
public boolean isRightEnable()
```

isTopEnable
```
public boolean isTopEnable()
```

isBottomEnable
```
public boolean isBottomEnable()
```

lockDirection

public SwipeConsumer lockDirection(int direction,
                                   boolean lock)

lockLeft
```
public SwipeConsumer lockLeft()
```

lockRight
```
public SwipeConsumer lockRight()
```

lockTop
```
public SwipeConsumer lockTop()
```

lockBottom
```
public SwipeConsumer lockBottom()
```

lockHorizontal
```
public SwipeConsumer lockHorizontal()
```

lockVertical
```
public SwipeConsumer lockVertical()
```

lockAllDirections

public SwipeConsumer lockAllDirections()

unlockLeft
```
public SwipeConsumer unlockLeft()
```

unlockRight
```
public SwipeConsumer unlockRight()
```

unlockTop
```
public SwipeConsumer unlockTop()
```

unlockBottom
```
public SwipeConsumer unlockBottom()
```

unlockHorizontal

public SwipeConsumer unlockHorizontal()

unlockVertical
```
public SwipeConsumer unlockVertical()
```

unlockAllDirections

public SwipeConsumer unlockAllDirections()

lockDirection

public SwipeConsumer lockDirection(int direction)

unlockDirection

public SwipeConsumer unlockDirection(int direction)

isDirectionLocked

public boolean isDirectionLocked(int direction)

isAllDirectionsLocked

public boolean isAllDirectionsLocked()

isVerticalLocked
```
public boolean isVerticalLocked()
```

isHorizontalLocked
```
public boolean isHorizontalLocked()
```

isLeftLocked
```
public boolean isLeftLocked()
```

isRightLocked
```
public boolean isRightLocked()
```

isTopLocked
```
public boolean isTopLocked()
```

isBottomLocked
```
public boolean isBottomLocked()
```

enableNestedScrollLeft

public SwipeConsumer enableNestedScrollLeft(boolean enable)

enableNestedScrollRight

public SwipeConsumer enableNestedScrollRight(boolean enable)

enableNestedScrollTop

public SwipeConsumer enableNestedScrollTop(boolean enable)

enableNestedScrollBottom

public SwipeConsumer enableNestedScrollBottom(boolean enable)

enableNestedScrollHorizontal

public SwipeConsumer enableNestedScrollHorizontal(boolean enable)

enableNestedScrollVertical

public SwipeConsumer enableNestedScrollVertical(boolean enable)

enableNestedScrollAllDirections

public SwipeConsumer enableNestedScrollAllDirections(boolean enable)

isNestedScrollEnable

public boolean isNestedScrollEnable(int direction)

enableNestedFlyLeft

public SwipeConsumer enableNestedFlyLeft(boolean enable)

enableNestedFlyRight

public SwipeConsumer enableNestedFlyRight(boolean enable)

enableNestedFlyTop

public SwipeConsumer enableNestedFlyTop(boolean enable)

enableNestedFlyBottom

public SwipeConsumer enableNestedFlyBottom(boolean enable)

enableNestedFlyHorizontal

public SwipeConsumer enableNestedFlyHorizontal(boolean enable)

enableNestedFlyVertical

public SwipeConsumer enableNestedFlyVertical(boolean enable)

enableNestedFlyAllDirections

public SwipeConsumer enableNestedFlyAllDirections(boolean enable)

isNestedFlyEnable

public boolean isNestedFlyEnable(int direction)

isVerticalDirection
```
public boolean isVerticalDirection()
```

isHorizontalDirection

public boolean isHorizontalDirection()

smoothSlideTo

public void smoothSlideTo(int startX,
                          int startY,
                          int finalX,
                          int finalY)

smoothSlideTo

public void smoothSlideTo(int finalX,
                          int finalY)

isOpened
```
public boolean isOpened()
```

isClosed
```
public boolean isClosed()
```

as

public <T extends SwipeConsumer> T as(java.lang.Class<T> clazz)

addConsumer

public <T extends SwipeConsumer> T addConsumer(T consumer)

类 SwipeConsumer

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_OPEN_DISTANCE_IN_DP

DIRECTION_NONE

DIRECTION_LEFT

DIRECTION_RIGHT

DIRECTION_TOP

DIRECTION_BOTTOM

DIRECTION_HORIZONTAL

DIRECTION_VERTICAL

DIRECTION_ALL

RELEASE_MODE_NONE

RELEASE_MODE_AUTO_CLOSE

RELEASE_MODE_AUTO_OPEN

RELEASE_MODE_AUTO_OPEN_CLOSE

RELEASE_MODE_HOLE_OPEN

mWrapper

PROGRESS_CLOSE

PROGRESS_OPEN

mDirection

mCachedSwipeDistanceX

mCachedSwipeDistanceY

mCurSwipeDistanceX

mCurSwipeDistanceY

mSwipeOpenDistance

mOpenDistanceSpecified

mSwipeMaxDistance

mCurDisplayDistanceX

mCurDisplayDistanceY

mProgress

mSwiping

mSwipeHelper

mInterpolator

mEdgeSize

mReleaseMode

mListeners

mOpenDistance

mOverSwipeFactor

mSwipeDistanceCalculator

mDisableSwipeOnSettling

mTag

mMaxSettleDuration

mEnableNested

mWidth

mHeight

构造器详细资料

SwipeConsumer

方法详细资料

tryAcceptSettling

tryAcceptMoving

calSwipeDirection

isNestedAndDisabled

canChildScroll

onSwipeAccepted

onSwipeReleased

smoothOpenOrClose

setCurrentStateAsClosed

notifySwipeOpened

notifySwipeClosed

notifyAttachToWrapper

notifyDetachFromWrapper

notifySwipeStateChanged

notifySwipeStart

notifySwipeRelease

notifySwipeProgress

getHorizontalRange

getVerticalRange

clampDistanceHorizontal

clampDistanceVertical

onSwipeDistanceChanged

onDisplayDistanceChanged

onAttachToWrapper

initChildrenFormXml

onDetachFromWrapper

dispatchDraw

onDraw