EasyXRecyclerView库基于RecyclerView的终极封装(二)

周游 / 文 发表于2018-05-04 16:43 次阅读 adapter,recyclerview

github源码地址:https://github.com/zhou-you/EasyXRecyclerView

XRecyclerView使用介绍

XRecyclerView基于RecyclerView的封装,在原有功能的基础上支持刷新、加载更多、自定义刷新加载更多、添加头部、尾部等

添加(单个/多个)HeaderViw、FooterView

可以添加单个或者多个普通HeaderViw、FooterView,支持内容为LinearLayoutManager和GridLayoutManager。 方式一:

//添加一个头部view
mRecyclerView.addHeaderView(new SampleHeader(this));
//mRecyclerView.addHeaderView(new SampleHeader2(this));//添加第二个头部view
....
//mRecyclerView.addHeaderView(new SampleHeaderN(this));//添加第n个头部view(多头部)

//添加一个尾部view
mRecyclerView.addFooterView(new SampleFooter(this));
//mRecyclerView.addFooterView(new SampleFooter2(this));//添加第二个尾部view
....
//mRecyclerView.addFooterView(new SampleFooterN(this));//添加第n个尾部view(多尾部)

方式二:

//添加一个头部view
View headerView =   LayoutInflater.from(this).inflate(R.layout.layout_header, (ViewGroup)findViewById(android.R.id.content),false);
mRecyclerView.addHeaderView(headerView);
//mRecyclerView.addHeaderView(headerView2);//添加第二个头部view
...
//mRecyclerView.addHeaderView(headerViewN);//添加第n个头部view(多头部)
//点击事件
headerView.findViewById(R.id.test_txt).setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        ...
    }
});

//添加一个尾部view
View footerView = getLayoutInflater().inflate(R.layout.layout_footer, (ViewGroup) mRecyclerView.getParent(), false);
mRecyclerView.addFooterView(footerView);
//mRecyclerView.addFooterView(footerView2);//添加第二个尾部view
....
//mRecyclerView.addFooterView(footerViewN);//添加第n个尾部view(多尾部)

//点击事件
footerView.findViewById(R.id.test_txt).setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        ...
    }
});

注:此功能只是添加普通的头部和尾部,与刷新和加载更多的头部和尾部是不一样的,切记!不会影响刷新头和加载更多尾部的显示问题

移除HeaderViw、FooterView

//移除添加的头部view
mRecyclerView.removeHeaderView(headerView);
//移除添加的尾部view
mRecyclerView.removeFooterView(footerView);

下拉刷新和加载更多样式

//设置下拉刷新Progress的样式
mRecyclerView.setRefreshProgressStyle(ProgressStyle.BallSpinFadeLoader); //在ProgressStyle里面选择喜欢的样式
//设置下拉刷新箭头
mRecyclerView.setArrowImageView(R.drawable.iconfont_downgrey);
//设置加载更多Progress的样式
mRecyclerView.setLoadingMoreProgressStyle(ProgressStyle.BallPulse);

注:1.如果采用自定义下拉刷新setRefreshHeader()和加载更多setLoadingMoreFoote(),以上设置会不起作用,也无须设置。

开启和禁止下拉刷新、加载更多功能

//打开刷新和加载更多
mRecyclerView.setPullRefreshEnabled(true);
mRecyclerView.setLoadingMoreEnabled(true);

注:默认是开启。

设置底部加载文字提示

mRecyclerView.setFootViewText("拼命加载中","已经全部");

注:自定义加载更多View时,此设置不起作用,切记!

下拉刷新完成

 mRecyclerView.refreshComplete();

上拉加载更多完成

 mRecyclerView.loadMoreComplete();

数据加载完成

 mRecyclerView.setNoMore(true);

开启进入页面自动刷新

mRecyclerView.setRefreshing(true);//没有更多数据

例:在Acitvity中开启进入页面自动刷新,在onStart()中处理。

@Override
protected void onStart() {
    super.onStart();
    if(mRecyclerView !=null){
        mRecyclerView.setRefreshing(true);
    }
}

自定义下拉刷新View

  1. 自定义view继承BaseRefreshHeader;
  2. 调用setRefreshHeader(IRefreshHeader refreshHeader)即可。
 mRecyclerView.setRefreshHeader(new CustomRefreshHeader(this));

示例:

public class CustomRefreshHeader extends BaseRefreshHeader {
    private CustomAnimView mCustomAnimView;
    public CustomRefreshHeader2(Context context) {
        super(context);
    }

    public CustomRefreshHeader2(Context context, AttributeSet attrs) {
        super(context, attrs);
    }

    @Override
    public View getView() {
        //方式一  
        mCustomAnimView = new CustomAnimView(getContext());
        return  mCustomAnimView;
        //方式二
        //return LayoutInflater.from(getContext()).inflate(R.layout.clife_loading_header,null);
    }

    //根据状态改变View
    @Override
    public void setState(int state) {
        super.setState(state);
        //选择自定义需要处理的状态:STATE_NORMAL、STATE_RELEASE_TO_REFRESH、STATE_REFRESHING、STATE_DONE
        //以下是我自定义动画需要用到的状态判断,你可以根据自己需求选择。
        if (state == STATE_REFRESHING) {    // 显示进度
            //这里处理自己的逻辑、刷新中
            mCustomAnimView.startAnim();
        } else if (state == STATE_DONE) {
            //这里处理自己的逻辑、刷新完成
            mCustomAnimView.stopAnim();
        } else {
            mCustomAnimView.startAnim();
        }
    }

   /* @Override
    public void refreshComplete() {
        //有默认处理、可以覆盖该方法处理,刷新完成的动作
    }*/

    /*@Override
    public void smoothScrollTo(int destHeight) {
        //super.smoothScrollTo(destHeight);
        //有默认处理、可以覆盖该方法处理,顺滑改变高度
    }*/

    //更多方法,可以通过覆写实现,自定义
}

注:如果设置了自定义下拉刷新,setRefreshProgressStyle()会不起作用,无需配置,要么采用库里默认支持的样式设置,要么采用自定义View。

自定义加载更多View

  1. 自定义view实现BaseMoreFooter接口;
  2. 调用setLoadingMoreFooter(IMoreFooter refreshHeader)即可。
 mRecyclerView.setLoadingMoreFooter(new CustomMoreFooter(this));

示例:

public class CustomMoreFooter extends BaseMoreFooter {
    private AnimationDrawable mAnimationDrawable;
    private LinearLayout allLayout;
    private TextView mTextView;

    public CustomMoreFooter(Context context) {
        super(context);
    }

    public CustomMoreFooter(Context context, AttributeSet attrs) {
        super(context, attrs);
    }

    @Override
    protected void initView() {
        super.initView();//有居中显示功能,如果不需要就去掉super.initView();
        allLayout = (LinearLayout) LayoutInflater.from(getContext()).inflate(R.layout.pull_to_refresh_clife, null);
        ImageView imageView = (ImageView) allLayout.findViewById(R.id.lodimg);
        imageView.setImageResource(R.drawable.icon_loading_animation);
        mAnimationDrawable = (AnimationDrawable) imageView.getDrawable();
        mTextView = (TextView) allLayout.findViewById(R.id.lodtext);
        addView(allLayout);
    }

    @Override
    public void setState(int state) {
        super.setState(state);
        //以下是我自定义动画需要用到的状态判断,你可以根据自己需求选择。
        //选择自定义需要处理的状态:STATE_LOADING、STATE_COMPLETE、STATE_NOMORE、STATE_NOMORE
        switch (state) {
            case STATE_LOADING:
                this.setVisibility(View.VISIBLE);
                mAnimationDrawable.start();
                mTextView.setText("努力加载中...");
                mTextView.setVisibility(VISIBLE);
                break;
            case STATE_COMPLETE:
                this.setVisibility(View.GONE);
                mAnimationDrawable.stop();
                mTextView.setText("加载完成");
                break;
            case STATE_NOMORE:
                mAnimationDrawable.stop();
                mTextView.setText("没有更多");
                this.setVisibility(View.GONE);
                break;
        }
    }
}

注:如果设置了自定义下拉刷新,setRefreshProgressStyle()会不起作用,无需配置,要么采用库里默认支持的样式设置,要么采用自定义View。

滑动和加载更多事件监听

mRecyclerView.setLoadingListener(new XRecyclerView.LoadingListener() {
    @Override
    public void onRefresh() {
        //下拉刷新
        ...
    }

    @Override
    public void onLoadMore() {
        //加载更多
        ...
    }
});

设置分割线

分割线可以采用库中提供的自定义万能分割线HorizontalDividerItemDecoration和XHorizontalDividerItemDecoration,这里只做使用介绍,详细请看demo中关于分割线的示例。

//例1
recyclerView.addItemDecoration(new HorizontalDividerItemDecoration.Builder(this).build());
//例2
recyclerView.addItemDecoration(new HorizontalDividerItemDecoration.Builder(this)
        .paint(paint)
        .margin(15)
        .showLastDivider()
        .build());
//例3 
recyclerView.addItemDecoration(new com.zhouyou.recyclerview.divider.HorizontalDividerItemDecoration.Builder(this)
        //.drawable(R.drawable.divider_sample)//.9图
        .drawable(R.drawable.divider_shape)//shape文件
        .size(10)
        .build());
//例4
Paint paint = new Paint();
        paint.setStrokeWidth(5);
        paint.setColor(Color.BLUE);
        paint.setAntiAlias(true);
        paint.setPathEffect(new DashPathEffect(new float[]{15.0f, 15.0f}, 0));
recyclerView.addItemDecoration(new HorizontalDividerItemDecoration.Builder(this)
                .paint(paint)
                .margin(15)
                .startSkipCount(2)
                .endSkipCount(2)
                .build());
.....
//更多请看分割线讲解

注:此分割线主要是针对LinearLayoutManager使用,对GridLayoutManager和StaggeredGridAdapter支持性比较差,针对这一类的分割线还需要自定义实现。

设置侧滑菜单

设置侧滑菜单需要用到自定义SwipeMenuRecyclerView,此view是继承自XRecyclerView,具备XRecyclerView的所有功能和属性。 1.Xml布局引用SwipeMenuRecyclerView

 <com.zhouyou.recyclerview.swipemenu.SwipeMenuRecyclerView
        android:id="@+id/super_swipemenu_recycle_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

2.侧滑菜单对适配器没有特殊要求可以继承任意Adapter,但是对item的布局文件有要求,需要用SwipeMenuLayout。 例如:adapter_menu_layout_item.xml

<?xml version="1.0" encoding="utf-8"?>
<!--布局外层必须用SwipeMenuLayout-->
<com.zhouyou.recyclerview.swipemenu.SwipeMenuLayout xmlns:android="http://schemas.android.com/apk/res/android"
                                                    android:layout_width="match_parent"
                                                    android:layout_height="wrap_content">
    <!--内容布局id必须用smContentView,不能自定义id名称,否则找不到-->
    <include
        android:id="@+id/smContentView"
        layout="@layout/item_swipe_menu_content" />
    <!--菜单布局id必须用smMenuView,不能自定义id名称,否则找不到-->
    <include
        android:id="@+id/smMenuView"
        layout="@layout/item_swipe_menu1" />

</com.zhouyou.recyclerview.swipemenu.SwipeMenuLayout>

注:其它关于SwipeMenuLayout更多使用方法,请参考demo示例。

设置sticky悬停

主要提供了两种悬停效果:一种是鸿洋大神的StickyNavLayout,另一种是用StickyNestedScrollView(继承自V4包NestedScrollView进行扩展)。为什么会把这两种悬停效果放到库中处理呢,因为XRecyclerView、StickyNavLayout/StickyNestedScrollView、Tablayout、ViewPager、HelperRecyclerViewAdapter等相互组合使用会存在冲突等问题,本库中都已经解决了存在的已知兼容问题,互相打通,另一方面也是收集常用功能对EasyXRecyclerView的完善。 StickyNavLayout使用介绍:

可以设置页面某个控件滑动悬停,底部内容区域支持 ScrollView ,ListView,RecyclerView。 注意控件id的设置

  • top区域:id必须为 android:id="@+id/id_stickynavlayout_topview"
  • 悬浮区域:id必须为android:id="@+id/id_stickynavlayout_indicator"
  • 内容区域:id必须为android:id="@+id/id_stickynavlayout_viewpager"

内容区域

  • 此方式内容区域必须需为ViewPager或者其子类
  • ViewPager的内容可以是Fragment,如果Fragment里面是ListView,RecycleView等需要设置其id为:android:id="@+id/id_stickynavlayout_innerscrollview"

在xml中引入:

<?xml version="1.0" encoding="utf-8"?>
<com.zhouyou.recyclerview.sticky.StickyNavLayout
    android:id="@+id/id_stick"
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    app:isStickNav="false">
    <!--头部布局 id必须设置为:id_stickynavlayout_topview-->
    <LinearLayout
        android:id="@id/id_stickynavlayout_topview"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical">
        <!--写头部区域内容-->
        ...
    </LinearLayout>

    <!--需要悬停内容的布局 id必须设置为:id_stickynavlayout_indicator-->
    <LinearLayout
        android:id="@id/id_stickynavlayout_indicator"
          ...
        >
        <!--写悬停部区域内容-->
        ...
    </LinearLayout>
    <!--底部内容区域布局,ViewPager id必须设置为:id_stickynavlayout_viewpager-->
    <!--如果Viewpager里面装载的内容为ListView,RecycleView、XRecycleView等需要设置其id为id_stickynavlayout_innerscrollview-->
    <android.support.v4.view.ViewPager
        android:id="@id/id_stickynavlayout_viewpager"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        />
</com.zhouyou.recyclerview.sticky.StickyNavLayout>

注:更多使用功能请参考鸿洋大神的讲解。 StickyNestedScrollView使用介绍:

StickyNestedScrollView方式使用比较简单,可以支持设置多个悬停。只需要在需要悬停的控件上设置tag属性,tag属性可以设置为:sticky、sticky-nonconstant、sticky-hastransparency,一般直接使用android:tag="sticky"。 在xml中引入:

<?xml version="1.0" encoding="utf-8"?>
<android.support.design.widget.CoordinatorLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:fitsSystemWindows="true">
    <com.zhouyou.recyclerview.sticky.StickyNestedScrollView
        android:id="@+id/scroll_view"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_behavior="@string/appbar_scrolling_view_behavior">

        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:orientation="vertical">

            <!--只要将需要悬停的控件设置tag为:sticky就可以悬停-->
            <TextView
                 ...
                android:tag="sticky"
                android:text="A"/>
            <!--B没有设置tag就不会悬停-->
            <TextView
            ...
            android:text="B"/>
            <!--C设置tag就会和A一样可以悬停-->
            <TextView
            ...
            android:tag="sticky"
            android:text="B"/>

        </LinearLayout>
    </com.zhouyou.recyclerview.sticky.StickyNestedScrollView>
</android.support.design.widget.CoordinatorLayout>

StickyNestedScrollView支持的方法addOnViewStickyListener(OnViewStickyListener stickyListener)、removeOnViewStickyListener(OnViewStickyListener stickyListener)、clearOnViewStickyListener()、setShadowHeight(int height)、setShadowDrawable(Drawable shadowDrawable)。如果XRecyclerview适配器中的某个item需要悬停,只需要将item布局设置android:tag="sticky"即可实现item悬停,但是这样会有一个问题,如果在xml中静态设置所有的item都会有悬停,可以在设配器中获取到item布局对象根据业务逻辑进行动态设置view.setTag("sticky");

StickyNavLayout与StickyNestedScrollView对比

  1. StickyNavLayout使用起来相对于StickyNestedScrollView比较麻烦,特别是要注意Id的设置,StickyNestedScrollView使用更加便捷一些。
  2. StickyNavLayout支持单个悬停,StickyNestedScrollView支持多个悬停。
  3. StickyNestedScrollView不适合与带有刷新和加载更多的Recyclerview嵌套,嵌套后Recyclerview的加载更多会失效,而StickyNavLayout不会影响加载跟多功能。
  4. 如果内容比较多建议采用StickyNavLayout+Recyclerview来实现分页带有头部的列表悬停功能,StickyNestedScrollView+Recyclerview不能装载太多的数据特别是用于分页。因为StickyNestedScrollView原理是把Recyclerview的滑动事件都转移给自己来处理,这样Recyclerview的复用机制就会不起作用,数据过多容易OOM.单页面且数据量不多可以采用StickyNestedScrollView更简单。

注:其它更多复杂的悬停使用场景请参考demo中关于Sticky部分的示例。

完整示例

所有的属性设置,都是根据自己的需要进行设置,不需要把所有属性都设置一遍,切记!切记!切记!

XRecyclerView mRecyclerView = (com.zhouyou.recyclerview.XRecyclerView) this.findViewById(R.id.recyclerview);
LinearLayoutManager layoutManager = new LinearLayoutManager(this);
layoutManager.setAutoMeasureEnabled(true);
layoutManager.setOrientation(LinearLayoutManager.VERTICAL);
mRecyclerView.setLayoutManager(layoutManager);

//刷新方式二选一:方式一or方式二 
//方式一:采用库中提供的默认刷新样式
mRecyclerView.setRefreshProgressStyle(ProgressStyle.BallSpinFadeLoader); //设置下拉刷新Progress的样式,在ProgressStyle里面选择喜欢的样式
mRecyclerView.setArrowImageView(R.drawable.iconfont_downgrey);//设置下拉刷新箭头
mRecyclerView.setLoadingMoreProgressStyle(ProgressStyle.BallPulse);  //设置加载更多Progress的样式
mRecyclerView.setFootViewText("拼命加载中","已经全部");

//方式二:完全采用自定义的刷新动画
//mRecyclerView.setRefreshHeader(new CustomRefreshHeader(this));
//mRecyclerView.setLoadingMoreFooter(new CustomLoadingMoreFooter(this));

//打开刷新和加载更多
//mRecyclerView.setPullRefreshEnabled(true);
//mRecyclerView.setLoadingMoreEnabled(true);

//添加一个头部view和尾部view
View headerView =   LayoutInflater.from(this).inflate(R.layout.layout_header, (ViewGroup)findViewById(android.R.id.content),false);
View footerView = getLayoutInflater().inflate(R.layout.layout_footer, (ViewGroup) mRecyclerView.getParent(), false);
mRecyclerView.addHeaderView(headerView);
mRecyclerView.addFooterView(footerView);

//分割线设置
mRecyclerView.addItemDecoration(new HorizontalDividerItemDecoration.Builder(this).build());

//移除添加的头部view
mRecyclerView.removeHeaderView(headerView);
//移除添加的尾部view
mRecyclerView.removeFooterView(footerView);
mRecyclerView.setLoadingListener(new XRecyclerView.LoadingListener() {
    @Override
    public void onRefresh() {
        //下拉刷新
        //mRecyclerView.refreshComplete();//刷新动画完成
    }

    @Override
    public void onLoadMore() {
        //加载更多
        //mRecyclerView.loadMoreComplete();//加载动画完成
        //mRecyclerView.setNoMore(true);//数据加载完成
    }
});

//装载数据
MyAdapter mAdapter = new MyAdapter(this);
mRecyclerView.setAdapter(mAdapter);//本库不成文规定,最好使用setAdapter写在装载数据之前
mAdapter.setListAll(datas);//该动作放在setAdapter之后
收藏 赞 (0) 踩 (0)