RecyclerView使用（四）

作者: 辩护人 | 来源:发表于2016-12-17 16:19 被阅读263次

这篇文章会讲解RecyclerView的Item拖动排序与滑动删除。
ItemTouchHelper

This is a utility class to add swipe to dismiss and drag & drop support to RecyclerView.
ItemTouchHelper是一个支持RecyclerView的滑动删除和拖拽的工具类。也就是说我们可以通过它来简单的完成RecyclerView的Item拖动排序与滑动删除。

效果如图

拖动和滑动.gif

一、使用ItemTouchHelper.Callback

要使用ItemTouchHelper需要创建一个类继承 ItemTouchHelper.Callback 抽象类，通过这个类可以让你监听“move”与 “swipe”事件，而且还可以控制view被选中的状态以及重写默认动画的地方。如果你只是想要一个基本的实现，有一个系统封装好的可以使用：SimpleCallback。但是为了了解其工作机制，我们还是自己实现。
这是这个类需要些的全部代码

public class ItemTouchHelperCallback extends ItemTouchHelper.Callback{

    private ItemTouchHelperAdapter itemTouchHelperAdapter;//RecyclerView的适配器

    /**
     * 多参的构造方法
     * @param itemTouchHelperAdapter 需要适配器来改变数据的位置，以及通知它来刷新
     */
    public ItemTouchHelperCallback(ItemTouchHelperAdapter itemTouchHelperAdapter) {
        this.itemTouchHelperAdapter = itemTouchHelperAdapter;

    }

    /**
     * RecyclerView item支持长按进入拖动操作
     */
    @Override
    public boolean isLongPressDragEnabled() {
        return true;
    }

    /**
     * RecyclerView item任意位置触发启用滑动操作
     */
    @Override
    public boolean isItemViewSwipeEnabled() {
        return true;
    }

    /**
     * 指定可以支持的拖动和滑动的方向，上下为拖动（drag），左右为滑动（swipe）
     */
    @Override
    public int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
        //判断布局管理器是否为GridLayoutManager
        if (recyclerView.getLayoutManager() instanceof GridLayoutManager || recyclerView.getLayoutManager() instanceof StaggeredGridLayoutManager) {
            final int dragFlags = ItemTouchHelper.UP | ItemTouchHelper.DOWN | ItemTouchHelper.LEFT | ItemTouchHelper.RIGHT;
            //不需要滑动
            final int swipeFlags = 0;
            return makeMovementFlags(dragFlags, swipeFlags);
        } else {
            final int dragFlags = ItemTouchHelper.UP | ItemTouchHelper.DOWN;
            final int swipeFlags = ItemTouchHelper.START | ItemTouchHelper.END;
            return makeMovementFlags(dragFlags, swipeFlags);
        }
    }

    /**
     * 拖动操作会执行的方法
     */
    @Override
    public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
        //判断如果viewHolder类型不一样，返回False
        if (viewHolder.getItemViewType() != target.getItemViewType()) {
            return false;
        }
        //通知适配器改变数据 以及刷新
        itemTouchHelperAdapter.onItemMove(viewHolder.getAdapterPosition(), target.getAdapterPosition());
        return true;
    }

    /**
     * 滑动操作会执行的方法
     */
    @Override
    public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
        //通知适配器删除数据 以及刷新
        itemTouchHelperAdapter.onItemDismiss(viewHolder.getAdapterPosition());
    }

    /**
     * 当动作开始的时候调用
     */
    @Override
    public void onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState) {
        //动作不是空闲状态调用
        if (actionState != ItemTouchHelper.ACTION_STATE_IDLE) {
            if (viewHolder instanceof ItemTouchHelperAdapter.ItemTouchHelperViewHolder) {
                //获取执行的item的ViewHolder
                ItemTouchHelperAdapter.ItemTouchHelperViewHolder itemViewHolder = (ItemTouchHelperAdapter.ItemTouchHelperViewHolder) viewHolder;
                //选中状态回调
                itemViewHolder.onItemSelected();
            }
        }
        super.onSelectedChanged(viewHolder, actionState);
    }

    /**
     * 当动作之中的时候调用
     */
    @Override
    public void onChildDraw(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) {
        if (actionState == ItemTouchHelper.ACTION_STATE_SWIPE) {
            //自定义滑动动画（让它根据滑动的距离与itemView的宽度的比例来改变透明度）
            final float alpha = 1.0f - Math.abs(dX) / (float) viewHolder.itemView.getWidth();
            //设置透明度
            viewHolder.itemView.setAlpha(alpha);
            //设置平移动画
            viewHolder.itemView.setTranslationX(dX);
        } else {
            super.onChildDraw(c, recyclerView, viewHolder, dX, dY, actionState, isCurrentlyActive);
        }
    }

    /**
     * 当动作结束的时候调用
     */
    @Override
    public void clearView(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
        super.clearView(recyclerView, viewHolder);
        if (viewHolder instanceof ItemTouchHelperAdapter.ItemTouchHelperViewHolder) {
            //获取执行的item的ViewHolder
            ItemTouchHelperAdapter.ItemTouchHelperViewHolder itemViewHolder = (ItemTouchHelperAdapter.ItemTouchHelperViewHolder) viewHolder;
            //未选中状态回调
            itemViewHolder.onItemNormal();
        }
    }
}

继承ItemTouchHelper.Callback的抽象类之后会让你实现这三个方法

@Override
public int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) 
@Override
public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target)
@Override
public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction)

getMovementFlags在这个方法里面写通过item的移动方向来判断是拖动或滑动操作。
onMove在这个方法里面写拖动操作后的执行方法，通过适配器来改变数据位置，以及刷新
onSwiped在这个方法里面写滑动操作后的执行方法，通过适配器来删除数据位置，以及刷新

之后还需要些两个辅助动作的方法

@Override
public boolean isLongPressDragEnabled()
@Override
public boolean isItemViewSwipeEnabled()

isLongPressDragEnabled这个方法默认返回ture，支持长按进入拖动操作
isItemViewSwipeEnabled这个方法指的是在view任意位置触摸事件发生时启用滑动操作

如果写一些在有关操作的动画，复写下面三个方法

@Override
public void onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState)
@Override
public void onChildDraw(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) 
@Override
public void clearView(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder)

onSelectedChanged指的是你在开始操作（也就是说选中item）的时候希望做的对item的改变，比如说改变item的背景颜色，还可以通过参数actionState来判断什么操作
onChildDraw指的是你在操作（一般指的是滑动）途中希望做的对item的改变，比如写了一个透明度改变的动画
clearView操作结束后的做的对item的改变，让它恢复原有状态

二、需要在Adapter写的方法

全部的代码

public class ItemTouchHelperAdapter extends RecyclerView.Adapter<ItemTouchHelperAdapter.ItemTouchHelperViewHolder> {

    private ArrayList<String> list;//要显示的数据
    private Context context;//上下文
    private ImgViewTouchListener imgViewTouchListener;//需要外面实现的接口

    /*
    多参的构造方法
     */
    public ItemTouchHelperAdapter(ArrayList<String> list, Context context) {
        this.list = list;
        this.context = context;
    }

    /**
     * 创建视图
     */
    @Override
    public ItemTouchHelperViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        //创建视图
        View view = LayoutInflater.from(context).inflate(R.layout.item_touch_helper_item,parent,false);
        //实例化MainViewHolder---- 传View过去
        ItemTouchHelperViewHolder holder = new ItemTouchHelperViewHolder(view);
        return holder;
    }

    /**
     * 初始化控件
     */
    public class ItemTouchHelperViewHolder extends RecyclerView.ViewHolder{
        public TextView textView;
        public ImageView imageView;
        public ItemTouchHelperViewHolder(View itemView) {
            super(itemView);
            //初始化控件
            textView = (TextView) itemView.findViewById(R.id.text);
            imageView = (ImageView) itemView.findViewById(R.id.imgView);
        }

        /**
         * 操作开始时调用的方法
         */
        public void onItemSelected() {
            itemView.setBackgroundColor(Color.BLACK);
        }
        /**
         * 操作完成后调用的方法
         */
        public void onItemNormal() {
            itemView.setBackgroundColor(0);
        }
    }



    /**
     * 填充数据
     */
    @Override
    public void onBindViewHolder(final ItemTouchHelperViewHolder holder, int position) {
        //获取要填充的值
        String content = list.get(position);
        //控件中设置值
        holder.textView.setText(content);
        holder.imageView.setOnTouchListener(new View.OnTouchListener() {
            @Override
            public boolean onTouch(View v, MotionEvent event) {
                imgViewTouchListener.imgViewOnTouch(event,holder);
                return false;
            }
        });

    }

    /**
     * 获取item的总个数
     */
    @Override
    public int getItemCount() {
        return list.size();
    }

    /**
     * 拖动方法
     */
    public boolean onItemMove(int fromPosition, int toPosition) {
        //互换列表中指定位置的数据
        Collections.swap(list, fromPosition, toPosition);
        //通知改变
        notifyItemMoved(fromPosition, toPosition);
        return true;
    }

    /**
     * 滑动删除的方法
     */
    public void onItemDismiss(int position) {
        list.remove(position);
        notifyItemRemoved(position);
    }

    /*
    暴露出去的点击事件的方法
     */
    public void setImgViewTouchListener(ImgViewTouchListener imgViewTouchListener){
        this.imgViewTouchListener = imgViewTouchListener;
    }

    /*
    点击要实现的接口
     */
    public interface ImgViewTouchListener{
        public void imgViewOnTouch(MotionEvent event,ItemTouchHelperViewHolder holder);
    }

}

写一个拖动操作调用的方法和一个滑动删除调用的方法，在上一个类的onMove和onSwiped方法中调用。
在ViewHolder内部类写开始操作和结束操作的方法，在上一个类的onSelectedChanged和clearView方法中调用
最后我希望在按下图片才开始拖拽操作，所有需要写一个点击方法（通过上一篇文章的方式）。

三、在Activity中

//实例化ItemTouchHelper对象
final ItemTouchHelper itemTouchHelper = new ItemTouchHelper(new ItemTouchHelperCallback(adapter));
//itemTouchHelper与RecyclerView关联
itemTouchHelper.attachToRecyclerView(rcTouch);
//设置ImgView的触摸监听事件
adapter.setImgViewTouchListener(new ItemTouchHelperAdapter.ImgViewTouchListener() {
    @Override
    public void imgViewOnTouch(MotionEvent event, ItemTouchHelperAdapter.ItemTouchHelperViewHolder holder) {
        //判断是否按下图片
        if (MotionEventCompat.getActionMasked(event) == MotionEvent.ACTION_DOWN) {
            //按下则开始拖动
            itemTouchHelper.startDrag(holder);
        }
    }
});

首先实例化一个ItemTouchHelper类，并且在参数之前写的ItemTouchHelperCallback类的对象
然后将其与RecyclerView关联
设置ImgView的触摸监听，在里面通过ItemTouchHelper类来调用开始拖动的方法

RecyclerView的系列的文章

第一篇RecyclerView的基本使用 RecyclerView使用（一）
第二篇有关多种Item,添加，删除 RecyclerView使用（二）
第三篇RecyclerView的监听方法RecyclerView使用（三）
第四篇RecyclerView的拖动和滑动删除RecyclerView使用（四）

RecyclerView使用（四）

一、使用ItemTouchHelper.Callback

二、需要在Adapter写的方法

三、在Activity中

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

安卓进阶

Android技术知识

Android开发

Android知识