RecyclerView 梳理:点击&长按事件、分割线、拖曳排序、滑动删除
本文作者
作者:OCNYang
链接:http://www.jianshu.com/p/70788a7a5547
本文由作者投稿发布。
这次主要是把 RecyclerView 比较常用的基本的点,在这里集中整理一下。从这篇文章主要梳理以下几点:
优雅的实现:item 点击事件 & item 长点击事件
RecyclerView 添加 divider 的标准姿势
RecyclerView 实现 item 的拖曳排序和滑动删除
拖曳排序时,限制首个 item 固定的实现
先看一下最终的效果图:
--swipe and drag--
--drag--
自从 RecyclerView 发布以来,由于其高度的可交互性被广泛使用。相信大家肯定对它的使用方法已经非常熟练了,今天主要是为大家总结一下较正常用法更加优雅的方式。
如果你想再回顾一下 RecyclerView 的基本使用方法,推荐鸿洋的这篇文章:
《Android RecyclerView 使用完全解析 体验艺术般的控件》http://blog.csdn.net/lmj623565791/article/details/45059587
使用方式
RecyclerView 的 api 虽然没有提供 onItemClickListener 但是提供了 addOnItemTouchListener() 方法,既然可以添加触摸监听,那么我们完全可以获取触摸手势来识别点击事件,然后通过触摸坐标来判断点击的是哪一个item。
其中 OnRecyclerItemClickListener 是自定义的一个触摸监听器,代码如下:
GestureDetectorCompat 中传入了一个 ItemTouchHelperGestureListener,代码如下:
原理分析
上面的代码很简单没什么复杂的地方,就是通过一个手势探测器 GestureDetectorCompat 来探测屏幕事件,然后通过手势监听器 SimpleOnGestureListener 来识别手势事件的种类,然后调用我们设置的对应的回调方法。
这里值得说的是:当获取到了 RecyclerView 的点击事件和触摸事件数据 MotionEvent,那么如何才能知道点击的是哪一个 item 呢?
RecyclerView已经为我们提供了这样的方法:findChildViewUnder()
。
我们可以通过这个方法获得点击的 item ,同时我们调用 RecyclerView 的另一个方法 getChildViewHolder()
,可以获得该 item 的 ViewHolder,最后再回调我们定义的虚方法 onItemClick() 就ok了,这样我们就可以在外部实现该方法来获得 item 的点击事件了。
当你想给条目间添加 divider 时,你可能自然而然的去尝试这种方式:
<android.support.v7.widget.RecyclerView
android:divider="#ffff0000"
android:dividerHeight="10dp"
android:layout_width="match_parent"
android:layout_height="match_parent" />
其实 RecyclerView 是没有这两个属性的,就算你写上也不会有任何效果。
当然你还可以通过给 item 的最外层布局设置一个 margin 值,甚至你还可以专门在 item 布局中的适当地方添加一个高度/宽度为 1 的带背景的 View 作为 divider,这两种方法呢,确实有效果,但是不够优雅,有时还可能带来一些想不到的问题。
其实官方还是为我们提供了为 RecyclerView 添加分割线的方式的,那就是方法: mRecyclerView.addItemDecoration()
。
该方法的参数为 RecyclerView.ItemDecoration,该类为抽象类,且官方目前并没有提供默认的实现类,我们只能自己来实现。
注意:作者这里给出了列表布局和网格布局分别实现分割线的实现类,由于代码太长,可以跳转到原文查看。
上面给出的两个实例都是最简单的一条线的分割。这里的分割线你是可以自由的去自定义它的,具体如何实现也不是太复杂,这里不再做详细介绍了,推荐一篇文章:
《RecyclerView之ItemDecoration 讲解及高级特性实践》
http://www.10tiao.com/html/227/201705/2650239745/1.html
下面就主要为大家梳理一下拖曳排序和滑动删除的实现,具体实现效果看文章首部效果图,这里就不再重复放图了。
实现方式
主要就要使用到 ItemTouchHelper,ItemTouchHelper 一个帮助开发人员处理拖拽和滑动删除的实现类,它能够让你非常容易实现侧滑删除、拖拽的功能。
(ItemTouchHelper 的使用并不仅仅局限于 RecyclerView 的滑动删除,你同意可以用在其他需要拖曳滑动的地方。当然,今天我们不涉及其他地方的使用)
实现的代码并关联到 RecyclerView 非常简单,代码如下:
ItemTouchHelper itemTouchHelper
= new ItemTouchHelper(new ItemTouchHelper.Callback());
itemTouchHelper.attachToRecyclerView(mRecyclerView);
代码很简单,没什么好说的。
需要我们关注的是创建 ItemTouchHelper 时传入的参数 ItemTouchHelper.Callback() 。ItemTouchHelper 会在拖拽的时候回调 Callback 中相应的方法,我们只需在 Callback 中实现自己的逻辑。
自定义一个类继承实现 ItemTouchHelper.Callback 接口,需要实现以下方法:
getMovementFlags() 用于设置是否处理拖拽事件和滑动事件,以及拖拽和滑动操作的方向,有以下两种情况:
如果是列表类型的 RecyclerView,拖拽只有 UP、DOWN 两个方向
如果是网格类型的则有 UP、DOWN、LEFT、RIGHT 四个方向
该方法需要编写的代码如下:
dragFlags 是拖拽标志,
swipeFlags 是滑动标志,
swipeFlags 都设置为0,暂时不考虑滑动相关操作。
如果设置了相关的 dragFlags,那么当长按 item 的时候就会进入拖拽并在拖拽过程中不断回调 onMove() 方法,我们就在这个方法里获取当前拖拽的 item 和已经被拖拽到所处位置的 item 的ViewHolder,有了这2个 ViewHolder,我们就可以交换他们的数据集并调用 Adapter 的notifyItemMoved 方法来刷新 item。
只要重写完上面这两个方法,RecyclerView 就能实现拖曳的效果了。是不是很简单?
但是虽然拖曳是没什么问题了,但是并不能达到下图的效果,因为你正在拖曳的 item 并没有阴影效果。
那怎么才能实现被拖曳的 item 有背景颜色加深起到强调的视觉效果呢?这是需要重写下面两个方法:
这样就能完全达到上面图片的效果了。
滑动删除
如何实现滑动删除呢?我们只需要实现第三个方法 onSwipe() 就行了。
代码如下:
同时也不要忘了修改一下 getMovementFlags() 方法,以便能够相应滑动事件:
那目前你就能完美的实现拖曳排序和滑动删除了。
拖曳排序,首个固定
有时我们希望首个 item 不能被拖曳排序。比如我们在新闻 App 中常见当我们进行新闻分类时,“热门”新闻这个分类总是第一个且不能被拖曳修改,类似下面的效果:
那么怎么才能达到上面的效果呢?在上面我们的 Callback 类中有一个方法:
public boolean isLongPressDragEnabled() {
return true;
}
这个方法是为了告诉 ItemTouchHelper 是否需要 RecyclerView 支持长按拖拽,默认返回是 ture,理所当然我们要支持,所以我们没有重写,因为默认true。
但是这样做是默认全部的item都可以拖拽,怎么实现部分item拖拽呢,在 isLongPressDragEnabled 方法的源码中有提示说,如果想自定义拖曳 view,那么就使用 startDrag(ViewHolder) 方法。
第一步:那么我们就先重写 isLongPressDragEnabled() 方法,返回 false 让它控制所有的 item 都不能拖曳。
public boolean isLongPressDragEnabled() {
return false;
}
第二步:我们给 RecyclerView 设置 item 的长按监听事件,然后判断这个 item 是不是第一个(或者最后一个,如果你不想让最后一个被拖曳的话),如果不是我们就手动调用 startDrag(ViewHolder) 让 item 开始被拖曳。
结合上面我们提供的给 item 设置点击和长按事件的方法,我们可以这样:
第三步:如果你以为上面两步你就达到首个 item 固定不被拖曳的话,恭喜你,答对了!首个 item 确实固定不能被拖曳了,可是看看下图,就会令你大跌眼睛:
虽然我们通过上面两步控制了首个 item 不能被长按拖曳,但是我们并没有处理,别的 item 被拖曳到首个 item 的情况。那么如何才能让首个 item 不被挤掉呢,这个也很简单,只需要在 Callback 的 onMove() 方法中处理首个 item 被当着目标 item 的情况就行了。
好了,到这里就大功告成了。
本文源代码地址:
https://github.com/OCNYang/RecyclerViewEvent
参考文章:
http://chuansong.me/n/400690551872
http://chuansong.me/n/400690851058
http://www.10tiao.com/html/227/201705/2650239745/1.html
如果你有想学习的文章直接留言,我会整理征稿。如果你有好的文章想和大家分享欢迎投稿,直接向我投递文章链接即可。
欢迎长按下图->识别图中二维码或者扫一扫关注我的公众号: