android 拖拽帮助类ViewDragHelper

ViewDragHelper

1.前言

    在做android的View拖拽的时候,往往要用到dispatchTouchEvent , onInterceptTouchEvent , onTouchEvent,而且还要在这些方法中去实现比较复杂的逻辑，

如果和ViewGroup相关的话，多个子View拖拽，还可能产生事件冲突，这些问题是相当麻烦的。所以Google应运而生就出现了ViewGragHelper.

2.ViewGragHelper介绍：   

    从官方文档来看：ViewDragHelper is a utility class for writing custom ViewGroups. It offers a number of useful operations and state tracking for allowing a user to drag and reposition views within their parent ViewGroup

    这句话中要注意两点：

•   ViewdDragHelper 必须作用于ViewGroup上 ， 必进子View的位置还是由父View来决定的
•   ViewdDragHelper 给我们提供了大量有用操作来跟踪用户对View的拖拽

3.简单实现一个拖拽效果的步骤：

•  在ViewGroup中通过工厂方法实例化ViewdDragHelper。

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

                ViewGroup forParent ：即你要拖动哪个ViewGroup下面的子View

                float sensitivity ： 灵敏度 默认为1.0即可

                ViewDragHelper.Callback cb ： 处理拖动位置的回调

• 继承ViewDragHelper.Callback类，该类有个抽象方法：tryCaptureView(View view, int pointerId) 表示尝试捕获子view，这里一定要返回true， 返回true表示允许
• 重写两个方法int clampViewPositionHorizontal(View child, int left, int dx)和int clampViewPositionHorizontal(View child, int left, int dx) 这两个方法分别用来处理x方向和y方向的拖动的，返回值该child现在的位置。
• 重写ViewGroup的onInterceptTouchEvent(MotionEvent ev)用来拦截事件
  
•  重写ViewGroup的onTouchEvent(MotionEvent event) 在这里面只要做两件事：mDragHelper.processTouchEvent(event);处理拦截到的事件，这个方法会在返回前分发事 件；return true 表示  消费了事件。
• 简单的5步就可以实现一个可以任意拖动到view了，当然我们需要在clampViewPositionHorizontal和clampViewPositionVertical中做一点工作，以防止view超出了边界。

4.下面通过代码简单实现一个拖拽

　　

public class CustomView extends LinearLayout {

    private ViewDragHelper dragHelper;

    public CustomView(Context context) {
        this(context, null);
    }

    public CustomView(Context context, AttributeSet attrs) {
        this(context, attrs, 0);
    }

    public CustomView(Context context, AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
        init();
    }

    private void init() {
        setOrientation(LinearLayout.VERTICAL);
        dragHelper = ViewDragHelper.create(this, (float) 1.0,
                new ViewDragHelper.Callback() {

                    // 尝试捕获要拖动的子View 这里一定要返回true
                    @Override
                    public boolean tryCaptureView(View view, int pointerId) {

                        
                        return true;
                    }

                    /**
                     * 处理水平方向上的拖动
                     * 
                     * @param View
                     *            child 被拖动到view
                     * @param int left 移动到达的x轴的距离
                     * @param int dx 建议的移动的x距离
                     */
                    @Override
                    public int clampViewPositionHorizontal(View child,
                            int left, int dx) {
                        
                        //拖动子View时候，限制拖动的边界位置
                        
                        if (getPaddingLeft() > left) {
                            return getPaddingLeft();
                        }
                        if (left > (getWidth() - getPaddingLeft()
                                - getPaddingRight() - child.getWidth())
                                + getPaddingLeft()) {
                            return (getWidth() - getPaddingLeft()
                                    - getPaddingRight() - child.getWidth())
                                    + getPaddingLeft();
                        }

                        if (getWidth() - child.getWidth() < left) {
                            return getWidth() - child.getWidth();
                        }
                        return left;
                    }

                    @Override
                    public int clampViewPositionVertical(View child, int top,
                            int dy) {

                        if (getPaddingTop() > top) {
                            return getPaddingTop();
                        }

                        if (getHeight() - child.getHeight() < top) {
                            return getHeight() - child.getHeight();
                        }

                        return top;
                    }

                    /**
                     * 当拖拽到状态改变时回调
                     * 
                     * @params 新的状态
                     */
                    @Override
                    public void onViewDragStateChanged(int state) {
                        switch (state) {
                        // 正在被拖拽
                        case ViewDragHelper.STATE_DRAGGING:
                            break;
                        // view没有被拖拽或者正在进行fling
                        case ViewDragHelper.STATE_IDLE:
                            break;
                        // fling完毕后被放置到一个位置
                        case ViewDragHelper.STATE_SETTLING:
                            break;
                        }

                        super.onViewDragStateChanged(state);
                    }

                });

    }

    @Override
    public boolean dispatchTouchEvent(MotionEvent ev) {
        return super.dispatchTouchEvent(ev);
    }

    @Override
    public boolean onInterceptTouchEvent(MotionEvent ev) {

        switch (ev.getAction()) {
        case MotionEvent.ACTION_CANCEL:
            break;
        case MotionEvent.ACTION_DOWN:
            dragHelper.cancel();
            break;
        }
        /**
         * 检查是否可以拦截touch事件 如果onInterceptTouchEvent可以return true 则这里return true
         */
        return dragHelper.shouldInterceptTouchEvent(ev);
    }

    @Override
    public boolean onTouchEvent(MotionEvent event) {
        /**
         * 处理拦截到的事件 这个方法会在返回前分发事件
         */
        dragHelper.processTouchEvent(event);

        return true;
    }

}

XML文件：

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    tools:context=".MainActivity" >

    <com.example.dragviewhelpertest.view.CustomView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:paddingLeft="100dp"
        android:paddingRight="100dp" >

        <TextView
            android:layout_width="100dp"
            android:layout_height="100dp"
            android:background="#FFFF0000" />

    </com.example.dragviewhelpertest.view.CustomView>

</RelativeLayout>

代码下载：下载