Android 高级UI3 RecyclerView使用ItemTouchHelper实现拖拽和侧滑删除并解析源码

最新推荐文章于 2024-02-01 11:19:32 发布

pureChilder

最新推荐文章于 2024-02-01 11:19:32 发布

阅读量961

点赞数 1

CC 4.0 BY-SA版权

分类专栏： Android java 文章标签： android java android studio

本文链接：https://blog.csdn.net/pureChilder/article/details/107712451

实现拖拽和侧滑之前我门需要先了解一个recyclerview的辅助类ItemTouchHelper

ItemTouchHelper是一个工具类，可实现侧滑删除和拖拽移动，使用这个工具类需要RecyclerView和Callback。同时根据需要重写onMove和onSwiped方法。接下来就来讲述ItemTouchHelper的使用方法。

ItemTouchHelper 常用的函数列出如下：

    /**
     * 针对swipe和drag状态，设置不同状态(swipe、drag)下支持的方向
     * (LEFT, RIGHT, START, END, UP, DOWN)
     * idle:0~7位表示swipe和drag的方向
     * swipe:8~15位表示滑动方向
     * drag:16~23位表示拖动方向
     */
    public abstract int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder);


    /**
     * 针对swipe和drag状态，当swipe或者drag对应的ViewHolder改变的时候调用
     * 我们可以通过重写这个函数获取到swipe、drag开始和结束时机，viewHolder 不为空的时候是开始，空的时候是结束
     */
    public void onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState) {
        super.onSelectedChanged(viewHolder, actionState);
    }

    /**
     * 针对swipe状态，是否允许swipe(滑动)操作
     */
    public boolean isItemViewSwipeEnabled() {
        return true;
    }

    /**
     * 针对swipe状态，swipe滑动的位置超过了百分之多少就消失
     */
    public float getSwipeThreshold(RecyclerView.ViewHolder viewHolder) {
        return .5f;
    }

    /**
     * 针对swipe状态，swipe的逃逸速度，换句话说就算没达到getSwipeThreshold设置的距离，达到了这个逃逸速度item也会被swipe消失掉
     */
    public float getSwipeEscapeVelocity(float defaultValue) {
        return defaultValue;
    }

    /**
     * 针对swipe状态，swipe滑动的阻尼系数,设置最大滑动速度
     */
    public float getSwipeVelocityThreshold(float defaultValue) {
        return defaultValue;
    }

    /**
     * 针对swipe状态，swipe 到达滑动消失的距离回调函数,一般在这个函数里面处理删除item的逻辑
     * 确切的来讲是swipe item滑出屏幕动画结束的时候调用
     */
    public abstract void onSwiped(RecyclerView.ViewHolder viewHolder, int direction);

    /**
     * 针对drag状态,当item长按的时候是否允许进入drag(拖动)状态
     */
    public boolean isLongPressDragEnabled() {
        return true;
    }

    /**
     * 针对drag状态，当前target对应的item是否允许move
     * 换句话说我们一般用drag来做一些换位置的操作，就是当前target对应的item是否可以换位置
     */
    public boolean canDropOver(RecyclerView recyclerView, RecyclerView.ViewHolder current, RecyclerView.ViewHolder target) {
        return true;
    }

    /**
     * 针对drag状态，在canDropOver()函数返回true的情况下，会调用该函数让我们去处理拖动换位置的逻辑(需要重写自己处理变换位置的逻辑)
     * 如果有位置变换返回true，否则发挥false
     */
    public abstract boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target);

    /**
     * 针对drag状态，当drag itemView和底下的itemView重叠的时候,可以给drag itemView设置额外的margin，让重叠更加容易发生。
     * 相当于增大了drag itemView的区域
     */
    public int getBoundingBoxMargin() {
        return 0;
    }

    /**
     * 针对drag状态，滑动超过百分之多少的距离可以可以调用onMove()函数(注意哦，这里指的是onMove()函数的调用，并不是随手指移动的那个view哦)
     */
    public float getMoveThreshold(RecyclerView.ViewHolder viewHolder) {
        return .5f;
    }

    /**
     * 针对drag状态，在drag的过程中获取drag itemView底下对应的ViewHolder(一般不用我们处理直接super就好了)
     */
    public RecyclerView.ViewHolder chooseDropTarget(RecyclerView.ViewHolder selected,
                                                    List<RecyclerView.ViewHolder> dropTargets,
                                                    int curX,
                                                    int curY) {
        return super.chooseDropTarget(selected, dropTargets, curX, curY);
    }

    /**
     * 当onMove return true的时候调用(一般不用我们自己处理，直接super就好)
     */
    public void onMoved(final RecyclerView recyclerView,
                        final RecyclerView.ViewHolder viewHolder,
                        int fromPos,
                        final RecyclerView.ViewHolder target,
                        int toPos,
                        int x,
                        int y) {
        super.onMoved(recyclerView, viewHolder, fromPos, target, toPos, x, y);
    }

    /**
     * 针对swipe和drag状态，当一个item view在swipe、drag状态结束的时候调用
     * drag状态：当手指释放的时候会调用
     * swipe状态：当item从RecyclerView中删除的时候调用，一般我们会在onSwiped()函数里面删除掉指定的item view
     */
    public void clearView(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
    }

    /**
     * 针对swipe和drag状态，整个过程中一直会调用这个函数,随手指移动的view就是在super里面做到的(和ItemDecoration里面的onDraw()函数对应)
     */
    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);
    }

    /**
     * 针对swipe和drag状态，整个过程中一直会调用这个函数(和ItemDecoration里面的onDrawOver()函数对应)
     * 这个函数提供给我们可以在RecyclerView的上面再绘制一层东西，比如绘制一层蒙层啥的
     */
    public void onChildDrawOver(Canvas c,
                                RecyclerView recyclerView,
                                RecyclerView.ViewHolder viewHolder,
                                float dX,
                                float dY,
                                int actionState,
                                boolean isCurrentlyActive) {
        super.onChildDrawOver(c, recyclerView, viewHolder, dX, dY, actionState, isCurrentlyActive);
    }

    /**
     * 针对swipe和drag状态，当手指离开之后，view回到指定位置动画的持续时间(swipe可能是回到原位，也有可能是swipe掉)
     */
    public long getAnimationDuration(RecyclerView recyclerView, int animationType, float animateDx, float animateDy) {
        return super.getAnimationDuration(recyclerView, animationType, animateDx, animateDy);
    }

    /**
     * 针对drag状态，当itemView滑动到RecyclerView边界的时候(比如下面边界的时候),RecyclerView会scroll，
     * 同时会调用该函数去获取scroller距离(不用我们处理 直接super)
     */
    public int interpolateOutOfBoundsScroll(RecyclerView recyclerView,
                                            int viewSize,
                                            int viewSizeOutOfBounds,
                                            int totalSize,
                                            long msSinceStartScroll) {
        return super.interpolateOutOfBoundsScroll(recyclerView, viewSize, viewSizeOutOfBounds, totalSize, msSinceStartScroll);
    }

下面的代码是继承了ItemTouchHelper.Callback 实现一些基本的业务操作数据交换等等

public class SwapCallBack extends ItemTouchHelper.Callback {
    private List<ImgBean> datas;
    private RecyclerView.Adapter adapter;
    private Context mContext;

    public SwapCallBack(List<ImgBean> datas, RecyclerView.Adapter adapter, Context mContext) {
        this.datas = datas;
        this.adapter = adapter;
        this.mContext = mContext;
    }

    @Override
    public int getMovementFlags(@NonNull RecyclerView recyclerView, @NonNull RecyclerView.ViewHolder viewHolder) {
        int dragFrlg = 0;
        if (recyclerView.getLayoutManager() instanceof GridLayoutManager){
            dragFrlg = ItemTouchHelper.UP | ItemTouchHelper.DOWN | ItemTouchHelper.LEFT | ItemTouchHelper.RIGHT;
        }else {
            dragFrlg = ItemTouchHelper.UP | ItemTouchHelper.DOWN;
        }
        return makeMovementFlags(dragFrlg,0);
    }

    @Override
    public boolean onMove(@NonNull RecyclerView recyclerView, @NonNull RecyclerView.ViewHolder viewHolder, @NonNull RecyclerView.ViewHolder target) {
        //滑动事件 下面注释的代码，滑动后数据和条目错乱，被舍弃
//        Collections.swap(datas,viewHolde