Skip to content

前言

使用开源库实现侧滑列表

本库是基于RecyclerView的封装,提供了Item侧滑菜单、Item滑动删除、Item长按拖拽、添加HeaderView/FooterView、加载更多、Item点击监听等基本功能。

https://github.com/yanzhenjie/SwipeRecyclerView

加入依赖

groovy
implementation 'com.yanzhenjie.recyclerview:x:1.3.2'

布局设计

可以看到这个库里不止有SwipeRecyclerView,一共有如下三个控件,今天主要学习SwipeRecyclerView

  • SwipeMenuLayout
  • SwipeMenuView
  • SwipeRecyclerView

image.png

创建item子项布局

简单的创建一个高度只有80dp的约束布局,其中设置一个文本控件,等会用来填充数据区分不同的子项。 image.png

xml
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="80dp">
    <TextView
        android:id="@+id/textView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:textSize="30sp"
        android:layout_marginStart="84dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />
</androidx.constraintlayout.widget.ConstraintLayout>

创建适配器

创建适配器,构造数据并填充,这个与官方的RecyclerView的使用也没有什么区别,只不过是改为继承SwipeRecyclerView.Adapter<>SwipeRecyclerView.ViewHolder,要实现的方法与继承RecyclerView.Adapter<>RecyclerView.ViewHolder一样,如果你之前会RecyclerView,那么到这里对你来说肯定都没有什么难度。

java

public class MainActivity extends AppCompatActivity {
    List list=new ArrayList();
    private MyAdapter adapter;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //构造10个数据
        for(int i=0;i<10;++i){
            list.add(i);
        }
        SwipeRecyclerView swipeRecyclerView = findViewById(R.id.recycler_view);//获取列表控件
        swipeRecyclerView.addItemDecoration(new DefaultItemDecoration(Color.BLACK));//分割线
        adapter=new MyAdapter();//创建适配器
        swipeRecyclerView.setAdapter(adapter);//设置适配器
        swipeRecyclerView.setLayoutManager(new LinearLayoutManager(this));//设置布局
    }
    public class MyAdapter extends SwipeRecyclerView.Adapter<MyViewHolder>{
        @NonNull
        @Override
        public MyViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
            View view=LayoutInflater.from(MainActivity.this).inflate(R.layout.item_swiperecyclerview,parent,false);
            MyViewHolder myViewHolder=new MyViewHolder(view);
            return myViewHolder;
        }

        @Override
        public void onBindViewHolder(@NonNull MyViewHolder holder, int position) {
            holder.textView.setText("文本"+list.get(position));
        }

        @Override
        public int getItemCount() {
            return list.size();
        }
    }
    public class MyViewHolder extends SwipeRecyclerView.ViewHolder{

        TextView textView;
        public MyViewHolder(@NonNull View itemView) {
            super(itemView);
            textView=itemView.findViewById(R.id.textView);
        }
    }
}

此时运行的效果如下: image.png

创建菜单创建类

实现侧滑菜单,其实很简单,只需要在我们之前所学的基础上加上如下两个匿名内部类即可:

  1. 菜单的创建类
  2. 菜单子项的事件监听类

那么首先我们来为SwipeRecyclerView来设置菜单创建类 SwipeMenuCreator类需要实现一个方法,它有三个参数,主要用到的是前两个参数分别是左菜单,右菜单。

java
public void onCreateMenu(SwipeMenu leftMenu, SwipeMenu rightMenu, int position)

既然有了菜单,那么我们需要创建菜单子项啊,通过new SwipeMenuItem就可以创建菜单子项,并设置菜单子项的一些类属性 可以设置背景图片啊,颜色啊,文字啊,文字颜色啊,以及菜单子项的宽高等等。 image.png 创建好菜单子项后,子需要通过add方法,将子项添加到菜单中就好了。 注意:这里的菜单高度一般设置为RecyclerView子项item的高度,也就是平时在xml中使用的MATCH_PARENT,我们可以通过 ViewGroup.LayoutParams.MATCH_PARENT;来获取到这个属性。WRAP_CONTENT属性也是如此。 image.png 这里我就是将一个置顶按钮和删除按钮添加在了右侧菜单中。

java
// 设置菜单创建器。
swipeRecyclerView.setSwipeMenuCreator(new SwipeMenuCreator() {
      @Override
      public void onCreateMenu(SwipeMenu leftMenu, SwipeMenu rightMenu, int position) {
          int width = 100;
          int height = ViewGroup.LayoutParams.MATCH_PARENT;
          SwipeMenuItem upItem = new SwipeMenuItem(MainActivity.this)
                  .setBackgroundColor(Color.BLACK)
                  .setText("置顶")
                  .setTextColor(Color.WHITE)
                  .setWidth(width)
                  .setHeight(height);
          SwipeMenuItem deleteItem = new SwipeMenuItem(MainActivity.this)
                  .setBackgroundColor(Color.BLUE)
                  .setText("删除")
                  .setTextColor(Color.BLACK)
                  .setWidth(width)
                  .setHeight(height);
          rightMenu.addMenuItem(deleteItem);// 添加一个按钮到右侧侧菜单。.
          rightMenu.addMenuItem(upItem); //添加一个按钮到右侧侧菜单。.
      }
  });

创建菜单子项的事件监听类

实现菜单子项的事件监听,也只需要实现一个匿名内部类即可。 OnItemMenuClickListener类也只需要实现一个方法onItemClick,顾名思义就是子项的点击监听。这个方法有两个参数,前者是菜单桥menuBridge,查看SwipeMenuBridge类的实现可以看到它有3个属性。 我们主要关注两个即可,那就是菜单的方向mDirection和子项的索引mPosition,通过这两个属性就可以确定点击的是左菜单还是右菜单的哪一个子项了。 image.png 通过选择条件判断,在其中实现点击之后要处理的逻辑即可。 Snipaste_2022-12-24_13-12-01.png

java
swipeRecyclerView.setOnItemMenuClickListener(new OnItemMenuClickListener() {
    @Override
    public void onItemClick(SwipeMenuBridge menuBridge, int adapterPosition) {
        // 任何操作必须先关闭菜单,否则可能出现Item菜单打开状态错乱。
        menuBridge.closeMenu();
        // 左侧还是右侧菜单:
        int direction = menuBridge.getDirection();
        // 菜单在Item中的Position:
        int menuPosition = menuBridge.getPosition();
        if (direction == SwipeRecyclerView.LEFT_DIRECTION) {
            switch (menuPosition) {
                case 0:
                    Toast.makeText(MainActivity.this, "左侧第一个", Toast.LENGTH_SHORT).show();
                    break;
                case 1:
                    Toast.makeText(MainActivity.this, "左侧第2个", Toast.LENGTH_SHORT).show();
                    break;
                default:
                    Toast.makeText(MainActivity.this, "默认", Toast.LENGTH_SHORT).show();
                    break;
            }
        } else if (direction == SwipeRecyclerView.RIGHT_DIRECTION) {
            switch (menuPosition) {
                case 0: {
                    Toast.makeText(MainActivity.this, "置顶", Toast.LENGTH_SHORT).show();
                    list.add(0,list.get(adapterPosition));
                    list.remove(adapterPosition+1);
                    adapter.notifyDataSetChanged();
                }
                break;
                case 1: {
                    Toast.makeText(MainActivity.this, "删除", Toast.LENGTH_SHORT).show();
                    list.remove(adapterPosition);
                    adapter.notifyDataSetChanged();
                }break;
                default:
                    Toast.makeText(MainActivity.this, "默认", Toast.LENGTH_SHORT).show();
                    break;
            }
        }
    }
});

最终效果

1.gif