ViewDragHelper

DIRECTION_ALL

int DIRECTION_ALL

Indicates that a check should occur along all axes

Constant Value: 3 (0x00000003)

DIRECTION_HORIZONTAL

int DIRECTION_HORIZONTAL

Indicates that a check should occur along the horizontal axis

Constant Value: 1 (0x00000001)

DIRECTION_VERTICAL

int DIRECTION_VERTICAL

Indicates that a check should occur along the vertical axis

Constant Value: 2 (0x00000002)

EDGE_ALL

int EDGE_ALL

Edge flag set indicating all edges should be affected.

Constant Value: 15 (0x0000000f)

EDGE_BOTTOM

int EDGE_BOTTOM

Edge flag indicating that the bottom edge should be affected.

Constant Value: 8 (0x00000008)

EDGE_LEFT

int EDGE_LEFT

Edge flag indicating that the left edge should be affected.

Constant Value: 1 (0x00000001)

EDGE_RIGHT

int EDGE_RIGHT

Edge flag indicating that the right edge should be affected.

Constant Value: 2 (0x00000002)

EDGE_TOP

int EDGE_TOP

Edge flag indicating that the top edge should be affected.

Constant Value: 4 (0x00000004)

INVALID_POINTER

int INVALID_POINTER

A null/invalid pointer ID.

Constant Value: -1 (0xffffffff)

STATE_DRAGGING

int STATE_DRAGGING

A view is currently being dragged. The position is currently changing as a result of user input or simulated user input.

Constant Value: 1 (0x00000001)

STATE_IDLE

int STATE_IDLE

A view is not currently being dragged or animating as a result of a fling/snap.

Constant Value: 0 (0x00000000)

STATE_SETTLING

int STATE_SETTLING

A view is currently settling into place as a result of a fling or predefined non-interactive motion.

Constant Value: 2 (0x00000002)

abort

void abort ()

cancel(), but also abort all motion in progress and snap to the end of any animation.

cancel

void cancel ()

The result of a call to this method is equivalent to processTouchEvent(android.view.MotionEvent) receiving an ACTION_CANCEL event.

captureChildView

void captureChildView (View childView, 
                int activePointerId)

Capture a specific child view for dragging within the parent. The callback will be notified but tryCaptureView(android.view.View, int) will not be asked permission to capture this view.

checkTouchSlop

boolean checkTouchSlop (int directions, 
                int pointerId)

Check if the specified pointer tracked in the current gesture has crossed the required slop threshold.

This depends on internal state populated by shouldInterceptTouchEvent(android.view.MotionEvent) or processTouchEvent(android.view.MotionEvent). You should only rely on the results of this method after all currently available touch data has been provided to one of these two methods.

checkTouchSlop

boolean checkTouchSlop (int directions)

Check if any pointer tracked in the current gesture has crossed the required slop threshold.

This depends on internal state populated by shouldInterceptTouchEvent(android.view.MotionEvent) or processTouchEvent(android.view.MotionEvent). You should only rely on the results of this method after all currently available touch data has been provided to one of these two methods.

continueSettling

boolean continueSettling (boolean deferCallbacks)

Move the captured settling view by the appropriate amount for the current time. If continueSettling returns true, the caller should call it again on the next frame to continue.

create

ViewDragHelper create (ViewGroup forParent, 
                float sensitivity, 
                ViewDragHelper.Callback cb)

Factory method to create a new ViewDragHelper.

create

ViewDragHelper create (ViewGroup forParent, 
                ViewDragHelper.Callback cb)

Factory method to create a new ViewDragHelper.

findTopChildUnder

View findTopChildUnder (int x, 
                int y)

Find the topmost child under the given point within the parent view's coordinate system. The child order is determined using getOrderedChildIndex(int).

flingCapturedView

void flingCapturedView (int minLeft, 
                int minTop, 
                int maxLeft, 
                int maxTop)

Settle the captured view based on standard free-moving fling behavior. The caller should invoke continueSettling(boolean) on each subsequent frame to continue the motion until it returns false.

getActivePointerId

int getActivePointerId ()

getCapturedView

View getCapturedView ()

getEdgeSize

int getEdgeSize ()

Return the size of an edge. This is the range in pixels along the edges of this view that will actively detect edge touches or drags if edge tracking is enabled.

getMinVelocity

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.

getTouchSlop

int getTouchSlop ()

getViewDragState

int getViewDragState ()

Retrieve the current drag state of this helper. This will return one of STATE_IDLE, STATE_DRAGGING or STATE_SETTLING.

isCapturedViewUnder

boolean isCapturedViewUnder (int x, 
                int y)

Determine if the currently captured view is under the given point in the parent view's coordinate system. If there is no captured view this method will return false.

isEdgeTouched

boolean isEdgeTouched (int edges)

Check if any of the edges specified were initially touched in the currently active gesture. If there is no currently active gesture this method will return false.

isEdgeTouched

boolean isEdgeTouched (int edges, 
                int pointerId)

Check if any of the edges specified were initially touched by the pointer with the specified ID. If there is no currently active gesture or if there is no pointer with the given ID currently down this method will return false.

isPointerDown

boolean isPointerDown (int pointerId)

Check if the given pointer ID represents a pointer that is currently down (to the best of the ViewDragHelper'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.

isViewUnder

boolean isViewUnder (View view, 
                int x, 
                int y)

Determine if the supplied view is under the given point in the parent view's coordinate system.

processTouchEvent

void processTouchEvent (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.

setEdgeTrackingEnabled

void setEdgeTrackingEnabled (int edgeFlags)

Enable edge tracking for the selected edges of the parent view. The callback's onEdgeTouched(int, int) and onEdgeDragStarted(int, int) methods will only be invoked for edges for which edge tracking has been enabled.

setMinVelocity

void 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.

settleCapturedViewAt

boolean settleCapturedViewAt (int finalLeft, 
                int finalTop)

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(boolean) 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.

shouldInterceptTouchEvent

boolean shouldInterceptTouchEvent (MotionEvent ev)

Check if this event as provided to the parent view's onInterceptTouchEvent should cause the parent to intercept the touch event stream.

smoothSlideViewTo

boolean smoothSlideViewTo (View child, 
                int finalLeft, 
                int finalTop)

Animate the view child to the given (left, top) position. If this method returns true, the caller should invoke continueSettling(boolean) 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.

This operation does not count as a capture event, though getCapturedView() will still report the sliding view while the slide is in progress.

canScroll

boolean canScroll (View v, 
                boolean checkV, 
                int dx, 
                int dy, 
                int x, 
                int y)

Tests scrollability within child views of v given a delta of dx.