在Android中避免不了自定义ViewGroup,来实现我们原生控件所不能满足的需求。尤其是复杂的ViewGroup实现,手势的处理是避免不了的。我们要针对不同的ViewGroup来实现不同的onInterceptTouchEvent与onTouchEvent事件等。
那么有没有什么简便的方法呢?答案是肯定的,ViewDragHelper可以帮助我们解决负责的手势操作。它是官方所提供的一个专门为自定义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.
通过这篇文章你将会掌握以下几个知识点:
首先需要构建ViewDragHelper的实例,通过它的静态creat方法生成
1mViewDragHelper = ViewDragHelper.create(this, object : ViewDragHelper.Callback() {
2 override fun tryCaptureView(child: View?, pointerId: Int): Boolean {
3 TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
4 }
5})
主要参数为ViewGroup与ViewDragHelper.Callback。Callback是对view操作的回调,绝对多数手势操作都是在这个回调中完成。tryCaptureView方法是它唯一的抽象方法,默认需要实现。根据参数child判断用户触摸的view是否可以进行后续操作。
为了让ViewDragHelper帮助我们简化手势操作,所以还需为它传入相关的MotionEvent。
1override fun onInterceptTouchEvent(ev: MotionEvent?): Boolean {
2 return mViewDragHelper.shouldInterceptTouchEvent(ev)
3}
4
5override fun onTouchEvent(event: MotionEvent?): Boolean {
6 mViewDragHelper.processTouchEvent(event)
7 return true
8}
分别调用ViewDragHelper的shouldInterceptTouchEvent与processTouchEvent来简化手势的操作判断。将手势操作全部交由ViewDragHelper来实现。
如果要处理惯性滑动,再重写computeScroll方法
1override fun computeScroll() {
2 if (mViewDragHelper.continueSettling(true)) {
3 invalidate()
4 }
5}
ViewDragHelper的基本使用就是这么多,算了一下也就十几行代码。相对于自己实现其中的细节,减少了许多代码。所以如果你想快速简便的实现手势操作,ViewDragHelper是不二之选。
下面通过一个实例来对ViewDragHelper的主要Api的使用进行分析。首先来看下要实现的初步效果。
有三个view,分别可以进行水平、竖直与任意位置滑动。而要实现这种效果,需要用到的就是ViewDragHelper.Callback中的回调方法。
该方法返回布尔值来判断当前操作的view是否可以进行捕获。demo中需要这三个view都能被捕获到,所以很简单只需与参数的child做对比即可。
1override fun tryCaptureView(child: View?, pointerId: Int): Boolean {
2 if (mLeft == 0 || mTop == 0){
3 mLeft = mFlexibleView.left
4 mTop = mFlexibleView.top
5 }
6 return child == mHorizontalView || child == mVerticalView || child == mFlexibleView
7}
初始化了任意滑动view的初始left与top,以便后续使用。
有了view的捕获判断,接下来对水平方向的操作进行判断。
1override fun clampViewPositionHorizontal(child: View?, left: Int, dx: Int): Int {
2 if (child != mVerticalView) {
3 return left
4 }
5 return child.left
6}
它的各个参数与返回值
由于只有竖直方向的view不能随意移动,所以当捕获的view为竖直方向时就直接返回child.left原来的位置;反之返回left。
对于竖直方向的操作判断与水平方向同理,看下代码即可。
1override fun clampViewPositionVertical(child: View?, top: Int, dy: Int): Int {
2 if (child != mHorizontalView) {
3 return top
4 }
5 return child.top
6}
此时运行项目,该demo的功能基本完成,三个view都能预期拖动。只是要到达任意view拖动之后回到初始位置还需重写接下来的方法。
1override fun onViewReleased(releasedChild: View?, xvel: Float, yvel: Float) {
2 if (releasedChild == mFlexibleView) {
3 mViewDragHelper.settleCapturedViewAt(mLeft, mTop)
4 invalidate()
5 } else {
6 super.onViewReleased(releasedChild, xvel, yvel)
7 }
8}
这是对view释放后的回调。如果要对view释放后的轨迹做改变可以在这方法中实现。
这里还使用到了settleCaptureViewAt方法,该方法的作用是将当前view定位到所给的坐标位置。内部会回到continueSetting方法,来实现滑动动画。
xvel与yvel可以用来实现释放view后的惯性移动操作。
从头到尾只使用了ViewDragHelper.Callback中的四个回调方法,就实现了demo中的拖拽效果。相对于自己实现,简单程度不言而喻。所以熟练使用ViewDragHelper不仅能提高我们的实现效率与代码质量还能减少出错率。
对于其它的Api都是些状态改变的回调,在实际中也用的少,手势的操作逻辑都不会在这些Api中实现,所以这里就不多介绍。上面的demo view拖拽超出边界,如果要固定边界,只需在clampViewPositionHorizontal与clampViewPositionVertical中边界判断即可,具体实现留给读者思考。
下面有一个注意的点:如果使用Button或者TextView设置了clickable=true,你会发现上面的Demo中的view不能操作了。主要原因是,如果view不消费触摸事件,则触摸事件将直接进入onTouchEvent,在Down事件中就已经确定了捕获的view;如果消费事件,会进入onInterceptTouchEvent判断是否可以捕获,而判断的过程会去调用getViewHorizontalDragRange与getViewVerticalDragRange,只有这两个回调方法返回大于0的值才能被捕获。所以要解决拖拽不动的问题,只需重写这两个方法。
1override fun getViewHorizontalDragRange(child: View?): Int {
2 return measuredWidth - (child?.measuredWidth?:0)
3}
4
5override fun getViewVerticalDragRange(child: View?): Int {
6 return measuredHeight - (child?.measuredHeight?:0)
7}
ok,到这里ViewDragHelper已经完全入门了,并且关键的Api也已经了然于胸。下面是实际项目中使用ViewDragHelper的效果图,与饿了么的商品详情界面效果类似。
本想上传gif图,但微信规定不能超过2M,所以这里只截取了一张图,如需查看完整效果图,可以点击文章末的左下角的阅读原文。
上面的手势动画使用的就是ViewDragHelper,而用到的Api也是全部是文章中提到的。希望通过文章中的demo效果能够加深ViewDragHelper对大家的影响与对它的期望度,也希望在日常开发中能够帮助大家轻松解决手势问题。
文章中的代码都可以在Github中获取到
https://github.com/idisfkj/android-api-analysis
使用时请将分支切换到feat_viewdraghelper_dev