Android ViewDragHelper完全解析自定義ViewGroup神器

更新時(shí)間：2017年03月24日 10:02:24 作者：鴻洋_

這篇文章主要為大家詳細(xì)介紹了Android ViewDragHelper完全解析，自定義ViewGroup神器，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

一、概述

在自定義ViewGroup中，很多效果都包含用戶手指去拖動(dòng)其內(nèi)部的某個(gè)View(eg:側(cè)滑菜單等)，針對具體的需要去寫好onInterceptTouchEvent和onTouchEvent這兩個(gè)方法是一件很不容易的事，需要自己去處理：多手指的處理、加速度檢測等等。
好在官方在v4的支持包中提供了ViewDragHelper這樣一個(gè)類來幫助我們方便的編寫自定義ViewGroup。簡單看一下它的注釋：

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.

本篇博客將重點(diǎn)介紹ViewDragHelper的使用，并且最終去實(shí)現(xiàn)一個(gè)類似DrawerLayout的一個(gè)自定義的ViewGroup。（ps:官方的DrawerLayout就是用此類實(shí)現(xiàn)）

二、入門小示例

首先我們通過一個(gè)簡單的例子來看看其快捷的用法，分為以下幾個(gè)步驟：

創(chuàng)建實(shí)例
觸摸相關(guān)的方法的調(diào)用
ViewDragHelper.Callback實(shí)例的編寫

(一) 自定義ViewGroup

package com.zhy.learn.view;

import android.content.Context;
import android.support.v4.widget.ViewDragHelper;
import android.util.AttributeSet;
import android.view.MotionEvent;
import android.view.View;
import android.widget.LinearLayout;

/**
 * Created by zhy on 15/6/3.
 */
public class VDHLayout extends LinearLayout
{
 private ViewDragHelper mDragger;

 public VDHLayout(Context context, AttributeSet attrs)
 {
  super(context, attrs);
  mDragger = ViewDragHelper.create(this, 1.0f, new ViewDragHelper.Callback()
  {
   @Override
   public boolean tryCaptureView(View child, int pointerId)
   {
    return true;
   }

   @Override
   public int clampViewPositionHorizontal(View child, int left, int dx)
   {
    return left;
   }

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

 @Override
 public boolean onInterceptTouchEvent(MotionEvent event)
 {
  return mDragger.shouldInterceptTouchEvent(event);
 }

 @Override
 public boolean onTouchEvent(MotionEvent event)
 {
  mDragger.processTouchEvent(event);
  return true;
 }
}

可以看到，上面整個(gè)自定義ViewGroup的代碼非常簡潔，遵循上述3個(gè)步驟：

1、創(chuàng)建實(shí)例

mDragger = ViewDragHelper.create(this, 1.0f, new ViewDragHelper.Callback()
  {
  });

創(chuàng)建實(shí)例需要3個(gè)參數(shù)，第一個(gè)就是當(dāng)前的ViewGroup，第二個(gè)sensitivity，主要用于設(shè)置touchSlop:

helper.mTouchSlop = (int) (helper.mTouchSlop * (1 / sensitivity));

可見傳入越大，mTouchSlop的值就會(huì)越小。第三個(gè)參數(shù)就是Callback，在用戶的觸摸過程中會(huì)回調(diào)相關(guān)方法，后面會(huì)細(xì)說。

2、觸摸相關(guān)方法

 @Override
 public boolean onInterceptTouchEvent(MotionEvent event)
 {
  return mDragger.shouldInterceptTouchEvent(event);
 }

 @Override
 public boolean onTouchEvent(MotionEvent event)
 {
  mDragger.processTouchEvent(event);
  return true;
 }

onInterceptTouchEvent中通過使用mDragger.shouldInterceptTouchEvent(event)來決定我們是否應(yīng)該攔截當(dāng)前的事件。onTouchEvent中通過mDragger.processTouchEvent(event)處理事件。

3、實(shí)現(xiàn)ViewDragHelper.CallCack相關(guān)方法

new ViewDragHelper.Callback()
  {
   @Override
   public boolean tryCaptureView(View child, int pointerId)
   {
    return true;
   }

   @Override
   public int clampViewPositionHorizontal(View child, int left, int dx)
   {
    return left;
   }

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

ViewDragHelper中攔截和處理事件時(shí)，需要會(huì)回調(diào)CallBack中的很多方法來決定一些事，比如：哪些子View可以移動(dòng)、對個(gè)移動(dòng)的View的邊界的控制等等。

上面復(fù)寫的3個(gè)方法：

tryCaptureView如何返回ture則表示可以捕獲該view，你可以根據(jù)傳入的第一個(gè)view參數(shù)決定哪些可以捕獲

clampViewPositionHorizontal,clampViewPositionVertical可以在該方法中對child移動(dòng)的邊界進(jìn)行控制，left , top 分別為即將移動(dòng)到的位置，比如橫向的情況下，我希望只在ViewGroup的內(nèi)部移動(dòng)，即：最小>=paddingleft，最大<=ViewGroup.getWidth()-paddingright-child.getWidth。就可以按照如下代碼編寫：

 @Override
   public int clampViewPositionHorizontal(View child, int left, int dx)
   {
    final int leftBound = getPaddingLeft();
    final int rightBound = getWidth() - mDragView.getWidth() - leftBound;

    final int newLeft = Math.min(Math.max(left, leftBound), rightBound);

    return newLeft;
   }

經(jīng)過上述3個(gè)步驟，我們就完成了一個(gè)簡單的自定義ViewGroup，可以自由的拖動(dòng)子View。

簡單看一下布局文件

(二) 布局文件

<com.zhy.learn.view.VDHLayout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:orientation="vertical"
        android:layout_height="match_parent"
 >

 <TextView
  android:layout_margin="10dp"
  android:gravity="center"
  android:layout_gravity="center"
  android:background="#44ff0000"
  android:text="I can be dragged !"
  android:layout_width="100dp"
  android:layout_height="100dp"/>

 <TextView
  android:layout_margin="10dp"
  android:layout_gravity="center"
  android:gravity="center"
  android:background="#44ff0000"
  android:text="I can be dragged !"
  android:layout_width="100dp"
  android:layout_height="100dp"/>

 <TextView
  android:layout_margin="10dp"
  android:layout_gravity="center"
  android:gravity="center"
  android:background="#44ff0000"
  android:text="I can be dragged !"
  android:layout_width="100dp"
  android:layout_height="100dp"/>

</com.zhy.learn.view.VDHLayout>

我們的自定義ViewGroup中有三個(gè)TextView。

當(dāng)前效果：

可以看到短短數(shù)行代碼就可以玩起來了~~~

有了直觀的認(rèn)識(shí)以后，我們還需要對ViewDragHelper.CallBack里面的方法做下深入的理解。首先我們需要考慮的是：我們的ViewDragHelper不僅僅說只能夠去讓子View去跟隨我們手指移動(dòng)，我們繼續(xù)往下學(xué)習(xí)其他的功能。

三、功能展示

ViewDragHelper還能做以下的一些操作：

邊界檢測、加速度檢測(eg：DrawerLayout邊界觸發(fā)拉出)
回調(diào)Drag Release（eg：DrawerLayout部分，手指抬起，自動(dòng)展開/收縮）
移動(dòng)到某個(gè)指定的位置(eg:點(diǎn)擊Button，展開/關(guān)閉Drawerlayout)

那么我們接下來對我們最基本的例子進(jìn)行改造，包含上述的幾個(gè)操作。

首先看一下我們修改后的效果：

簡單的為每個(gè)子View添加了不同的操作：

第一個(gè)View，就是演示簡單的移動(dòng)
第二個(gè)View，演示除了移動(dòng)后，松手自動(dòng)返回到原本的位置。（注意你拖動(dòng)的越快，返回的越快）
第三個(gè)View，邊界移動(dòng)時(shí)對View進(jìn)行捕獲。

好了，看完效果圖，來看下代碼的修改：

修改后的代碼

package com.zhy.learn.view;

import android.content.Context;
import android.graphics.Point;
import android.support.v4.widget.ViewDragHelper;
import android.util.AttributeSet;
import android.view.MotionEvent;
import android.view.View;
import android.widget.LinearLayout;

/**
 * Created by zhy on 15/6/3.
 */
public class VDHLayout extends LinearLayout
{
 private ViewDragHelper mDragger;

 private View mDragView;
 private View mAutoBackView;
 private View mEdgeTrackerView;

 private Point mAutoBackOriginPos = new Point();

 public VDHLayout(Context context, AttributeSet attrs)
 {
  super(context, attrs);
  mDragger = ViewDragHelper.create(this, 1.0f, new ViewDragHelper.Callback()
  {
   @Override
   public boolean tryCaptureView(View child, int pointerId)
   {
    //mEdgeTrackerView禁止直接移動(dòng)
    return child == mDragView || child == mAutoBackView;
   }

   @Override
   public int clampViewPositionHorizontal(View child, int left, int dx)
   {
    return left;
   }

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


   //手指釋放的時(shí)候回調(diào)
   @Override
   public void onViewReleased(View releasedChild, float xvel, float yvel)
   {
    //mAutoBackView手指釋放時(shí)可以自動(dòng)回去
    if (releasedChild == mAutoBackView)
    {
     mDragger.settleCapturedViewAt(mAutoBackOriginPos.x, mAutoBackOriginPos.y);
     invalidate();
    }
   }

   //在邊界拖動(dòng)時(shí)回調(diào)
   @Override
   public void onEdgeDragStarted(int edgeFlags, int pointerId)
   {
    mDragger.captureChildView(mEdgeTrackerView, pointerId);
   }
  });
  mDragger.setEdgeTrackingEnabled(ViewDragHelper.EDGE_LEFT);
 }


 @Override
 public boolean onInterceptTouchEvent(MotionEvent event)
 {
  return mDragger.shouldInterceptTouchEvent(event);
 }

 @Override
 public boolean onTouchEvent(MotionEvent event)
 {
  mDragger.processTouchEvent(event);
  return true;
 }

 @Override
 public void computeScroll()
 {
  if(mDragger.continueSettling(true))
  {
   invalidate();
  }
 }

 @Override
 protected void onLayout(boolean changed, int l, int t, int r, int b)
 {
  super.onLayout(changed, l, t, r, b);

  mAutoBackOriginPos.x = mAutoBackView.getLeft();
  mAutoBackOriginPos.y = mAutoBackView.getTop();
 }

 @Override
 protected void onFinishInflate()
 {
  super.onFinishInflate();

  mDragView = getChildAt(0);
  mAutoBackView = getChildAt(1);
  mEdgeTrackerView = getChildAt(2);
 }
}

布局文件我們僅僅是換了下文本和背景色就不重復(fù)貼了。

第一個(gè)View基本沒做任何修改。

第二個(gè)View，我們在onLayout之后保存了最開啟的位置信息，最主要還是重寫了Callback中的onViewReleased，我們在onViewReleased中判斷如果是mAutoBackView則調(diào)用settleCapturedViewAt回到初始的位置。大家可以看到緊隨其后的代碼是invalidate();因?yàn)槠鋬?nèi)部使用的是mScroller.startScroll，所以別忘了需要invalidate()以及結(jié)合computeScroll方法一起。

第三個(gè)View，我們在onEdgeDragStarted回調(diào)方法中，主動(dòng)通過captureChildView對其進(jìn)行捕獲，該方法可以繞過tryCaptureView，所以我們的tryCaptureView雖然并為返回true，但卻不影響。注意如果需要使用邊界檢測需要添加上mDragger.setEdgeTrackingEnabled(ViewDragHelper.EDGE_LEFT);。

到此，我們已經(jīng)介紹了Callback中常用的回調(diào)方法了，當(dāng)然還有一些方法沒有介紹，接下來我們修改下我們的布局文件，我們把我們的TextView全部加上clickable=true，意思就是子View可以消耗事件。再次運(yùn)行，你會(huì)發(fā)現(xiàn)本來可以拖動(dòng)的View不動(dòng)了，（如果有拿Button測試的兄弟應(yīng)該已經(jīng)發(fā)現(xiàn)這個(gè)問題了，我希望你看到這了，而不是已經(jīng)提問了,哈~）。

原因是什么呢？主要是因?yàn)?，如果子View不消耗事件，那么整個(gè)手勢（DOWN-MOVE*-UP）都是直接進(jìn)入onTouchEvent，在onTouchEvent的DOWN的時(shí)候就確定了captureView。如果消耗事件，那么就會(huì)先走onInterceptTouchEvent方法，判斷是否可以捕獲，而在判斷的過程中會(huì)去判斷另外兩個(gè)回調(diào)的方法：getViewHorizontalDragRange和getViewVerticalDragRange，只有這兩個(gè)方法返回大于0的值才能正常的捕獲。

所以，如果你用Button測試，或者給TextView添加了clickable = true ，都記得重寫下面這兩個(gè)方法：

@Override
public int getViewHorizontalDragRange(View child)
{
  return getMeasuredWidth()-child.getMeasuredWidth();
}

@Override
public int getViewVerticalDragRange(View child)
{
  return getMeasuredHeight()-child.getMeasuredHeight();
}

方法的返回值應(yīng)當(dāng)是該childView橫向或者縱向的移動(dòng)的范圍，當(dāng)前如果只需要一個(gè)方向移動(dòng)，可以只復(fù)寫一個(gè)。

到此，我們列一下所有的Callback方法，看看還有哪些沒用過的：

onViewDragStateChanged

當(dāng)ViewDragHelper狀態(tài)發(fā)生變化時(shí)回調(diào)（IDLE,DRAGGING,SETTING[自動(dòng)滾動(dòng)時(shí)]）

onViewPositionChanged

當(dāng)captureview的位置發(fā)生改變時(shí)回調(diào)

onViewCaptured

當(dāng)captureview被捕獲時(shí)回調(diào)

onViewReleased 已用

onEdgeTouched

當(dāng)觸摸到邊界時(shí)回調(diào)。

onEdgeLock

true的時(shí)候會(huì)鎖住當(dāng)前的邊界，false則unLock。

onEdgeDragStarted 已用

getOrderedChildIndex

改變同一個(gè)坐標(biāo)（x,y）去尋找captureView位置的方法。（具體在：findTopChildUnder方法中）

getViewHorizontalDragRange 已用

getViewVerticalDragRange 已用

tryCaptureView 已用

clampViewPositionHorizontal 已用

clampViewPositionVertical 已用

ok，至此所有的回調(diào)方法都有了一定的認(rèn)識(shí)。

總結(jié)下，方法的大致的回調(diào)順序：

shouldInterceptTouchEvent：

DOWN:
  getOrderedChildIndex(findTopChildUnder)
  ->onEdgeTouched

MOVE:
  getOrderedChildIndex(findTopChildUnder)
  ->getViewHorizontalDragRange & 
   getViewVerticalDragRange(checkTouchSlop)(MOVE中可能不止一次)
  ->clampViewPositionHorizontal&
   clampViewPositionVertical
  ->onEdgeDragStarted
  ->tryCaptureView
  ->onViewCaptured
  ->onViewDragStateChanged

processTouchEvent:

DOWN:
  getOrderedChildIndex(findTopChildUnder)
  ->tryCaptureView
  ->onViewCaptured
  ->onViewDragStateChanged
  ->onEdgeTouched
MOVE:
  ->STATE==DRAGGING:dragTo
  ->STATE!=DRAGGING:
    onEdgeDragStarted
    ->getOrderedChildIndex(findTopChildUnder)
    ->getViewHorizontalDragRange&
     getViewVerticalDragRange(checkTouchSlop)
    ->tryCaptureView
    ->onViewCaptured
    ->onViewDragStateChanged

ok，上述是正常情況下大致的流程，當(dāng)然整個(gè)過程可能會(huì)存在很多判斷不成立的情況。

從上面也可以解釋，我們在之前TextView(clickable=false)的情況下，沒有編寫getViewHorizontalDragRange方法時(shí)，是可以移動(dòng)的。因?yàn)橹苯舆M(jìn)入processTouchEvent的DOWN，然后就onViewCaptured、onViewDragStateChanged（進(jìn)入DRAGGING狀態(tài)），接下來MOVE就直接dragTo了。

而當(dāng)子View消耗事件的時(shí)候，就需要走shouldInterceptTouchEvent，MOVE的時(shí)候經(jīng)過一系列的判斷（getViewHorizontalDragRange，clampViewPositionVertical等），才能夠去tryCaptureView。

ok，到此ViewDragHelper的入門用法我們就介紹結(jié)束了，下一篇，我們將使用ViewDragHelper去自己實(shí)現(xiàn)一個(gè)DrawerLayout。
有興趣的也可以根據(jù)本文，以及DrawerLayout的源碼去實(shí)現(xiàn)了~

參考鏈接

http://flavienlaurent.com/blog/2013/08/28/each-navigation-drawer-hides-a-viewdraghelper/
http://blog.denevell.org/android-viewdraghelper-example-tutorial.html

~~have a nice day ~~

源碼點(diǎn)擊下載

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: