/
AssemblyGridDividerItemDecoration.kt
402 lines (357 loc) · 15.6 KB
/
AssemblyGridDividerItemDecoration.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
/*
* Copyright (C) 2021 panpf <panpfpanpf@outlook.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.panpf.assemblyadapter.recycler.divider
import android.content.Context
import androidx.recyclerview.widget.GridLayoutManager
import com.github.panpf.assemblyadapter.recycler.divider.internal.AssemblyFindItemFactoryClassSupport
import com.github.panpf.assemblyadapter.recycler.divider.internal.AssemblyItemDividerConfig
import com.github.panpf.assemblyadapter.recycler.divider.internal.ConcatFindItemFactoryClassSupport
/**
* [GridLayoutManager] dedicated divider ItemDecoration. Support divider、header and footer divider、side divider、header and footer side divider.
*
* On the basis of [GridDividerItemDecoration], the divider can be disabled or personalized according to the ItemFactory class
*/
open class AssemblyGridDividerItemDecoration(
dividerConfig: AssemblyItemDividerConfig?,
headerDividerConfig: AssemblyItemDividerConfig?,
footerDividerConfig: AssemblyItemDividerConfig?,
sideDividerConfig: AssemblyItemDividerConfig?,
sideHeaderDividerConfig: AssemblyItemDividerConfig?,
sideFooterDividerConfig: AssemblyItemDividerConfig?,
) : GridDividerItemDecoration(
dividerConfig,
headerDividerConfig,
footerDividerConfig,
sideDividerConfig,
sideHeaderDividerConfig,
sideFooterDividerConfig
) {
init {
sideDividerConfig?.run {
if (personaliseByItemFactoryClassMap != null) {
val allSame = (0 until personaliseByItemFactoryClassMap.size).all { index ->
itemDivider.compareSizeAndInsets(personaliseByItemFactoryClassMap.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personaliseByItemFactory divider of the sideDivider must be the same as the sideDivider ")
}
}
}
sideHeaderDividerConfig?.run {
if (personaliseByItemFactoryClassMap != null) {
val allSame = (0 until personaliseByItemFactoryClassMap.size).all { index ->
itemDivider.compareSizeAndInsets(personaliseByItemFactoryClassMap.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personaliseByItemFactory divider of the sideHeaderDivider must be the same as the sideHeaderDivider ")
}
}
}
sideFooterDividerConfig?.run {
if (personaliseByItemFactoryClassMap != null) {
val allSame = (0 until personaliseByItemFactoryClassMap.size).all { index ->
itemDivider.compareSizeAndInsets(personaliseByItemFactoryClassMap.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personaliseByItemFactory divider of the sideFooterDivider must be the same as the sideFooterDivider ")
}
}
}
}
class Builder(val context: Context) {
private var dividerConfig: AssemblyDividerConfig? = null
private var headerDividerConfig: AssemblyDividerConfig? = null
private var footerDividerConfig: AssemblyDividerConfig? = null
private var useDividerAsHeaderDivider = false
private var useDividerAsFooterDivider = false
private var sideDividerConfig: AssemblyDividerConfig? = null
private var sideHeaderDividerConfig: AssemblyDividerConfig? = null
private var sideFooterDividerConfig: AssemblyDividerConfig? = null
private var useSideDividerAsSideHeaderDivider = false
private var useSideDividerAsSideFooterDivider = false
private var disableDefaultDivider = false
private var findItemFactoryClassSupport: FindItemFactoryClassSupport? = null
fun build(): AssemblyGridDividerItemDecoration {
if ((useSideDividerAsSideHeaderDivider || useSideDividerAsSideFooterDivider) && sideDividerConfig == null) {
throw IllegalArgumentException("Must call the sideDivider() method to configure the sideDivider")
}
val finalDividerConfig = when {
dividerConfig != null -> dividerConfig
!disableDefaultDivider -> context.obtainStyledAttributes(
intArrayOf(android.R.attr.listDivider)
).let { array ->
array.getDrawable(0).apply {
array.recycle()
}
}!!.let {
AssemblyDividerConfig.Builder(Divider.drawable(it)).build()
}
else -> null
}
if ((useDividerAsHeaderDivider || useDividerAsFooterDivider) && finalDividerConfig == null) {
throw IllegalArgumentException("Must call the divider() method to configure the divider")
}
val finalFindItemFactoryClassByPosition =
(findItemFactoryClassSupport ?: AssemblyFindItemFactoryClassSupport()).run {
ConcatFindItemFactoryClassSupport(this)
}
return AssemblyGridDividerItemDecoration(
dividerConfig = finalDividerConfig
?.toAssemblyItemDividerConfig(context, finalFindItemFactoryClassByPosition),
headerDividerConfig = (headerDividerConfig
?: if (useDividerAsHeaderDivider) finalDividerConfig else null)
?.toAssemblyItemDividerConfig(context, finalFindItemFactoryClassByPosition),
footerDividerConfig = (footerDividerConfig
?: if (useDividerAsFooterDivider) finalDividerConfig else null)
?.toAssemblyItemDividerConfig(context, finalFindItemFactoryClassByPosition),
sideDividerConfig = sideDividerConfig
?.toAssemblyItemDividerConfig(context, finalFindItemFactoryClassByPosition),
sideHeaderDividerConfig = (sideHeaderDividerConfig
?: if (useSideDividerAsSideHeaderDivider) sideDividerConfig else null)
?.toAssemblyItemDividerConfig(context, finalFindItemFactoryClassByPosition),
sideFooterDividerConfig = (sideFooterDividerConfig
?: if (useSideDividerAsSideFooterDivider) sideDividerConfig else null)
?.toAssemblyItemDividerConfig(context, finalFindItemFactoryClassByPosition),
)
}
/**
* Set the divider of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun divider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.dividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the divider of the item
*/
fun divider(config: AssemblyDividerConfig): Builder {
this.dividerConfig = config
return this
}
/**
* Set the header divider of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun headerDivider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.headerDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header divider of the item
*/
fun headerDivider(config: AssemblyDividerConfig): Builder {
this.headerDividerConfig = config
return this
}
/**
* Set the footer divider of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun footerDivider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.footerDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the footer divider of the item
*/
fun footerDivider(config: AssemblyDividerConfig): Builder {
this.footerDividerConfig = config
return this
}
/**
* Set the header and footer divider of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun headerAndFooterDivider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.headerDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
this.footerDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header and footer divider of the item
*/
fun headerAndFooterDivider(config: AssemblyDividerConfig): Builder {
this.headerDividerConfig = config
this.footerDividerConfig = config
return this
}
/**
* Use divider as the header divider
*/
fun useDividerAsHeaderDivider(use: Boolean = true): Builder {
this.useDividerAsHeaderDivider = use
return this
}
/**
* Use divider as the footer divider
*/
fun useDividerAsFooterDivider(use: Boolean = true): Builder {
this.useDividerAsFooterDivider = use
return this
}
/**
* Use divider as the header and footer divider
*/
fun useDividerAsHeaderAndFooterDivider(use: Boolean = true): Builder {
this.useDividerAsHeaderDivider = use
this.useDividerAsFooterDivider = use
return this
}
/**
* Set the divider on the side of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun sideDivider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the divider on the side of the item
*/
fun sideDivider(config: AssemblyDividerConfig): Builder {
this.sideDividerConfig = config
return this
}
/**
* Set the header divider on the side of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun sideHeaderDivider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideHeaderDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header divider on the side of the item
*/
fun sideHeaderDivider(config: AssemblyDividerConfig): Builder {
this.sideHeaderDividerConfig = config
return this
}
/**
* Set the footer divider on the side of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun sideFooterDivider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideFooterDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the footer divider on the side of the item
*/
fun sideFooterDivider(config: AssemblyDividerConfig): Builder {
this.sideFooterDividerConfig = config
return this
}
/**
* Set the header and footer divider on the side of the item. You can configure to disable the divider or
* provide a personalized divider in some cases through the [configBlock] function
*/
fun sideHeaderAndFooterDivider(
divider: Divider,
configBlock: (AssemblyDividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideHeaderDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
this.sideFooterDividerConfig = AssemblyDividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header and footer divider on the side of the item
*/
fun sideHeaderAndFooterDivider(config: AssemblyDividerConfig): Builder {
this.sideHeaderDividerConfig = config
this.sideFooterDividerConfig = config
return this
}
/**
* Use side divider as the header side divider
*/
fun useSideDividerAsSideHeaderDivider(use: Boolean = true): Builder {
this.useSideDividerAsSideHeaderDivider = use
return this
}
/**
* Use side divider as the footer side divider
*/
fun useSideDividerAsSideFooterDivider(use: Boolean = true): Builder {
this.useSideDividerAsSideFooterDivider = use
return this
}
/**
* Use side divider as the header and footer side divider
*/
fun useSideDividerAsSideHeaderAndFooterDivider(use: Boolean = true): Builder {
this.useSideDividerAsSideHeaderDivider = use
this.useSideDividerAsSideFooterDivider = use
return this
}
/**
* Prohibit using the system default divider when no divider is specified
*/
fun disableDefaultDivider(disableDefaultDivider: Boolean = true): Builder {
this.disableDefaultDivider = disableDefaultDivider
return this
}
/**
* Set up the interface to find ItemFactory class
*/
fun findItemFactoryClassSupport(findItemFactoryClassSupport: FindItemFactoryClassSupport?): Builder {
this.findItemFactoryClassSupport = findItemFactoryClassSupport
return this
}
}
}