StatusLayoutManager
StatusLayoutManager is being sponsored by the following tool; please help to support us by taking a look and signing up to a free trial
中文版 | English Version
切换不同的数据状态布局，包含加载中、空数据和出错状态。
特征
- 不会增加布局层数
- 提供一套可配置的默认状态布局
- 布局懒加载
- 重试按钮点击事件回调
- 可自由扩展其他状态布局
预览
下载 demo 体验
下载
- 在项目的
build.gradle中添加：
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
- 添加依赖
dependencies {
implementation 'com.github.Bakumon:StatusLayoutManager:1.0.4'
}
使用
快速使用
使用 StatusLayoutManager#Builder 创建 StatusLayoutManager 对象，Builder 构造函数的参数是在切换布局时被替换的 View。
statusLayoutManager = new StatusLayoutManager.Builder(recyclerView)
.build();在合适的时机显示对应的状态布局：
// 加载中
statusLayoutManager.showLoadingLayout();
// 空数据
statusLayoutManager.showEmptyLayout();
// 加载失败
statusLayoutManager.showErrorLayout();
// 加载成功，显示原布局
statusLayoutManager.showSuccessLayout();以上可以满足大多数场景。
配置默认布局
以下 API 提供修改默认布局的方法，具体说明见注释。
statusLayoutManager = new StatusLayoutManager.Builder(recyclerView)
// 设置默认加载中布局的提示文本
.setDefaultLoadingText("l拼命加载中...")
// 设置默认空数据布局的提示文本
.setDefaultEmptyText("空白了，哈哈哈哈")
// 设置默认空数据布局的图片
.setDefaultEmptyImg(R.mipmap.ic_launcher)
// 设置默认空数据布局重试按钮的文本
.setDefaultEmptyRetryText("retry")
// 设置默认空数据布局重试按钮的文本颜色
.setDefaultEmptyRetryTextColor(getResources().getColor(R.color.colorAccent))
// 设置默认空数据布局重试按钮是否显示
.setDefaultEmptyRetryVisible(false)
// 设置默认出错布局的提示文本
.setDefaultErrorText(R.string.app_name)
// 设置默认出错布局的图片
.setDefaultErrorImg(R.mipmap.ic_launcher)
// 设置默认出错布局重试按钮的文本
.setDefaultErrorRetryText("重试一波")
// 设置默认出错布局重试按钮的文本颜色
.setDefaultErrorRetryTextColor(getResources().getColor(R.color.colorPrimaryDark))
// 设置默认出错布局重试按钮是否显示
.setDefaultErrorRetryVisible(true)
// 设置默认布局背景，包括加载中、空数据和出错布局
.setDefaultLayoutsBackgroundColor(Color.WHITE)
.build();自定义默认布局
statusLayoutManager = new StatusLayoutManager.Builder(recyclerView)
// 设置加载中布局
.setLoadingLayout(inflate(R.layout.layout_loading))
// 设置空数据布局
.setEmptyLayout(inflate(R.layout.layout_empty))
// 设置出错布局
.setErrorLayout(inflate(R.layout.layout_error))
// 设置加载中布局
.setLoadingLayout(R.layout.layout_loading)
// 设置空数据布局
.setEmptyLayout(R.layout.layout_empty)
// 设置出错布局
.setErrorLayout(R.layout.layout_error)
// 设置空数据布局重试按钮 ID
.setEmptyRetryID(R.id.tv_empty)
// 设置出错布局重试按钮 ID
.setErrorRetryID(R.id.tv_error)
.build();显示自定义状态布局
statusLayoutManager#showCustomLayout()有几个重载方法，下面以参数最多的为例介绍：
/**
* 显示自定义状态布局
*
* @param customLayoutID 自定义布局 ID
* @param clickViewID 重试按钮 ID
* @return 自定义状态布局
*/
statusLayoutManager.showCustomLayout(R.layout.layout_custome, R.id.tv_customer, R.id.tv_customer1);其中 clickViewID 参数，表示想要添加点击事件的 View 的 id。
点击监听
statusLayoutManager = new StatusLayoutManager.Builder(recyclerView)
// 设置重试事件监听器
.setOnStatusLayoutClickListener(new OnStatusLayoutClickListener() {
@Override
public void onEmptyChildClick(View view) {
}
@Override
public void onErrorChildClick(View view) {
}
@Override
public void onCustomerChildClick(View view) {
}
}
})
.build();也可以使用 OnStatusLayoutClickListener 默认的实现类，像下面这样：
statusLayoutManager = new StatusLayoutManager.Builder(recyclerView)
// 设置重试事件监听器
.setOnStatusChildClickListener(new DefaultOnStatusChildClickListener() {
@Override
public void onEmptyChildClick(View view) {
}
@Override
public void onErrorChildClick(View view) {
}
})
.build();已知问题
1. StatusLayoutManager#Builder(View view)：view 参数的要求
由于该库的原理是，首先获取需要被替换的 view 在父控件中的 LayoutParams，然后通过调用父控件的 removeViewAt() 方法移除原有布局，调用父控件的 addView() 方法添加进去新的布局，来达到切换布局的目的。所以要求被替换 view 的父控件支持这种方式。
目前已知android.support.v4.widget.SwipeRefreshLayout 等刷新控件不支持这种方式。建议直接把 SwipeRefreshLayout 对象当作要替换的 view 传递给 Builder 构造函数。