DrawerConsumer (smart-swipe API)

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

所有已实现的接口:

android.view.View.OnClickListener

直接已知子类:

SlidingConsumer
```
public class DrawerConsumer
extends SwipeConsumer
implements android.view.View.OnClickListener
```
contains content view and at most 4 drawer view drawer view shows above content view default release mode is SwipeConsumer.RELEASE_MODE_AUTO_OPEN_CLOSE

字段概要

字段
限定符和类型	字段和说明
`protected int`	`b`
`protected int`	`l`
`protected android.view.View`	`mCurDrawerView`
`protected boolean`	`mDrawerViewRequired`
`protected android.view.View[]`	`mDrawerViews`
`protected int`	`mScrimColor`
`protected ScrimView`	`mScrimView`
`protected int`	`mShadowColor`
`protected int`	`mShadowSize`
`protected boolean`	`mShowScrimAndShadowOutsideContentView`
`protected int`	`r`
`protected int`	`t`

构造器概要

构造器
构造器和说明

DrawerConsumer()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`calculateDrawerDirectionInitPosition(int direction, int w, int h)`
`protected boolean`	`canChildScroll(android.view.ViewGroup parentView, int direction, int pointerId, float downX, float downY, float dx, float dy)`
`protected void`	`changeDrawerViewVisibility(int visibility)`
`android.view.View`	`getDrawerView(int direction)`
`int`	`getOpenDistance()`
`int`	`getShadowSize()`
`protected void`	`initChildrenFormXml()` init children via xml usage of `SmartSwipeWrapper`
`protected void`	`initScrimView()`
`boolean`	`isDrawerViewRequired()`
`boolean`	`isScrimAndShadowOutsideContentView()`
`protected void`	`layoutChildren()`
`protected void`	`layoutContentView(android.view.View contentView)`
`protected void`	`layoutDrawerView()`
`protected void`	`layoutScrimView()`
`protected void`	`notifySwipeProgress(boolean settling)`
`protected void`	`notifySwipeRelease(float xVelocity, float yVelocity)`
`protected void`	`notifySwipeStart()`
`void`	`onAttachToWrapper(SmartSwipeWrapper wrapper, SwipeHelper swipeHelper)` Called when SwipeConsumer add to Wrapper
`void`	`onClick(android.view.View v)`
`protected void`	`onClosed()`
`void`	`onDetachFromWrapper()` Called when removed from Wrapper
`protected 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)
`boolean`	`onLayout(boolean changed, int left, int top, int right, int bottom)` Called when Wrapper#onLayout(boolean, int, int, int, int) called
`protected void`	`onOpened()`
`void`	`onSwipeAccepted(int activePointerId, boolean settling, float initialMotionX, float initialMotionY)`
`protected void`	`orderChildren()`
`DrawerConsumer`	`setAllDirectionDrawerView(android.view.View drawerView)`
`DrawerConsumer`	`setBottomDrawerView(android.view.View drawerView)`
`void`	`setCurrentStateAsClosed()`
`DrawerConsumer`	`setDrawerView(int direction, android.view.View drawerView)` set a extension to the direction, also set direction enable if drawerView is not null(otherwise, disable the direction) direction can be a single direction or mixed direction(eg: DIRECTION_LEFT \| DIRECTION_RIGHT)
`DrawerConsumer`	`setDrawerViewRequired(boolean required)` set the extension view as drawer is required or not it useful inside this sdk framework, developers who use this SDK do not call this function unless you really know what its mean
`DrawerConsumer`	`setHorizontalDrawerView(android.view.View drawerView)`
`DrawerConsumer`	`setLeftDrawerView(android.view.View drawerView)`
`DrawerConsumer`	`setRightDrawerView(android.view.View drawerView)`
`DrawerConsumer`	`setScrimColor(int color)` Set a color to use for the scrim that obscures primary content while a drawer is open.
`DrawerConsumer`	`setShadowColor(int shadowColor)` Set a color to use for the shadow at the edge of content view while a drawer is open.
`DrawerConsumer`	`setShadowSize(int size)` set the size of shadow at the edge of content view while a drawer is open.
`DrawerConsumer`	`setTopDrawerView(android.view.View drawerView)`
`DrawerConsumer`	`setVerticalDrawerView(android.view.View drawerView)`
`DrawerConsumer`	`showScrimAndShadowInsideContentView()`
`DrawerConsumer`	`showScrimAndShadowOutsideContentView()`
`boolean`	`tryAcceptMoving(int pointerId, float downX, float downY, float dx, float dy)`

从类继承的方法 com.billy.android.swipe.SwipeConsumer
addConsumer, addListener, addToExclusiveGroup, as, calSwipeDirection, clampDistanceHorizontal, clampDistanceVertical, close, close, disableAllDirections, disableBottom, disableDirection, disableHorizontal, disableLeft, disableRight, disableTop, disableVertical, dispatchDraw, enableAllDirections, enableBottom, enableDirection, enableDirection, enableHorizontal, enableLeft, enableNestedFlyAllDirections, enableNestedFlyBottom, enableNestedFlyHorizontal, enableNestedFlyLeft, enableNestedFlyRight, enableNestedFlyTop, enableNestedFlyVertical, enableNestedScrollAllDirections, enableNestedScrollBottom, enableNestedScrollHorizontal, enableNestedScrollLeft, enableNestedScrollRight, enableNestedScrollTop, enableNestedScrollVertical, enableRight, enableTop, enableVertical, findTopChildUnder, getDirection, getDragState, getEdgeSize, getHeight, getHorizontalRange, getInterpolator, getMaxSettleDuration, getOverSwipeFactor, getProgress, getReleaseMode, getSensitivity, getSwipeDistanceCalculator, getSwipeHelper, getSwipeOpenDistance, getTag, getVerticalRange, getWidth, getWrapper, isAllDirectionsEnable, isAllDirectionsLocked, isBottomEnable, isBottomLocked, isClosed, isDirectionEnable, isDirectionLocked, isDisableSwipeOnSetting, isHorizontalDirection, isHorizontalEnable, isHorizontalLocked, isLeftEnable, isLeftLocked, isNestedAndDisabled, isNestedFlyEnable, isNestedScrollEnable, isOpened, isRightEnable, isRightLocked, isSwiping, isTopEnable, isTopLocked, isVerticalDirection, isVerticalEnable, isVerticalLocked, isViewUnder, lockAllDirections, lockBottom, lockDirection, lockDirection, lockHorizontal, lockLeft, lockRight, lockTop, lockVertical, notifyAttachToWrapper, notifyDetachFromWrapper, notifySwipeClosed, notifySwipeOpened, notifySwipeStateChanged, onDraw, onMeasure, onStateChanged, onSwipeDistanceChanged, onSwipeReleased, open, removeAllListeners, removeListener, reset, setBottomOpen, setDisableSwipeOnSettling, setEdgeSize, setHeight, setInterpolator, setLeftOpen, setMaxSettleDuration, setOpenDistance, setOverSwipeFactor, setReleaseMode, setRightOpen, setSensitivity, setSwipeDistanceCalculator, setTag, setTopOpen, setWidth, slideTo, smoothBottomOpen, smoothClose, smoothLeftOpen, smoothOpenOrClose, smoothRightOpen, smoothSlideTo, smoothSlideTo, smoothSlideTo, smoothTopOpen, tryAcceptSettling, unlockAllDirections, unlockBottom, unlockDirection, unlockHorizontal, unlockLeft, unlockRight, unlockTop, unlockVertical

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

字段详细资料

mDrawerViews

protected final android.view.View[] mDrawerViews

mCurDrawerView

protected android.view.View mCurDrawerView

l
```
protected int l
```

t
```
protected int t
```

r
```
protected int r
```

b
```
protected int b
```

mScrimColor
```
protected int mScrimColor
```

mShadowColor
```
protected int mShadowColor
```

mScrimView
```
protected ScrimView mScrimView
```

mShadowSize
```
protected int mShadowSize
```

mDrawerViewRequired
```
protected boolean mDrawerViewRequired
```

mShowScrimAndShadowOutsideContentView

protected boolean mShowScrimAndShadowOutsideContentView

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

方法详细资料
- onAttachToWrapper
```
public void onAttachToWrapper(SmartSwipeWrapper wrapper,
                              SwipeHelper swipeHelper)
```
  从类复制的说明: SwipeConsumer
  
  Called when SwipeConsumer add to Wrapper
  
  覆盖:
  
  onAttachToWrapper 在类中 SwipeConsumer
  
  参数:
  
  wrapper - Wrapper to add to
  
  swipeHelper - SwipeHelper bind to this SwipeConsumer
- initChildrenFormXml
```
protected void initChildrenFormXml()
```
  从类复制的说明: SwipeConsumer
  
  init children via xml usage of SmartSwipeWrapper
  
  覆盖:
  
  initChildrenFormXml 在类中 SwipeConsumer
  
  另请参阅:
  
  DrawerConsumer, SlidingConsumer
- onDetachFromWrapper
```
public void onDetachFromWrapper()
```
  从类复制的说明: SwipeConsumer
  
  Called when removed from Wrapper
  
  覆盖:
  
  onDetachFromWrapper 在类中 SwipeConsumer
- onOpened
```
protected void onOpened()
```
  覆盖:
  
  onOpened 在类中 SwipeConsumer
- onClosed
```
protected void onClosed()
```
  覆盖:
  
  onClosed 在类中 SwipeConsumer
- tryAcceptMoving
```
public boolean tryAcceptMoving(int pointerId,
                               float downX,
                               float downY,
                               float dx,
                               float dy)
```
  覆盖:
  
  tryAcceptMoving 在类中 SwipeConsumer
- onSwipeAccepted
```
public void onSwipeAccepted(int activePointerId,
                            boolean settling,
                            float initialMotionX,
                            float initialMotionY)
```
  覆盖:
  
  onSwipeAccepted 在类中 SwipeConsumer
- changeDrawerViewVisibility
```
protected void changeDrawerViewVisibility(int visibility)
```
- setCurrentStateAsClosed
```
public void setCurrentStateAsClosed()
```
  覆盖:
  
  setCurrentStateAsClosed 在类中 SwipeConsumer
- initScrimView
```
protected void initScrimView()
```
- calculateDrawerDirectionInitPosition
```
protected void calculateDrawerDirectionInitPosition(int direction,
                                                    int w,
                                                    int h)
```
- onLayout
```
public boolean onLayout(boolean changed,
                        int left,
                        int top,
                        int right,
                        int bottom)
```
  从类复制的说明: SwipeConsumer
  
  Called when Wrapper#onLayout(boolean, int, int, int, int) called
  
  覆盖:
  
  onLayout 在类中 SwipeConsumer
  
  参数:
  
  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
- onDisplayDistanceChanged
```
protected void onDisplayDistanceChanged(int distanceXToDisplay,
                                        int distanceYToDisplay,
                                        int dx,
                                        int dy)
```
  从类复制的说明: SwipeConsumer
  
  Called to refresh UI when swipe distance is changed. final value has clamped and modified by Resistor(if it not null)
  
  指定者:
  
  onDisplayDistanceChanged 在类中 SwipeConsumer
  
  参数:
  
  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
- orderChildren
```
protected void orderChildren()
```
- layoutChildren
```
protected void layoutChildren()
```
- layoutContentView
```
protected void layoutContentView(android.view.View contentView)
```
- layoutDrawerView
```
protected void layoutDrawerView()
```
- layoutScrimView
```
protected void layoutScrimView()
```
- notifySwipeStart
```
protected void notifySwipeStart()
```
  覆盖:
  
  notifySwipeStart 在类中 SwipeConsumer
- notifySwipeProgress
```
protected void notifySwipeProgress(boolean settling)
```
  覆盖:
  
  notifySwipeProgress 在类中 SwipeConsumer
- notifySwipeRelease
```
protected void notifySwipeRelease(float xVelocity,
                                  float yVelocity)
```
  覆盖:
  
  notifySwipeRelease 在类中 SwipeConsumer
- getDrawerView
```
public android.view.View getDrawerView(int direction)
```
- setLeftDrawerView
```
public DrawerConsumer setLeftDrawerView(android.view.View drawerView)
```
- setRightDrawerView
```
public DrawerConsumer setRightDrawerView(android.view.View drawerView)
```
- setTopDrawerView
```
public DrawerConsumer setTopDrawerView(android.view.View drawerView)
```
- setBottomDrawerView
```
public DrawerConsumer setBottomDrawerView(android.view.View drawerView)
```
- setHorizontalDrawerView
```
public DrawerConsumer setHorizontalDrawerView(android.view.View drawerView)
```
- setVerticalDrawerView
```
public DrawerConsumer setVerticalDrawerView(android.view.View drawerView)
```
- setAllDirectionDrawerView
```
public DrawerConsumer setAllDirectionDrawerView(android.view.View drawerView)
```
- setDrawerView
```
public DrawerConsumer setDrawerView(int direction,
                                    android.view.View drawerView)
```
  set a extension to the direction, also set direction enable if drawerView is not null(otherwise, disable the direction) direction can be a single direction or mixed direction(eg: DIRECTION_LEFT | DIRECTION_RIGHT)
  
  参数:
  
  direction - direction to set
  
  drawerView - view
  
  返回:
  
  this
- getOpenDistance
```
public int getOpenDistance()
```
  覆盖:
  
  getOpenDistance 在类中 SwipeConsumer
- setScrimColor
```
public DrawerConsumer setScrimColor(int color)
```
  Set a color to use for the scrim that obscures primary content while a drawer is open.
  
  参数:
  
  color - Color to use in 0xAARRGGBB format.
  
  返回:
  
  this
- setShadowColor
```
public DrawerConsumer setShadowColor(int shadowColor)
```
  Set a color to use for the shadow at the edge of content view while a drawer is open.
  
  参数:
  
  shadowColor - Color to use in 0xAARRGGBB format.
  
  返回:
  
  this
- getShadowSize
```
public int getShadowSize()
```
- setShadowSize
```
public DrawerConsumer setShadowSize(int size)
```
  set the size of shadow at the edge of content view while a drawer is open.
  
  参数:
  
  size - shadow size in pixel
  
  返回:
  
  this
- isDrawerViewRequired
```
public boolean isDrawerViewRequired()
```
- setDrawerViewRequired
```
public DrawerConsumer setDrawerViewRequired(boolean required)
```
  set the extension view as drawer is required or not it useful inside this sdk framework, developers who use this SDK do not call this function unless you really know what its mean
  
  参数:
  
  required - required or not
  
  返回:
  
  this
- isScrimAndShadowOutsideContentView
```
public boolean isScrimAndShadowOutsideContentView()
```
- showScrimAndShadowOutsideContentView
```
public DrawerConsumer showScrimAndShadowOutsideContentView()
```
- showScrimAndShadowInsideContentView
```
public DrawerConsumer showScrimAndShadowInsideContentView()
```
- onClick
```
public void onClick(android.view.View v)
```
  指定者:
  
  onClick 在接口中 android.view.View.OnClickListener
- canChildScroll
```
protected boolean canChildScroll(android.view.ViewGroup parentView,
                                 int direction,
                                 int pointerId,
                                 float downX,
                                 float downY,
                                 float dx,
                                 float dy)
```
  覆盖:
  
  canChildScroll 在类中 SwipeConsumer

类 DrawerConsumer

字段概要

从类继承的字段 com.billy.android.swipe.SwipeConsumer

构造器概要

方法概要

从类继承的方法 com.billy.android.swipe.SwipeConsumer

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

字段详细资料

mDrawerViews

mCurDrawerView

l

t

r

b

mScrimColor

mShadowColor

mScrimView

mShadowSize

mDrawerViewRequired

mShowScrimAndShadowOutsideContentView

构造器详细资料

DrawerConsumer

方法详细资料

onAttachToWrapper

initChildrenFormXml

onDetachFromWrapper

onOpened

onClosed

tryAcceptMoving

onSwipeAccepted

changeDrawerViewVisibility

setCurrentStateAsClosed

initScrimView

calculateDrawerDirectionInitPosition

onLayout

onDisplayDistanceChanged

orderChildren

layoutChildren

layoutContentView

layoutDrawerView

layoutScrimView

notifySwipeStart

notifySwipeProgress

notifySwipeRelease

getDrawerView

setLeftDrawerView

setRightDrawerView

setTopDrawerView

setBottomDrawerView

setHorizontalDrawerView

setVerticalDrawerView

setAllDirectionDrawerView

setDrawerView

getOpenDistance

setScrimColor

setShadowColor

getShadowSize

setShadowSize

isDrawerViewRequired

setDrawerViewRequired

isScrimAndShadowOutsideContentView

showScrimAndShadowOutsideContentView

showScrimAndShadowInsideContentView

onClick

canChildScroll