原文连接:Drag and Swipe with RecyclerView Part One: Basic ItemTouchHelper Example
在Android中搭配RecyclerView实现“拖拽”和“笔刷”动画效果有很多指南、开源库、示例。许多做法仍然使用老式的View.OnDragListener监听器以及Roman Nurikd的SwipeToDismiss开源库,虽然这个库一直在维护。使用新的API,但常常依赖GestureDetector类和onInterceptTouchEvent方法,或许这些实现非常复杂。这儿其实有一个更简单的方法去添加这些特效到RecyclerView中。仅仅需要一个类,而且它已经被Android官方添加到Android Support Library兼容包中了:这就是ItemTouchHelper类,这个工具类非常强大,它已经实现了拖拽和笔刷效果方便你添加到RecyclerView中。它是RecyclerView.ItemDecoration的子类。很容易集成到现有的LayoutManager和Adapter还有Item Animations中。为你提供拖动 — 释放和一些其它动画效果,本文中,我将实现一个ItemTouchHelper简单示例。随后进一步讨论它的适用范围和探索它的更多特性。
题外话
假如你想查看完整代码?请移步这里:Android-ItemTouchHelper-Demo 下载APK戳这里:APK
设置
如果你还没有添加RecyclerView依赖包,请打开build.gradle文件,添加以下的配置代码:
compile 'com.android.support:recyclerview-v7:22.2.0'
22.2.0是support包的版本号,根据你自己的情况设置,ItemTouchHelper几乎可以和所有的RecyclerView.Adapter、LayoutManager搭配使用。本博客创建的其它文件都能在github中找到:https://github.com/iPaulPro/Android-ItemTouchHelper-Demo
使用ItemTouchHelper and ItemTouchHelper.Callback
为了使用ItemTouchHelper,你需要实现ItemTouchHelper.Callback接口,通过这个接口,你可以监听“move”和 “swipe”事件,在这儿你也可以控制View的选择状态和覆盖默认动画。根据需要你可以使用Android官网提供的简单实现,SimpleCallback,但为了学习的目地,我们还是自己实现。
我们必须实现主要的回调方法:
getMovementFlags(RecyclerView, ViewHolder)
onMove(RecyclerView, ViewHolder, ViewHolder)
onSwiped(ViewHolder, int)
我们还将使用2个帮助方法:
isLongPressDragEnabled()
isItemViewSwipeEnabled()
@Override
public int getMovementFlags(RecyclerView recyclerView,
RecyclerView.ViewHolder viewHolder) {
int dragFlags = ItemTouchHelper.UP| ItemTouchHelper.DOWN;
int swipeFlags = ItemTouchHelper.START| ItemTouchHelper.END;
return makeMovementFlags(dragFlags, swipeFlags);
}
ItemTouchHelper允许你判断事件方向。但你必须覆写getMovementFlags()方法去指定支持哪些方向。使用ItemTouchHelper.makeMovementFlags(int, int)创建代表方向的Flag。这里我们同时支持drag和swipe。
@Override
public boolean isLongPressDragEnabled() {
return true;
}
实现这个方法,ItemTouchHelper只能drag而不是swipe(反之亦然)所以必须正确指定是否支持drag。实现isLongPressDragEnabled()方法返回true去支持长按RecyclerView的item时的drag事件。
另外ItemTouchHelper.startDrag(RecyclerView.ViewHolder)方法支持手势拖动。以后再讲这部分内容。
@Override
public boolean isItemViewSwipeEnabled() {
return true;
}
实现isItemViewSwipeEnabled()方法返回true开启触摸视图时的swipe功能。另外ItemTouchHelper.startSwipe(RecyclerView.ViewHolder)也支持swipe事件。
接下来onMove()和onSwiped()两个方法被用来通知底层数据改变。所以我们需要先创建一个接口。随后使用链式回调传递事件。
public interface ItemTouchHelperAdapter {
void onItemMove(int fromPosition, int toPosition);
void onItemDismiss(int position);
}
这样做的方式很简单,只需要我们的RecyclerListAdapter去实现这个接口:
public class RecyclerListAdapter extends RecyclerView.Adapter implements ItemTouchHelperAdapter{
// ... code
@Override
public void onItemDismiss(int position) {
mItems.remove(position);
notifyItemRemoved(position);
}
@Override
public boolean onItemMove(int fromPosition, int toPosition) {
if (fromPosition < toPosition) {
for (int i = fromPosition; i < toPosition; i++) {
Collections.swap(mItems, i, i + 1);
}
} else {
for (int i = fromPosition; i > toPosition; i--) {
Collections.swap(mItems, i, i - 1);
}
}
notifyItemMoved(fromPosition, toPosition);
return true;
}
调用notifyItemRemoved()和notifyItemMoved()方法对Adapter来说非常重要目地是让它意识到某些数据已被更改。同时也要注意View的位置和index在时刻变化。而不是最后的“drop”事件。
现在我们可以回去实现我们的SimpleItemTouchHelperCallback,我们同样需要覆写onMove() 和onSwiped()方法,首先添加构造器和一个Adapter类型的字段:
private final ItemTouchHelperAdapter mAdapter;
public SimpleItemTouchHelperCallback( ItemTouchHelperAdapter adapter) {
mAdapter= adapter;
}
随后覆写onMove()和onSwiped()方法并通知适配器
@Override
public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder,
RecyclerView.ViewHolder target) {
mAdapter.onItemMove(viewHolder.getAdapterPosition(),
target.getAdapterPosition());
return true;
}
@Override
public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
mAdapter.onItemDismiss(viewHolder.getAdapterPosition());
}
最后的回调接口类看起来像这样:
使用我们写好的回调接口,我们可以创建自己的ItemTouchHelper实例并调用attachToRecyclerView(RecyclerView)方法(例如在:MainFragment.java类中)
ItemTouchHelper.Callback callback = new
SimpleItemTouchHelperCallback(adapter);
ItemTouchHelper touchHelper= new ItemTouchHelper(callback);
touchHelper.attachToRecyclerView(recyclerView);
app运行后像这样:
总结
这是一个ItemTouchHelper基础实现。这下,你知道在RecyclerView中并不需要第三方库也可以达到这种“拖拽”和“笔刷”效果。下一篇文章,我们将带来更多的“拖拽”和“笔刷”特性。
源码
我在github创建了一个开源demo,里边的代码就是本篇文章描述的内容:Android-ItemTouchHelper-Demo,就写到这里,请期待第二篇文章。