# RecyclerViewAdapter
**Repository Path**: vanish136_admin/RecyclerViewAdapter
## Basic Information
- **Project Name**: RecyclerViewAdapter
- **Description**: Android RecyclerView 通用适配器，支持多ViewType，嵌套Section，可添加HeaderView、FooterView、EmptyView，底部自动加载更多，自定义Item动画
- **Primary Language**: Android
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 34
- **Forks**: 14
- **Created**: 2017-04-26
- **Last Updated**: 2024-11-26
## Categories & Tags
**Categories**: android-modules
**Tags**: None
## README
# RecyclerViewAdapter
【不再维护，如有bug、需求，请自行clone源码修改】
想了解该框架的可参考以下博客说明：
CSDN：http://blog.csdn.net/lwk520136/article/details/70787798
简书：http://www.jianshu.com/p/c86a39f4e811
### 引用方式
【最新版本号以[这里](https://github.com/Vanish136/RecyclerViewAdapter/releases)为准】
**由于JCenter关闭服务，从1.4.5版本开始改为发布到MavenCentral，引用方式有更新！！！**
**由于JCenter关闭服务，从1.4.5版本开始改为发布到MavenCentral，引用方式有更新！！！**
**由于JCenter关闭服务，从1.4.5版本开始改为发布到MavenCentral，引用方式有更新！！！**
```
#last-version请查看上面的最新版本号
#只支持AndroidX
#从1.4.5版本开始GroupId、ArtifactId均有更新，请按如下方式引用
implementation "com.lwkandroid.library:rcvadapter:last-version"
```
### 基础功能
- 快速实现适配器，支持多种ViewType模式
- 支持添加HeaderView、FooterView、EmptyView
- 支持滑到底部加载更多
- 支持每条Item显示的动画
- 支持嵌套Section（1.1.0版本新增）
- 支持悬浮标签StickyLayout（1.2.0版本新增）
### 效果图
### 使用方式
**1. 当Item样式一样时，只需继承`RcvSingleAdapter`即可，示例：**
```
public class TestSingleAdapter extends RcvSingleAdapter
{
public TestSingleAdapter(Context context, List datas)
{
super(context, android.R.layout.simple_list_item_1, datas);
}
@Override
public void onBindView(RcvHolder holder, TestData itemData, int position)
{
//在这里绑定UI和数据，RcvHolder中提供了部分快速设置数据的方法，详情请看源码
holder.setTvText(android.R.id.text1, itemData.getContent());
}
}
```
**2. 当Item样式不一样时，即存在多种`ViewType`类型的Item，需要将每种`ViewType`的Item单独实现，再关联到`RcvMultiAdapter`中，示例：**
```
//第一步：每种Item分别继承RcvBaseItemView
public class LeftItemView extends RcvBaseItemView
{
@Override
public int getItemViewLayoutId()
{
//这里返回该Item的布局id
return R.layout.layout_item_left;
}
@Override
public boolean isForViewType(TestData item, int position)
{
//这里判断何时引用该Item
return position % 2 == 0;
}
@Override
public void onBindView(RcvHolder holder, TestData testData, int position)
{
//在这里绑定UI和数据，RcvHolder中提供了部分快速设置数据的方法，详情请看源码
holder.setTvText(R.id.tv_left, testData.getContent());
}
}
//第二步：将所有Item关联到适配器中
public class TestMultiAdapter extends RcvMultiAdapter
{
public TestMultiAdapter(Context context, List datas)
{
super(context, datas);
//只需在构造方法里将所有Item关联进来,无论多少种ViewType都轻轻松松搞定
addItemView(new LeftItemView());
addItemView(new RightItemView());
}
}
```
**3.优雅的添加HeaderView、FooterView、EmptyView，只需要在RecyclerView设置LayoutManager后调用相关方法即可：**
```
//要先设置LayoutManager
mRecyclerView.setLayoutManager(new LinearLayoutManager(context, LinearLayoutManager.VERTICAL, false));
//添加HeaderView(若干个)
mAdapter.addHeaderView(headerView01,headerView02,headerView03...);
//添加FooterView(若干个)
mAdapter.addFooterView(footerView01,footerView02,footerView03...);
//添加EmptyView（只能设置一个）
//设置了EmptyView后，当数据量为0的时候会显示EmptyView
mAdapter.setEmptyView(emptyView);
或者
mAdapter.setEmptyView(layoutId);
```
**4.设置滑动到底部自动加载更多，先上示例代码吧：**
**自1.4.3版本开始删除了之前的调用方式**
```
//可以先设置加载样式，继承RcvBaseLoadMoreView实现自定义样式
//不设置的话会使用默认的样式，参考RcvDefLoadMoreView源码
RcvDefLoadMoreView loadMoreView = new RcvDefLoadMoreView.Builder()
.setBgColor(Color.GREEN)
.setTextColor(Color.RED)
.build(this);
mAdapter.setLoadMoreLayout(loadMoreView);
//再开启并设置监听
mAdapter.enableLoadMore(true);
mAdapter.setOnLoadMoreListener(RcvLoadMoreListener listener);
//禁止加载更多,通常用在配合下拉刷新的过程中
mAdapter.enableLoadMore(false);
```
**注：**
① 默认的样式实现是类`RcvDefLoadMoreView`
② 如需自定义样式，只需继承`RcvBaseLoadMoreView`，只要重写各状态UI的实现，无须关心状态切换，可参考`RcvDefLoadMoreView`内的实现方式。
**5.设置Item显示动画，先直接上代码：**
```
//使用默认的动画（Alpha动画）
mAdapter.enableItemShowingAnim(true);
//使用自定义动画
mAdapter.enableItemShowingAnim(true, ? extends RcvBaseAnimation);
```
**注：**
①默认动画的实现是类`RcvAlphaInAnim`
②自定义样式需要继承`RcvBaseAnimation`，可参考`RcvAlphaInAnim`内部实现。
**6.设置Item点击监听：**
```
//设置OnItemClickListener
mAdapter.setOnItemClickListener(new RcvItemViewClickListener()
{
@Override
public void onItemViewClicked(RcvHolder holder, TestData testData, int position)
{
//onClick回调
}
});
//设置OnItemLongClickListener
mAdapter.setOnItemLongClickListener(new RcvItemViewLongClickListener()
{
@Override
public void onItemViewLongClicked(RcvHolder holder, TestData testData, int position)
{
//onLongClick回调
}
});
```
**7. 添加分割线，直接上代码：**
**1.2.9版本针对分割线进行了重写，原有方法不变，新增支持自定义颜色和部分快速创建的方法：**
```
#适用于LinearLayoutManager
//创建默认竖直排列的分割线
RcvLinearDecoration.createDefaultVertical(Context context);
//创建自定义色值默认竖直排列的分割线
RcvLinearDecoration.createDefaultVertical(int color);
//创建默认水平排列的分割线
RcvLinearDecoration.createDefaultHorizontal(Context context);
//创建自定义色值默认水平排列的分割线
RcvLinearDecoration.createDefaultHorizontal(int color);
//构造方法：默认Drawable分割线
new RcvLinearDecoration(Context context, int orientation);
//构造方法：自定义Drawable分割线
new RcvLinearDecoration(Context context, Drawable drawable, int orientation);
//构造方法：自定义Drawable分割线
new RcvLinearDecoration(Context context, @DrawableRes int drawableResId, int orientation);
//构造方法：自定义Color分割线（宽度或者高度默认1px）
new RcvLinearDecoration(@ColorInt int color, int orientation);
//构造方法：自定义Color分割线
new RcvLinearDecoration(@ColorInt int color, int size, int orientation);
#适用于GridLayoutManager、StaggeredGridLayoutManager
//创建默认分割线
RcvGridDecoration.createDefault(Context context);
//创建自定义色值默认分割线
RcvGridDecoration.createDefault(int color);
//构造方法：默认Drawable的分割线
new RcvGridDecoration(Context context);
//构造方法：自定义Drawable的分割线
new RcvGridDecoration(Context context, Drawable drawable);
//构造方法：自定义Drawable的分割线
new RcvGridDecoration(Context context, @DrawableRes int drawableResId);
//构造方法：自定义Color的分割线（默认分割线宽高均为1px）
new RcvGridDecoration(@ColorInt int color);
//构造方法：自定义Color的分割线
new RcvGridDecoration(@ColorInt int color, int width, int height);
```
**注：**
①是直接设置给RecyclerView的，不是设置给适配器的，不要看错哦
②支持自定义drawable当分割线
**8.嵌套Section，稍微复杂一点，配合代码讲解：**
**1.4.0版本开始删除以前的使用方法，采用下面的方式**
带有Section功能的适配器为`RcvSectionMultiLabelAdapter`和`RcvSectionSingleLabelAdapter`,需要指定两个泛型，第一个代表`Section`，第二个代表普通数据`Data`，
两者都支持多种Data类型的子布局，唯一不同的是，`RcvSectionMultiLabelAdapter`还支持多种Section类型的子布局，但不可以和`RcvStickyLayout`联动，而`RcvSectionSingleLabelAdapter`
仅支持一种Section类型的子布局，但是可以和`RcvStickyLayout`联动。**需要注意的是，传给适配器的数据均需要自行预处理，用`RcvSectionWrapper`封装后才可传入适配器。**
```
#只有一种Section类型，配合多种Data类型的适配器
public class TestSectionAdapter extends RcvSectionSingleLabelAdapter
{
public TestSectionAdapter(Context context, List> datas)
{
super(context, datas);
}
@Override
protected RcvBaseItemView>[] createDataItemViews()
{
return new RcvBaseItemView[]{new DataItemView01(), new DataItemView02()};
}
@Override
public int getSectionLabelLayoutId()
{
return R.layout.layout_section_label;
}
@Override
public void onBindSectionLabelView(RcvHolder holder, TestSection section, int position)
{
holder.setTvText(R.id.tv_section_label, section.getSection());
}
//第一种Data ItemView
private class DataItemView01 extends RcvBaseItemView>
{
@Override
public int getItemViewLayoutId()
{
return R.layout.adapter_item_long;
}
@Override
public boolean isForViewType(RcvSectionWrapper item, int position)
{
return !item.isSection() && item.getData().getType() == 0;
}
@Override
public void onBindView(RcvHolder holder, RcvSectionWrapper wrapper, int position)
{
TextView textView = holder.findView(R.id.tv_item_long);
textView.setBackgroundColor(Color.GREEN);
textView.setText("第一种数据类型：" + wrapper.getData().getContent());
}
}
//第二种Data ItemView
private class DataItemView02 extends RcvBaseItemView>
{
@Override
public int getItemViewLayoutId()
{
return R.layout.adapter_item_short;
}
@Override
public boolean isForViewType(RcvSectionWrapper item, int position)
{
return !item.isSection() && item.getData().getType() != 0;
}
@Override
public void onBindView(RcvHolder holder, RcvSectionWrapper wrapper, int position)
{
TextView textView = holder.findView(R.id.tv_item_short);
textView.setBackgroundColor(Color.RED);
textView.setText("第二种数据类型：" + wrapper.getData().getContent());
}
}
}
#多种Section类型，配合多种Data类型的适配器
public class TestSectionMultiLabelAdapter extends RcvSectionMultiLabelAdapter
{
public TestSectionMultiLabelAdapter(Context context, List> datas)
{
super(context, datas);
}
@Override
protected RcvBaseItemView>[] createLabelItemViews()
{
return new RcvBaseItemView[]{new LabelItemView01(), new LabelItemView02()};
}
@Override
protected RcvBaseItemView>[] createDataItemViews()
{
return new RcvBaseItemView[]{new DataItemView01(), new DataItemView02()};
}
//第一种Label ItemView
private class LabelItemView01 extends RcvBaseItemView>
{
@Override
public int getItemViewLayoutId()
{
return R.layout.layout_section_label;
}
@Override
public boolean isForViewType(RcvSectionWrapper item, int position)
{
return item.isSection() && item.getSection().getType() == 0;
}
@Override
public void onBindView(RcvHolder holder, RcvSectionWrapper wrapper, int position)
{
holder.setTvText(R.id.tv_section_label, wrapper.getSection().getSection());
}
}
//第二种Label ItemView
private class LabelItemView02 extends RcvBaseItemView>
{
@Override
public int getItemViewLayoutId()
{
return R.layout.layout_section_label02;
}
@Override
public boolean isForViewType(RcvSectionWrapper item, int position)
{
return item.isSection() && item.getSection().getType() != 0;
}
@Override
public void onBindView(RcvHolder holder, RcvSectionWrapper wrapper, int position)
{
holder.setTvText(R.id.tv_section_label, wrapper.getSection().getSection());
}
}
//第一种Data ItemView
private class DataItemView01 extends RcvBaseItemView>
{
@Override
public int getItemViewLayoutId()
{
return R.layout.adapter_item_long;
}
@Override
public boolean isForViewType(RcvSectionWrapper item, int position)
{
return !item.isSection() && item.getData().getType() == 0;
}
@Override
public void onBindView(RcvHolder holder, RcvSectionWrapper wrapper, int position)
{
TextView textView = holder.findView(R.id.tv_item_long);
textView.setBackgroundColor(Color.GREEN);
textView.setText("第一种数据类型：" + wrapper.getData().getContent());
}
}
//第二种Data ItemView
private class DataItemView02 extends RcvBaseItemView>
{
@Override
public int getItemViewLayoutId()
{
return R.layout.adapter_item_short;
}
@Override
public boolean isForViewType(RcvSectionWrapper item, int position)
{
return !item.isSection() && item.getData().getType() != 0;
}
@Override
public void onBindView(RcvHolder holder, RcvSectionWrapper wrapper, int position)
{
TextView textView = holder.findView(R.id.tv_item_short);
textView.setBackgroundColor(Color.RED);
textView.setText("第二种数据类型：" + wrapper.getData().getContent());
}
}
}
```
**注：**
①传给适配器的数据集合内实体类必须经过RcvSectionWrapper包装。
②向外公布的方法（例如点击监听）的实体类泛型不能传错。
**9.悬浮标签StickyLayout**
适配器方面无需改动，直接使用``RcvSectionSingleLabelAdapter``即可，在RecyclerView同级布局下添加``RcvStickyLayout``，然后在代码中关联起来即可：
```
// xml布局中添加RcvStickyLayout：
//代码中关联RecyclerView
RecyclerView recyclerView = (RecyclerView) findViewById(R.id.rcv_sticky);
/...省略设置RecyclerView的LayoutMananger和Adapter.../
RcvStickyLayout stickyLayout = (RcvStickyLayout) findViewById(R.id.stickyLayout);
stickyLayout.attachToRecyclerView(recyclerView);
```
**上面就是大部分基础功能的使用方法了，想了解更多方法请看源码。**
### 混淆配置
```
-dontwarn com.lwkandroid.rcvadapter.**
-keep class com.lwkandroid.rcvadapter.**{*;}
```
### 待实现功能
- 暂时未想到
### 开源参考
1. https://github.com/hongyangAndroid/baseAdapter
2. https://github.com/CymChad/BaseRecyclerViewAdapterHelper