/
StaggeredGridDividerItemDecoration.kt
671 lines (620 loc) · 28.4 KB
/
StaggeredGridDividerItemDecoration.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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
/*
* 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 android.graphics.Canvas
import android.graphics.Rect
import android.view.View
import androidx.core.view.ViewCompat
import androidx.recyclerview.widget.GridLayoutManager
import androidx.recyclerview.widget.RecyclerView
import androidx.recyclerview.widget.RecyclerView.ItemDecoration
import androidx.recyclerview.widget.StaggeredGridLayoutManager
import com.github.panpf.assemblyadapter.recycler.FullSpanSupport
import com.github.panpf.assemblyadapter.recycler.FullSpanSupportFromLayoutManager
import com.github.panpf.assemblyadapter.recycler.divider.internal.GridDividerNoSideHelper
import com.github.panpf.assemblyadapter.recycler.divider.internal.GridDividerOnlySideHelper
import com.github.panpf.assemblyadapter.recycler.divider.internal.GridDividerSideAndFooterHelper
import com.github.panpf.assemblyadapter.recycler.divider.internal.GridDividerSideAndHeaderFooterHelper
import com.github.panpf.assemblyadapter.recycler.divider.internal.GridDividerSideAndHeaderHelper
import com.github.panpf.assemblyadapter.recycler.divider.internal.GridItemParams
import com.github.panpf.assemblyadapter.recycler.divider.internal.ItemDividerConfig
/**
* [StaggeredGridLayoutManager] dedicated divider ItemDecoration. Support divider、header and footer divider、side divider、header and footer side divider
*/
open class StaggeredGridDividerItemDecoration(
val dividerConfig: ItemDividerConfig?,
val headerDividerConfig: ItemDividerConfig?,
val footerDividerConfig: ItemDividerConfig?,
val sideDividerConfig: ItemDividerConfig?,
val sideHeaderDividerConfig: ItemDividerConfig?,
val sideFooterDividerConfig: ItemDividerConfig?,
val isFullSpanByPosition: FullSpanSupport?,
) : ItemDecoration() {
val dividerHelper = when {
sideDividerConfig != null && sideHeaderDividerConfig != null && sideFooterDividerConfig != null -> {
GridDividerSideAndHeaderFooterHelper(
dividerConfig,
headerDividerConfig,
footerDividerConfig,
sideDividerConfig,
sideHeaderDividerConfig,
sideFooterDividerConfig
)
}
sideDividerConfig != null && sideHeaderDividerConfig != null && sideFooterDividerConfig == null -> {
GridDividerSideAndHeaderHelper(
dividerConfig,
headerDividerConfig,
footerDividerConfig,
sideDividerConfig,
sideHeaderDividerConfig
)
}
sideDividerConfig != null && sideHeaderDividerConfig == null && sideFooterDividerConfig != null -> {
GridDividerSideAndFooterHelper(
dividerConfig,
headerDividerConfig,
footerDividerConfig,
sideDividerConfig,
sideFooterDividerConfig
)
}
sideDividerConfig != null && sideHeaderDividerConfig == null && sideFooterDividerConfig == null -> {
GridDividerOnlySideHelper(
dividerConfig,
headerDividerConfig,
footerDividerConfig,
sideDividerConfig
)
}
else -> {
GridDividerNoSideHelper(
dividerConfig,
headerDividerConfig,
footerDividerConfig
)
}
}
private var reusableItemParams: GridItemParams? = null
init {
if ((headerDividerConfig != null || footerDividerConfig != null) && isFullSpanByPosition == null) {
throw IllegalArgumentException(
"Must be set the 'isFullSpanByPosition' property, because you configured 'headerDivider' or 'footerDivider'"
)
}
if ((sideHeaderDividerConfig != null || sideFooterDividerConfig != null) && sideDividerConfig == null) {
throw IllegalArgumentException("When sideHeaderDivider or sideFooterDivider not null, sideDivider cannot be null")
}
if (sideDividerConfig != null) {
if (sideHeaderDividerConfig != null
&& !sideDividerConfig.itemDivider.compareSizeAndInsets(sideHeaderDividerConfig.itemDivider)
) {
throw IllegalArgumentException("The size and insets of sideHeaderDivider must be the same as sideDivider")
}
if (sideFooterDividerConfig != null
&& !sideDividerConfig.itemDivider.compareSizeAndInsets(sideFooterDividerConfig.itemDivider)
) {
throw IllegalArgumentException("The size and insets of sideHeaderDivider must be the same as sideDivider")
}
}
sideDividerConfig?.run {
if (personaliseByPositionArray != null) {
val allSame = (0 until personaliseByPositionArray.size()).all { index ->
itemDivider.compareSizeAndInsets(personaliseByPositionArray.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personalizedByPosition divider of the sideDivider must be the same as the sideDivider ")
}
}
if (personaliseBySpanIndexArray != null) {
val allSame = (0 until personaliseBySpanIndexArray.size()).all { index ->
itemDivider.compareSizeAndInsets(personaliseBySpanIndexArray.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personalizedBySpanIndex divider of the sideDivider must be the same as the sideDivider ")
}
}
}
sideHeaderDividerConfig?.run {
if (personaliseByPositionArray != null) {
val allSame = (0 until personaliseByPositionArray.size()).all { index ->
itemDivider.compareSizeAndInsets(personaliseByPositionArray.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personalizedByPosition divider of the sideHeaderDivider must be the same as the sideHeaderDivider ")
}
}
if (personaliseBySpanIndexArray != null) {
val allSame = (0 until personaliseBySpanIndexArray.size()).all { index ->
itemDivider.compareSizeAndInsets(personaliseBySpanIndexArray.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personalizedBySpanIndex divider of the sideHeaderDivider must be the same as the sideHeaderDivider ")
}
}
}
sideFooterDividerConfig?.run {
if (personaliseByPositionArray != null) {
val allSame = (0 until personaliseByPositionArray.size()).all { index ->
itemDivider.compareSizeAndInsets(personaliseByPositionArray.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personalizedByPosition divider of the sideFooterDivider must be the same as the sideFooterDivider ")
}
}
if (personaliseBySpanIndexArray != null) {
val allSame = (0 until personaliseBySpanIndexArray.size()).all { index ->
itemDivider.compareSizeAndInsets(personaliseBySpanIndexArray.valueAt(index))
}
if (!allSame) {
throw IllegalArgumentException("The size and insets of the personalizedBySpanIndex divider of the sideFooterDivider must be the same as the sideFooterDivider ")
}
}
}
}
override fun getItemOffsets(
outRect: Rect, view: View, parent: RecyclerView, state: RecyclerView.State
) {
val layoutManager = parent.layoutManager ?: return
if (layoutManager !is StaggeredGridLayoutManager) {
throw IllegalArgumentException("layoutManager must be StaggeredGridLayoutManager")
}
val itemCount = layoutManager.itemCount.takeIf { it != 0 } ?: return
val childLayoutParams = view.layoutParams as StaggeredGridLayoutManager.LayoutParams
val position = childLayoutParams.absoluteAdapterPosition.takeIf { it != -1 } ?: return
val isVerticalOrientation = layoutManager.orientation == StaggeredGridLayoutManager.VERTICAL
val isLTRDirection = layoutManager.layoutDirection == ViewCompat.LAYOUT_DIRECTION_LTR
val spanCount = layoutManager.spanCount
val spanIndex = childLayoutParams.spanIndex
val isFullSpan = childLayoutParams.isFullSpan
val isFirstSpan = isFullSpan || spanIndex == 0
val isLastSpan = isFullSpan || spanIndex == spanCount - 1
val spanSize = if (isFullSpan) spanCount else 1
val isColumnFirst = if (isFullSpanByPosition != null && position < spanCount) {
when {
isFullSpan -> position == 0
0.rangeTo(position).all { // The position before is all not fullSpan
!isFullSpanByPosition.isFullSpan(parent, it)
} -> true
else -> false
}
} else {
false
}
val isColumnLast =
if (isFullSpanByPosition != null && position >= itemCount - spanCount) {
when {
isFullSpan -> position == itemCount - 1
position.until(itemCount).all { // The position back is all not fullSpan
!isFullSpanByPosition.isFullSpan(parent, it)
} -> true
else -> false
}
} else {
false
}
val itemParams = this.reusableItemParams?.apply {
set(
view, parent, itemCount, position, spanCount, spanSize, spanIndex,
isFullSpan, isFirstSpan, isLastSpan, isColumnFirst, isColumnLast,
isVerticalOrientation, isLTRDirection
)
} ?: GridItemParams(
view, parent, itemCount, position, spanCount, spanSize, spanIndex,
isFullSpan, isFirstSpan, isLastSpan, isColumnFirst, isColumnLast,
isVerticalOrientation, isLTRDirection
).apply {
this@StaggeredGridDividerItemDecoration.reusableItemParams = this
}
dividerHelper.getItemOffsets(outRect, itemParams, true)
}
override fun onDraw(canvas: Canvas, parent: RecyclerView, state: RecyclerView.State) {
val layoutManager = parent.layoutManager ?: return
if (layoutManager !is StaggeredGridLayoutManager) {
throw IllegalArgumentException("layoutManager must be StaggeredGridLayoutManager")
}
val itemCount = layoutManager.itemCount.takeIf { it != 0 } ?: return
val childCount = parent.childCount.takeIf { it != 0 } ?: return
val isVerticalOrientation = layoutManager.orientation == GridLayoutManager.VERTICAL
val isLTRDirection = layoutManager.layoutDirection == ViewCompat.LAYOUT_DIRECTION_LTR
val spanCount = layoutManager.spanCount
for (index in 0 until childCount) {
val view = parent.getChildAt(index)
val childLayoutParams = view.layoutParams as StaggeredGridLayoutManager.LayoutParams
val position = childLayoutParams.absoluteAdapterPosition.takeIf { it != -1 } ?: continue
val spanIndex = childLayoutParams.spanIndex
val isFullSpan = childLayoutParams.isFullSpan
val isFirstSpan = isFullSpan || spanIndex == 0
val isLastSpan = isFullSpan || spanIndex == spanCount - 1
val spanSize = if (isFullSpan) spanCount else 1
val isColumnFirst = if (isFullSpanByPosition != null && position < spanCount) {
when {
isFullSpan -> position == 0
0.rangeTo(position).all { // The position before is all not fullSpan
!isFullSpanByPosition.isFullSpan(parent, it)
} -> true
else -> false
}
} else {
false
}
val isColumnLast =
if (isFullSpanByPosition != null && position >= itemCount - spanCount) {
when {
isFullSpan -> position == itemCount - 1
position.until(itemCount).all { // The position back is all not fullSpan
!isFullSpanByPosition.isFullSpan(parent, it)
} -> true
else -> false
}
} else {
false
}
val itemParams = this.reusableItemParams?.apply {
set(
view, parent, itemCount, position, spanCount, spanSize, spanIndex,
isFullSpan, isFirstSpan, isLastSpan, isColumnFirst, isColumnLast,
isVerticalOrientation, isLTRDirection
)
} ?: GridItemParams(
view, parent, itemCount, position, spanCount, spanSize, spanIndex,
isFullSpan, isFirstSpan, isLastSpan, isColumnFirst, isColumnLast,
isVerticalOrientation, isLTRDirection
).apply {
this@StaggeredGridDividerItemDecoration.reusableItemParams = this
}
dividerHelper.drawItem(canvas, itemParams, true)
}
}
class Builder(val context: Context) {
private var dividerConfig: DividerConfig? = null
private var headerDividerConfig: DividerConfig? = null
private var footerDividerConfig: DividerConfig? = null
private var useDividerAsHeaderDivider = false
private var useDividerAsFooterDivider = false
private var sideDividerConfig: DividerConfig? = null
private var sideHeaderDividerConfig: DividerConfig? = null
private var sideFooterDividerConfig: DividerConfig? = null
private var useSideDividerAsSideHeaderDivider = false
private var useSideDividerAsSideFooterDivider = false
private var disableDefaultDivider = false
private var isFullSpanByPosition: FullSpanSupport? = null
fun build(): StaggeredGridDividerItemDecoration {
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 {
DividerConfig.Builder(Divider.drawable(it)).build()
}
else -> null
}
if ((useDividerAsHeaderDivider || useDividerAsFooterDivider) && finalDividerConfig == null) {
throw IllegalArgumentException("Must call the divider() method to configure the divider")
}
val headerDividerConfig = (headerDividerConfig
?: if (useDividerAsHeaderDivider) finalDividerConfig else null)
?.toItemDividerConfig(context)
val footerDividerConfig = (footerDividerConfig
?: if (useDividerAsFooterDivider) finalDividerConfig else null)
?.toItemDividerConfig(context)
val isFullSpanByPosition = isFullSpanByPosition
?: (if (headerDividerConfig != null || footerDividerConfig != null) FullSpanSupportFromLayoutManager() else null)
return StaggeredGridDividerItemDecoration(
dividerConfig = finalDividerConfig?.toItemDividerConfig(context),
headerDividerConfig = headerDividerConfig,
footerDividerConfig = footerDividerConfig,
sideDividerConfig = sideDividerConfig?.toItemDividerConfig(context),
sideHeaderDividerConfig = (sideHeaderDividerConfig
?: if (useSideDividerAsSideHeaderDivider) sideDividerConfig else null)
?.toItemDividerConfig(context),
sideFooterDividerConfig = (sideFooterDividerConfig
?: if (useSideDividerAsSideFooterDivider) sideDividerConfig else null)
?.toItemDividerConfig(context),
isFullSpanByPosition = isFullSpanByPosition
)
}
/**
* 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: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.dividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the divider of the item
*/
fun divider(config: DividerConfig): 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.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun headerDivider(
divider: Divider,
configBlock: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.headerDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header divider of the item.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun headerDivider(config: DividerConfig): 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.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun footerDivider(
divider: Divider,
configBlock: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.footerDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the footer divider of the item.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun footerDivider(config: DividerConfig): 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.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun headerAndFooterDivider(
divider: Divider,
configBlock: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.headerDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
this.footerDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header and footer divider of the item.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun headerAndFooterDivider(config: DividerConfig): Builder {
this.headerDividerConfig = config
this.footerDividerConfig = config
return this
}
/**
* Use divider as the header divider.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun useDividerAsHeaderDivider(use: Boolean = true): Builder {
this.useDividerAsHeaderDivider = use
return this
}
/**
* Use divider as the footer divider.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
fun useDividerAsFooterDivider(use: Boolean = true): Builder {
this.useDividerAsFooterDivider = use
return this
}
/**
* Use divider as the header and footer divider.
*
* To use this method, you need to set [isFullSpanByPosition], otherwise an exception will be thrown
* @see isFullSpanByPosition
*/
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: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the divider on the side of the item
*/
fun sideDivider(config: DividerConfig): 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: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideHeaderDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header divider on the side of the item
*/
fun sideHeaderDivider(config: DividerConfig): 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: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideFooterDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the footer divider on the side of the item
*/
fun sideFooterDivider(config: DividerConfig): 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: (DividerConfig.Builder.() -> Unit)? = null
): Builder {
this.sideHeaderDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
this.sideFooterDividerConfig = DividerConfig.Builder(divider).apply {
configBlock?.invoke(this)
}.build()
return this
}
/**
* Set the header and footer divider on the side of the item
*/
fun sideHeaderAndFooterDivider(config: DividerConfig): 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 the interface for determining FullSpan based on position.
* If you use [headerDivider], [footerDivider], [headerAndFooterDivider], [useDividerAsHeaderDivider],
* [useDividerAsFooterDivider], [useDividerAsHeaderAndFooterDivider] then you must set this interface,
* otherwise an exception will be thrown
*
* @see headerDivider
* @see footerDivider
* @see headerAndFooterDivider
* @see useDividerAsHeaderDivider
* @see useDividerAsFooterDivider
* @see useDividerAsHeaderAndFooterDivider
*/
@Deprecated(message= "Please use isFullSpanByPosition(FullSpanSupport?) instead")
fun isFullSpanByPosition(isFullSpanByPosition: IsFullSpanByPosition?): Builder {
this.isFullSpanByPosition = isFullSpanByPosition
return this
}
/**
* Set the interface for determining FullSpan based on position.
* If you use [headerDivider], [footerDivider], [headerAndFooterDivider], [useDividerAsHeaderDivider],
* [useDividerAsFooterDivider], [useDividerAsHeaderAndFooterDivider] then you must set this interface,
* otherwise an exception will be thrown
*
* @see headerDivider
* @see footerDivider
* @see headerAndFooterDivider
* @see useDividerAsHeaderDivider
* @see useDividerAsFooterDivider
* @see useDividerAsHeaderAndFooterDivider
*/
fun isFullSpanByPosition(isFullSpanByPosition: FullSpanSupport?): Builder {
this.isFullSpanByPosition = isFullSpanByPosition
return this
}
}
}