ItemTouchHelper实现RecyclerView拖动排序和滑动删除

前言

最近在项目中有需求使用RecyclerView的滑动删除或者左滑显示删除按钮,类似QQ消息列表滑动效果一样

在网上有许多大神贡献出来的实现这种效果的项目,最近在学习自定义View,想着能不能自己倒腾出来一个了。结果没出一会儿就在网上看到Google针对RecyclerView是有提供一个专门的工具类,看了一下官网资料,看了一些网上的资料就开始搞事了=。=

ItemTouchHelper 源码介绍

按照官网介绍这就是为RecyclerView专门定制的。按照我一贯的逻辑,先进源码看看再说

首先看看其继承关系:

public class ItemTouchHelper extends RecyclerView.ItemDecoration
        implements RecyclerView.OnChildAttachStateChangeListener

我们都知道RecyclerView.ItemDecoration是用来一个用来修饰RecyclerView的子item的抽象类,也就知道它的作用是什么了。

再来看看构造方法:

/**
     * Creates an ItemTouchHelper that will work with the given Callback.
     
     * @param callback The Callback which controls the behavior of this touch helper.
     */
    public ItemTouchHelper(Callback callback) {
        mCallback = callback;
    }

需要传入一个CallBack对象,我们先来看看这个callback对象是什么东西:

public abstract static class Callback {

     ............
         //拖动
         public abstract boolean onMove(RecyclerView recyclerView,
                ViewHolder viewHolder, ViewHolder target);
         //滑动
         public abstract void onSwiped(ViewHolder viewHolder, int direction);
.........
}

一个ItemTouchHelper内部的抽象类,在下面看到源码已经提供了一个简单的实现类SimpleCallback,任然是一个抽象类,但是使用他已经足够实现我的需求了,或者自己再添加其他功能也是可以的

再往下看见一个GestureDetector的实现类:

private class ItemTouchHelperGestureListener extends GestureDetector.SimpleOnGestureListener

还有就是

private class RecoverAnimation implements AnimatorListenerCompat

这两个暂时先没有具体的研究性。看到底了,对了还没看到是如何和RecyclerView绑定的呢,往上翻翻,才注意到原来是在这里:

public void attachToRecyclerView(@Nullable RecyclerView recyclerView) {
        if (mRecyclerView == recyclerView) {
            return; // nothing to do
        }
        if (mRecyclerView != null) {
            destroyCallbacks();
        }
        mRecyclerView = recyclerView;
        if (mRecyclerView != null) {
            final Resources resources = recyclerView.getResources();
            mSwipeEscapeVelocity = resources
                    .getDimension(R.dimen.item_touch_helper_swipe_escape_velocity);
            mMaxSwipeVelocity = resources
                    .getDimension(R.dimen.item_touch_helper_swipe_escape_max_velocity);
            setupCallbacks();
        }
    }

这里先判断现有的mRecyclerView和传入的recyclerView是否是同一个,如果是同一个什么都不做,再判断mRecyclerView是否存在,不存在则销毁Callback。判断后则是将传入的recyclerView赋给mRecyclerView,然后调用setupCallbacks()方法:

private void setupCallbacks() {
        ViewConfiguration vc = ViewConfiguration.get(mRecyclerView.getContext());
        mSlop = vc.getScaledTouchSlop();
        mRecyclerView.addItemDecoration(this);
        mRecyclerView.addOnItemTouchListener(mOnItemTouchListener);
        mRecyclerView.addOnChildAttachStateChangeListener(this);
        initGestureDetector();
    }

只是对进行一些基础的初始化操作,然后调用initGestureDetector()方法创建了ItemTouchHelperGestureListener的实例

private void initGestureDetector() {
        if (mGestureDetector != null) {
            return;
        }
        mGestureDetector = new GestureDetectorCompat(mRecyclerView.getContext(),
                new ItemTouchHelperGestureListener());
    }

其他还有许多其他方法,包括移动,滑动,删除,绘制,动画等等,具体多的就不说了。看了也记不住=。=

RecyclerView拖动排序和滑动删除

说了那么多,接下来就是实战时间了。直接贴代码,相信结合代码中的注释一看就能明白了

首先是自定义的ItemTouchHelper

/**
     * dragDirs - 表示拖拽的方向,有六个类型的值:LEFT、RIGHT、START、END、UP、DOWN
       swipeDirs - 表示滑动的方向,有六个类型的值:LEFT、RIGHT、START、END、UP、DOWN
     */
    ItemTouchHelper.Callback callback=new ItemTouchHelper.SimpleCallback(ItemTouchHelper.UP|ItemTouchHelper.DOWN,ItemTouchHelper.RIGHT) {
        /**
         *
         * @param recyclerView 绑定的RecyclerView
         * @param viewHolder 需要拖动的ViewHolder
         * @param target  目标位置的ViewHolder
         * @return
         */
        @Override
        public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
            int from=viewHolder.getAdapterPosition();
            int to=target.getAdapterPosition();
            /**
             * 这里拖动的想法是往下拖动则把中间的所有item上移
             * 往下则把所有的item下移
             * 如果想实现拖动前后位置item的交换  即只需要交换两个位置的item
             */
            if (from<to){
                //中间上移
                for (int i=from;i < to;i++){
                    Collections.swap(list,i,i+1);
                }
            }else {
                for (int i=from;i>to;i--){
                    Collections.swap(list,i,i-1);
                }
            }
            adapter.notifyItemMoved(from,to);
            //return true表示执行移动
            return true;
        }

        /**
         *
         * @param viewHolder 滑动的RecyclerView
         * @param direction 滑动的方向
         */
        @Override
        public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
            int position=viewHolder.getAdapterPosition();
            list.remove(position);
            adapter.notifyItemRemoved(position);
        }

        @Override
        public void onChildDraw(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) {
            super.onChildDraw(c, recyclerView, viewHolder, dX, dY, actionState, isCurrentlyActive);
            if(actionState == ItemTouchHelper.ACTION_STATE_SWIPE) {
                //滑动时改变Item的透明度
                final float alpha = 1 - Math.abs(dX) / (float)viewHolder.itemView.getWidth();
                viewHolder.itemView.setAlpha(alpha);
                viewHolder.itemView.setTranslationX(dX);
            }
        }
    };

然后结合RecyclerView使用:

 protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.swipedelete_dragchange_recyclerview);
        ButterKnife.bind(this);
        list=new ArrayList<>();
        for (int i=0;i<50;i++){
            list.add("RecyclerView Item "+i);
        }
        adapter=new MyRecyclerViewAdapter(this,list);
        swipeDeleteDragChangeRecyclerview.setLayoutManager(new LinearLayoutManager(this));
        swipeDeleteDragChangeRecyclerview.setItemAnimator(new DefaultItemAnimator());
        swipeDeleteDragChangeRecyclerview.setHasFixedSize(true);
        ItemTouchHelper helper=new ItemTouchHelper(callback);
        helper.attachToRecyclerView(swipeDeleteDragChangeRecyclerview);
        swipeDeleteDragChangeRecyclerview.setAdapter(adapter);

    }

目前就写了这么一些,以后有深入研究或者有其他实现方法也会更新。
源码地址

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

推荐阅读更多精彩内容