BindingAdapter

open class BindingAdapter : RecyclerView.Adapter<BindingAdapter.BindingViewHolder>

< Android上最强大的RecyclerView框架 >

一行代码添加多类型 addType
数据模型可以为任何对象 models
通过接口实现来扩展功能 com.drake.brv.item
快速添加触摸事件(防抖点击/快速点击/长按/选择/侧滑/拖拽)
强大的分组/展开/折叠/粘性头部/递归深度/动画/组position expandOrCollapse
自定义列表动画 setAnimation 默认动画 com.drake.brv.animation
头布局/脚布局 addHeader
快速设置分隔物
缺省页 PageRefreshLayout
下拉刷新/上拉加载/自动分页加载 PageRefreshLayout
强大的选择状态 setChecked (切换模式/多选/单选/全选/取消全选/反选/选中数据集/选中数量/单选和多选模式切换)
遵守高内聚低耦合原则, 支持功能配合使用, 代码简洁函数分组

Constructors

BindingAdapter

fun BindingAdapter()

Types

BindingViewHolder

inner class BindingViewHolder : RecyclerView.ViewHolder

Companion

object Companion

Functions

addFooter

fun addFooter(model: Any?, @IntRange(from = -1.toLong()) index: Int = -1, animation: Boolean = false)

添加脚布局

addHeader

fun addHeader(model: Any?, @IntRange(from = -1.toLong()) index: Int = -1, animation: Boolean = false)

添加头布局

addInterfaceType

inline fun <M> addInterfaceType(noinline block: Any.(Int) -> Int)

接口类型, 即类型必须为接口, 同时其子类都会被认为属于该接口而对应其布局

addModels

fun addModels(models: List<Any?>?, animation: Boolean = true, @IntRange(from = -1.toLong()) index: Int = -1)

添加新的数据

addType

inline fun <M> addType(noinline block: M.(position: Int) -> Int)

通过回调函数添加多类型, 一对多多类型(即一个数据类对应多个布局) block中的position为当前item位于列表中的索引, M则为rv的models中对应的数据类型如果泛型为接口类型则自动等效于addInterfaceType

inline fun <M> addType(@LayoutRes() layout: Int)

添加多类型 BRV中一个Item类型对应一个Class布局Id, 而M即为对应该类型所需的数据类型.

checkedAll

fun checkedAll(checked: Boolean = true)

单选模式下不支持全选, 但支持取消全部选择

checkedReverse

fun checkedReverse()

反选

checkedSwitch

fun checkedSwitch(@IntRange(from = 0.toLong()) position: Int)

切换选中

clearFooter

fun clearFooter(animation: Boolean = false)

清除全部脚布局

clearHeader

fun clearHeader(animation: Boolean = false)

collapse

fun collapse(@IntRange(from = 0.toLong()) position: Int, @IntRange(from = -1.toLong()) depth: Int = 0): Int

折叠

expand

fun expand(@IntRange(from = 0.toLong()) position: Int, scrollTop: Boolean = false, @IntRange(from = -1.toLong()) depth: Int = 0): Int

展开

expandOrCollapse

fun expandOrCollapse(@IntRange(from = 0.toLong()) position: Int, scrollTop: Boolean = false, @IntRange(from = -1.toLong()) depth: Int = 0): Int

展开或折叠

getCheckedModels

fun <M> getCheckedModels(): List<M>

返回被选中的条目对应的数据模型集合

getItemCount

open override fun getItemCount(): Int

getItemId

open override fun getItemId(position: Int): Long

getItemViewType

open override fun getItemViewType(position: Int): Int

getModel

fun <M> getModel(@IntRange(from = 0.toLong()) position: Int): M

根据索引返回数据模型, 不存在该模型则抛出异常

getModelOrNull

inline fun <M> getModelOrNull(position: Int): M?

根据索引返回数据模型, 如果不存在该模型则返回Null

isCheckedAll

fun isCheckedAll(): Boolean

是否全选

isFooter

fun isFooter(@IntRange(from = 0.toLong()) position: Int): Boolean

指定position是否为脚布局

isHeader

fun isHeader(@IntRange(from = 0.toLong()) position: Int): Boolean

指定position是否为头布局

isHover

fun isHover(position: Int): Boolean

通过position判断是否启用悬停

isModel

fun isModel(@IntRange(from = 0.toLong()) position: Int): Boolean

指定position是否为models

isSameGroup

fun isSameGroup(@IntRange(from = 0.toLong()) position: Int, @IntRange(from = 0.toLong()) otherPosition: Int): Boolean

判断两个位置的item是否属于同一分组下, 要求这两个位置的item都展开才有效如果其中一个item都属于根节点则返回-1, 这种情况不算属于同一分组下

onAttachedToRecyclerView

open override fun onAttachedToRecyclerView(recyclerView: RecyclerView)

onBind

fun onBind(block: BindingAdapter.BindingViewHolder.() -> Unit)

onBindViewHolder执行时回调

onBindViewHolder

open override fun onBindViewHolder(holder: BindingAdapter.BindingViewHolder, position: Int)

open override fun onBindViewHolder(holder: BindingAdapter.BindingViewHolder, position: Int, payloads: MutableList<Any>)

onChecked

fun onChecked(block: (position: Int, checked: Boolean, allChecked: Boolean) -> Unit)

条目选中事件回调

onClick

fun Int.onClick(listener: BindingAdapter.BindingViewHolder.(viewId: Int) -> Unit)

添加点击事件, 点击启用防抖动

fun onClick(@IdRes() vararg id: Int, block: BindingAdapter.BindingViewHolder.(viewId: Int) -> Unit)

监听指定Id控件的点击事件, 包含防抖动

onCreate

fun onCreate(block: BindingAdapter.BindingViewHolder.(viewType: Int) -> Unit)

onCreateViewHolder执行时回调

onCreateViewHolder

open override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): BindingAdapter.BindingViewHolder

onExpand

fun onExpand(block: BindingAdapter.BindingViewHolder.(Boolean) -> Unit)

监听展开分组

onFastClick

fun Int.onFastClick(listener: BindingAdapter.BindingViewHolder.(viewId: Int) -> Unit)

添加点击事件

fun onFastClick(@IdRes() vararg id: Int, block: BindingAdapter.BindingViewHolder.(viewId: Int) -> Unit)

监听指定Id控件的点击事件

onLongClick

fun Int.onLongClick(listener: BindingAdapter.BindingViewHolder.(viewId: Int) -> Unit)

添加长按事件

fun onLongClick(@IdRes() vararg id: Int, block: BindingAdapter.BindingViewHolder.(viewId: Int) -> Unit)

长按点击事件回调

onPayload

fun onPayload(block: BindingAdapter.BindingViewHolder.(payloads: MutableList<Any>) -> Unit)

增量更新回调当你使用notifyItemChanged(int, Object)或者notifyItemRangeChanged(int, Object)等方法更新列表时才会触发, 并且形参payload要求不能为null

onToggle

fun onToggle(block: (position: Int, toggleMode: Boolean, end: Boolean) -> Unit)

切换模式事件回调

onViewAttachedToWindow

open override fun onViewAttachedToWindow(holder: BindingAdapter.BindingViewHolder)

onViewDetachedFromWindow

open override fun onViewDetachedFromWindow(holder: BindingAdapter.BindingViewHolder)

removeFooter

fun removeFooter(model: Any?, animation: Boolean = false)

通过数据模型删除脚布局

removeFooterAt

fun removeFooterAt(@IntRange(from = -1.toLong()) index: Int = -1, animation: Boolean = false)

通过索引删除脚布局

removeHeader

fun removeHeader(model: Any?, animation: Boolean = false)

通过数据删除头布局

removeHeaderAt

fun removeHeaderAt(@IntRange(from = 0.toLong()) index: Int = 0, animation: Boolean = false)

通过索引删除头布局

setAnimation

fun setAnimation(itemAnimation: ItemAnimation)

自定义条目的动画样式

fun setAnimation(animationType: AnimationType)

设置当前库自带的条目的动画样式

setCheckableType

fun setCheckableType(@LayoutRes() vararg checkableItemType: Int)

设置可以被选择的item类型

setChecked

fun setChecked(@IntRange(from = 0.toLong()) position: Int, checked: Boolean)

设置选中

setDifferModels

fun setDifferModels(newModels: List<Any?>?, detectMoves: Boolean = true, commitCallback: Runnable? = null)

对比数据, 根据数据差异自动刷新列表数据对比默认使用equals函数对比, 你可以为数据手动实现equals函数来修改对比逻辑.

toggle

fun toggle()

切换模式, 切换模式为遍历每个item

fun toggle(toggleMode: Boolean)

设置切换模式, 切换模式为遍历每个item

toModelPosition

fun Int.toModelPosition(): Int

对应models中的index

Properties

_data

var _data: MutableList<Any?>? = null

原始的数据集合对象, 不会经过任何处理

animationEnabled

var animationEnabled: Boolean = false

是否启用条目动画

animationRepeat

var animationRepeat: Boolean = false

是否重复显示列表动画, 默认item只显示一次动画

checkedCount

val checkedCount: Int

已选择条目数量

checkedPosition

val checkedPosition: <ERROR CLASS>

已选择条目的position

clickThrottle

var clickThrottle: Long

防抖动点击事件的间隔时间, 单位毫秒

expandAnimationEnabled

var expandAnimationEnabled: Boolean = true

分组展开和折叠是否启用动画

footerCount

val footerCount: Int

脚布局数量

footers

var footers: List<Any?>

全部脚布局数据集合

headerCount

val headerCount: Int

头布局数量

headers

var headers: List<Any?>

头布局的数据模型

hoverEnabled

var hoverEnabled: Boolean = true

是否启用条目悬停

interfacePool

val interfacePool: <ERROR CLASS>

itemDifferCallback

var itemDifferCallback: ItemDifferCallback

对比新旧数据更改列表接口

itemTouchHelper

var itemTouchHelper: ItemTouchHelper?

自定义ItemTouchHelper即可设置该属性等效于RecyclerView.addItemDecoration设置

modelCount

val modelCount: Int

数据模型数量(不包含头布局和脚布局)

modelId

var modelId: Int

单独配置modelId, 会忽略BRV.modelId

models

var models: List<Any?>?

数据模型集合如果赋值的是List不可变集合将会自动复制为MutableList, 将无法保持为同一个集合对象引用

mutable

var mutable: MutableList<Any?>

可增删的数据模型集合, 如果models为null则将为列表默认赋值为空集合

onBindViewHolders

var onBindViewHolders: <ERROR CLASS>

onBindViewHolder触发监听器集合

onHoverAttachListener

var onHoverAttachListener: OnHoverAttachListener? = null

监听开始悬停

var rv: RecyclerView? = null

当前Adapter被setAdapter才不为null

singleExpandMode

var singleExpandMode: Boolean = false

只允许一个条目展开(展开当前条目就会折叠上个条目)

singleMode

var singleMode: Boolean = false

全局单选模式

toggleMode

var toggleMode: Boolean = false

是否开启切换模式

typePool

val typePool: <ERROR CLASS>

类型池