【译】ItemTouchHelper实现拖拽笔刷效果-part1

原文连接: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,就写到这里,请期待第二篇文章。

下一篇

Part Two:Handles, Grids, and Custom Animations

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268

推荐阅读更多精彩内容