# DslAdapter

**Repository Path**: gitosc4711/DslAdapter

## Basic Information

- **Project Name**: DslAdapter
- **Description**: Dsl 的形式使用 RecyclerView.Adapter, 支持情感图状态切换, 加载更多, 多类型Item等
- **Primary Language**: Kotlin
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 6
- **Created**: 2019-10-31
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DslAdapter
`Dsl` 的形式使用 `RecyclerView.Adapter`, 支持情感图状态切换, 加载更多, 多类型`Item`等

所有`Item`继承自`DslAdapterItem`即可在`DslAdapter`中使用.

# 特性
1. `全网最轻量`的`多类型Item`实现方法
2. 支持`情感图状`态(空布局 加载中 错误异常等)切换 完美支持自定义扩展
3. 支持`加载更多` 完美支持自定义扩展
4. 支持分组`折叠` (类似QQ联系人好友分组,展开和折叠的效果) 
5. 支持Item`悬停` (类似QQ联系人好友分组,悬停的效果)
6. 支持常规的`分割线` (一会儿占满屏幕 一会儿有点边距的效果)
7. 支持单`选/多选` (支持固定选项)
8. 支持某一个Item `定向更新`多个其他Item
9. 支持`群组`功能 (指定连续的几个相同/不同的item为一组)
10. 支持`滑动选择`(手指拖拽, 就可以选中范围内item)


# 功能介绍

## 分组折叠

折叠功能需要属性`itemIsGroupHead=true`和`itemGroupExtend`的配置

`itemGroupExtend=true`:展开

`itemGroupExtend=false`:折叠

折叠的`Item`, 会在`itemIsGroupHead=true`到下一个`itemIsGroupHead=true`之间的`Item`


```
dslItem(R.layout.item_group_head) {
    itemIsGroupHead = true
    itemBind = { itemHolder, itemPosition, adapterItem ->
        itemHolder.tv(R.id.fold_button).text =
            if (itemGroupExtend) "折叠 $itemPosition" else "展开 $itemPosition"

        itemHolder.click(R.id.fold_button) {
            itemGroupExtend = !itemGroupExtend
        }
    }
}
```

## 悬停

属性`itemIsHover=true`开启即可, 需要`HoverItemDecoration`的支持.

```kotlin
HoverItemDecoration().attachToRecyclerView(RecyclerView)
```

默认情况下, `itemIsGroupHead=true`时, 会自动开启`itemIsHover`, 如果不符合, 需要手动关闭`itemIsHover=false`

[关于HoverItemDecoration更多信息](https://github.com/angcyo/HoverItemDecoration)

## 分割线

需要`DslItemDecoration`的支持.

```kotlin
RecyclerView.addItemDecoration(DslItemDecoration())
```

分割线相关的属性:

```
//控制item上下左右的间距
itemTopInsert
itemLeftInsert
itemRightInsert
itemBottomInsert

//控制分割线只绘制offset区域
onlyDrawOffsetArea
itemTopOffset
itemLeftOffset
itemRightOffset
itemBottomOffset

//分割线的颜色和自定义的Drawable
itemDecorationColor
itemDecorationDrawable
```

示例代码:

```kotlin
dslItem(DslDemoItem()) {
    itemText = "顶部的分割线是红色"
    itemTopInsert = 8 * dpi
    itemDecorationColor = Color.RED //控制分割线的颜色
}

dslItem(DslDemoItem()) {
    itemText = "只绘制偏移量的分割线"
    itemTopInsert = 8 * dpi
    itemLeftOffset = 60 * dpi
    itemDecorationColor = Color.BLUE
    onlyDrawOffsetArea = true
}

dslItem(DslDemoItem()) {
    itemText = "自定义Drawable的分割线"
    itemBottomInsert = 20 * dpi
    itemDecorationDrawable = resources.getDrawable(R.drawable.shape_decoration)
}

dslItem(DslDemoItem()) {
    itemText = "上下都有的分割线"
    itemTopInsert = 8 * dpi
    itemBottomInsert = 8 * dpi
    itemDecorationColor = Color.GREEN
}
```

## 单选/多选

单选/多选的功能由`ItemSelectorHelper`提供,通过`DslAdapter`成员变量`itemSelectorHelper`访问.

**选择模式切换:**

```kotlin
//目前支持 单选/多选 
dslAdapter.itemSelectorHelper.selectorModel = MODEL_NORMAL
dslAdapter.itemSelectorHelper.selectorModel = MODEL_SINGLE
dslAdapter.itemSelectorHelper.selectorModel = MODEL_MULTI

```

**固定选项:**

```kotlin
itemSelectorHelper.fixedSelectorItemList = fixedItemList
```

**全部选择/取消:**

```kotlin
dslAdapter.itemSelectorHelper.selectorAll(SelectorParams(selector = !isSelectorAll))

```
**选择/取消:**

```kotlin
itemSelectorHelper.selector(
    SelectorParams(
        dslAdapterItem,
        select,
        notify = true,
        notifyItemChange = true,
        updateItemDepend = notifyUpdate
    )
)

```

**参数说明**

```kotlin
data class SelectorParams(
    //目标
    var item: DslAdapterItem? = null,
    //操作
    var selector: Boolean = true,
    //事件通知
    var notify: Boolean = true,

    /**
     * 是否需要回调[_itemSelectorChange]
     * [com.angcyo.dsladapter.ItemSelectorHelper._selectorInner]
     * */
    var notifyItemChange: Boolean = true,

    /**
     * 传递给
     * [com.angcyo.dsladapter.DslAdapterItem._itemSelectorChange]
     * */
    var updateItemDepend: Boolean = false,

    //额外自定义的扩展数据
    var extend: Any? = null,

    var _useFilterList: Boolean = true
)
```

![](https://gitee.com/angcyo/DslAdapter/raw/master/png/selector.png)

## 滑动选择

滑动选择使用`RecyclerView.OnItemTouchListener`实现.

需要组件`SlidingSelectorHelper`的支持.

开启也特别简单:

```kotlin
recyclerView.addOnItemTouchListener(SlidingSelectorHelper(applicationContext, dslAdapter))

```

在界面上, 长按. 即可进入`滑动选择模式`, 手指在`顶部or底部`会触发滑动.

离`顶部or底部`距离越近, 会智能滑动提速.

## 定向更新

重写属性`isItemInUpdateList`, 用来决定需要收到更新通知的`DslAdapterItem`

当触发`updateItemDepend`方法时, 所有需要更新的`DslAdapterItem` 会收到`onItemUpdateFrom`的函数回调.


## 群组功能

属性`itemGroups`, 方法`isItemInGroups`

为指定`DslAdapterItem`指定分组属性.

```
itemGroups = mutableListOf("group${i + 1}")
```

通过动态计算属性`itemGroupParams`,根据位置设置不同的背景

代码示例:

```kotlin
dslItem(R.layout.item_group_head) {
    itemIsGroupHead = true //启动分组折叠
    itemIsHover = false //关闭悬停
    itemGroups = mutableListOf("group${i + 1}")
    itemTopInsert = 10 * dpi

    onItemBindOverride = { itemHolder, itemPosition, adapterItem ->
        itemHolder.tv(R.id.fold_button).text =
            if (itemGroupExtend) "折叠 $itemPosition" else "展开 $itemPosition"

        itemHolder.tv(R.id.text_view).text = "分组${i + 1}"

        itemHolder.click(R.id.fold_button) {
            itemGroupExtend = !itemGroupExtend
        }

        //根据位置设置不同的背景
        itemGroupParams.apply {
            if (isOnlyOne()) {
                itemHolder.itemView
                    .setBackgroundResource(R.drawable.shape_group_all)
            } else if (isFirstPosition()) {
                itemHolder.itemView
                    .setBackgroundResource(R.drawable.shape_group_header)
            } else {
                itemHolder.itemView
                    .setBackgroundColor(resources.getColor(R.color.colorAccent))
            }
        }
    }
}

```

在`线性布局`中的表现:

![](https://gitee.com/angcyo/DslAdapter/raw/master/png/group.png)

在`网格布局`中的表现 (具有`线性布局`的所有属性, 并具有`专属网格`属性):

![](https://gitee.com/angcyo/DslAdapter/raw/master/png/grid.png)

## 基础功能 1.多类型使用方式

### 1.1 方式1(推荐)

继承 `DslAdapterItem`  重写 `itemLayoutId`  实现 `itemBind` 搞定.

```kotlin
class DslTextItem : DslAdapterItem() {
    init {
        itemLayoutId = R.layout.item_text_layout
    }

    override var itemBind: (itemHolder: DslViewHolder, itemPosition: Int, adapterItem: DslAdapterItem) -> Unit =
        { itemHolder, itemPosition, _ ->
            itemHolder.v<TextView>(R.id.text_view).text = "文本位置:$itemPosition"
        }
}
```

### 1.2 方式2

调用扩展方法`dslItem` 传入`layoutId`参数 实现 `itemBind` 搞定.

```kotlin
dslAdapter.dslItem(R.layout.item_text_layout) {
          itemBind = { itemHolder, itemPosition, _ ->
              itemHolder.v<TextView>(R.id.text_view).text = "文本位置:$itemPosition"
          }
      }
```

## 基础功能 2.情感图自定义

继承`DslAdapterStatusItem` 将对象设置给`DslAdapter`的`dslAdapterStatusItem`变量 即可.

```kotlin
open class DslAdapterStatusItem : DslAdapterItem() {
    init {
        itemLayoutId = R.layout.item_adapter_status
    }

    companion object {
        const val ADAPTER_STATUS_NONE = -1
        const val ADAPTER_STATUS_EMPTY = 0
        const val ADAPTER_STATUS_LOADING = 1
        const val ADAPTER_STATUS_ERROR = 2
    }

    var itemAdapterStatus: Int = ADAPTER_STATUS_NONE

    override var itemBind: (itemHolder: DslViewHolder, itemPosition: Int, adapterItem: DslAdapterItem) -> Unit =
        { itemHolder, _, _ ->

            /*具体逻辑, 自行处理*/
            itemHolder.v<TextView>(R.id.text_view).text = "情感图状态: ${when (itemAdapterStatus) {
                ADAPTER_STATUS_EMPTY -> "空数据"
                ADAPTER_STATUS_LOADING -> "加载中"
                ADAPTER_STATUS_ERROR -> "加载异常"
                else -> "未知状态"
            }}"
        }

    /**返回[true] 表示不需要显示情感图, 即显示[Adapter]原本的内容*/
    open fun isNoStatus() = itemAdapterStatus == ADAPTER_STATUS_NONE
}

```

## 基础功能 3.加载更多自定义
继承`DslLoadMoreItem` 将对象设置给`DslAdapter`的`dslLoadMoreItem`变量 即可.

```kotlin
open class DslLoadMoreItem : DslAdapterItem() {
    init {
        itemLayoutId = R.layout.item_load_more
    }

    companion object {
        const val ADAPTER_LOAD_NORMAL = 0
        const val ADAPTER_LOAD_LOADING = 1
        const val ADAPTER_LOAD_ERROR = 2
        const val ADAPTER_LOAD_NO_MORE = 3
    }

    /**是否激活加载更多*/
    var itemEnableLoadMore = true
        set(value) {
            field = value
            itemLoadMoreStatus = ADAPTER_LOAD_NORMAL
        }

    /**加载更多当前的状态*/
    var itemLoadMoreStatus: Int = ADAPTER_LOAD_NORMAL

    /**加载更多回调*/
    var onLoadMore: (DslViewHolder) -> Unit = {}

    override var itemBind: (itemHolder: DslViewHolder, itemPosition: Int, adapterItem: DslAdapterItem) -> Unit =
        { itemHolder, _, _ ->

            /*具体逻辑, 自行处理*/
            itemHolder.v<TextView>(R.id.text_view).text = "加载更多: ${when (itemLoadMoreStatus) {
                ADAPTER_LOAD_NORMAL -> "加载更多中..."
                ADAPTER_LOAD_LOADING -> "加载更多中..."
                ADAPTER_LOAD_ERROR -> "加载异常"
                ADAPTER_LOAD_NO_MORE -> "我是有底线的"
                else -> "未知状态"
            }}"

            if (itemEnableLoadMore) {
                if (itemLoadMoreStatus == ADAPTER_LOAD_NORMAL) {
                    //错误和正常的情况下, 才触发加载跟多
                    itemLoadMoreStatus = ADAPTER_LOAD_LOADING
                    onLoadMore(itemHolder)
                }
            }
        }

    override var onItemViewDetachedToWindow: (itemHolder: DslViewHolder) -> Unit = {
        if (itemEnableLoadMore) {
            //加载失败时, 下次是否还需要加载更多?
            if (itemLoadMoreStatus == ADAPTER_LOAD_ERROR) {
                itemLoadMoreStatus = ADAPTER_LOAD_NORMAL
            }
        }
    }
}

```

# 最终使用代码

```kotlin
private fun initLayout() {
    dslViewHolder.v<RecyclerView>(R.id.recycler_view).apply {
        layoutManager = LinearLayoutManager(context, LinearLayoutManager.VERTICAL, false)
        adapter = dslAdapter
    }

    dslAdapter.来点数据()
} 

private fun DslAdapter.来点数据() {
    val dslAdapter = this
    for (i in 0..10) {
        //2种使用item的方式, 喜欢哪种方式, 就用哪一种
        dslAdapter.dslTextItem()
        dslAdapter.dslItem(R.layout.item_text_layout) {
            itemBind = { itemHolder, itemPosition, _ ->
                itemHolder.v<TextView>(R.id.text_view).text = "文本位置:$itemPosition"
            }
        }

        for (j in 0..0) {
            //2种使用item的方式, 喜欢哪种方式, 就用哪一种
            dslAdapter.dslImageItem()
            dslAdapter.dslItem(R.layout.item_image_layout) {
                itemBind = { itemHolder, itemPosition, _ ->
                    itemHolder.v<TextView>(R.id.text_view).text = "文本位置:$itemPosition"
                }
            }
        }
    }
}

```

# 依赖使用方法

## 1.JitPack

根 `build.gradle`
```
allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
```

```
dependencies {
    implementation 'com.github.angcyo:DslAdapter:xxx'
}
```

快照版本:(能够保持最新代码)
```
dependencies {
    implementation 'com.github.angcyo:DslAdapter:master-SNAPSHOT'
}
```

## 2.下载源码

```
git clone https://github.com/angcyo/DslAdapter.git --depth=1
```

拷贝包 `com.angcyo.dsladapter.dsl` 下的`所有文件`到您的工程.

关于更新:

如果未修改源码, 可以直接覆盖.
如果修改了源码 可以使用 AS 提供的 `Compare with Clipboard` 功能 进行比对合并.

加油 你可以的!

# 备注

更多使用方式, 请下载源码`build`安装体验.

或者扫码安装

![](https://gitee.com/angcyo/DslAdapter/raw/master/png/qrcode1.png)

---
**群内有`各(pian)种(ni)各(jin)样(qun)`的大佬,等你来撩.**

# 联系作者

[点此QQ对话](http://wpa.qq.com/msgrd?v=3&uin=664738095&site=qq&menu=yes)  `该死的空格`    [点此快速加群](https://shang.qq.com/wpa/qunwpa?idkey=cbcf9a42faf2fe730b51004d33ac70863617e6999fce7daf43231f3cf2997460)

![](https://gitee.com/angcyo/res/raw/master/code/all_in1.jpg)

![](https://gitee.com/angcyo/res/raw/master/code/all_in2.jpg)