/
AssemblyPagingDataFragmentStateAdapter.kt
175 lines (155 loc) · 7.5 KB
/
AssemblyPagingDataFragmentStateAdapter.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
/*
* 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.pager2.paging
import androidx.fragment.app.Fragment
import androidx.fragment.app.FragmentActivity
import androidx.fragment.app.FragmentManager
import androidx.lifecycle.Lifecycle
import androidx.paging.ItemSnapshotList
import androidx.recyclerview.widget.ConcatAdapter
import androidx.recyclerview.widget.DiffUtil
import androidx.recyclerview.widget.RecyclerView
import com.github.panpf.assemblyadapter.AssemblyAdapter
import com.github.panpf.assemblyadapter.Placeholder
import com.github.panpf.assemblyadapter.internal.ItemFactoryStorage
import com.github.panpf.assemblyadapter.pager.FragmentItemFactory
import com.github.panpf.assemblyadapter.recycler.ConcatAdapterAbsoluteHelper
import com.github.panpf.assemblyadapter.recycler.KeyEqualsDiffItemCallback
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.Dispatchers
/**
* An implementation of [PagingDataFragmentStateAdapter], which implements multi-type adapters through standardized [FragmentItemFactory].
* [AssemblyPagingDataFragmentStateAdapter] will use the data corresponding to position to find a matching [FragmentItemFactory] (cannot find an exception will be thrown),
* and then use [FragmentItemFactory] to create an [Fragment]
*
* @param itemFactoryList The collection of [FragmentItemFactory] passed in from outside, cannot be empty.
* Each type of data in the data set must have a matching [FragmentItemFactory], otherwise an exception will be thrown
* @param diffCallback DiffUtil comparison data callback, the default is [KeyEqualsDiffItemCallback]
* @see FragmentItemFactory
*/
open class AssemblyPagingDataFragmentStateAdapter<DATA : Any>(
fragmentManager: FragmentManager,
lifecycle: Lifecycle,
itemFactoryList: List<FragmentItemFactory<out Any>>,
diffCallback: DiffUtil.ItemCallback<DATA> = KeyEqualsDiffItemCallback(),
mainDispatcher: CoroutineDispatcher = Dispatchers.Main,
workerDispatcher: CoroutineDispatcher = Dispatchers.Default,
) : PagingDataFragmentStateAdapter<DATA, RecyclerView.ViewHolder>(
fragmentManager, lifecycle, diffCallback, mainDispatcher, workerDispatcher
), AssemblyAdapter<DATA, FragmentItemFactory<out Any>> {
private val itemFactoryStorage = ItemFactoryStorage(
itemFactoryList, "ItemFactory", "AssemblyPagingDataAdapter", "itemFactoryList"
)
private var recyclerView: RecyclerView? = null
private val concatAdapterAbsoluteHelper = ConcatAdapterAbsoluteHelper()
/**
* Returns a new [ItemSnapshotList] representing the currently presented items, including any
* placeholders if they are enabled.
*/
val currentList: ItemSnapshotList<DATA>
get() = snapshot()
/**
* Get [FragmentManager] and [Lifecycle] from [FragmentActivity] to create [AssemblyPagingDataFragmentStateAdapter]
*
* @param itemFactoryList The collection of [FragmentItemFactory] passed in from outside, cannot be empty.
* Each type of data in the data set must have a matching [FragmentItemFactory], otherwise an exception will be thrown
* @param diffCallback DiffUtil comparison data callback, the default is [KeyEqualsDiffItemCallback]
*/
constructor(
fragmentActivity: FragmentActivity,
itemFactoryList: List<FragmentItemFactory<out Any>>,
diffCallback: DiffUtil.ItemCallback<DATA> = KeyEqualsDiffItemCallback(),
mainDispatcher: CoroutineDispatcher = Dispatchers.Main,
workerDispatcher: CoroutineDispatcher = Dispatchers.Default,
) : this(
fragmentActivity.supportFragmentManager,
fragmentActivity.lifecycle,
itemFactoryList,
diffCallback,
mainDispatcher,
workerDispatcher,
)
/**
* Get [FragmentManager] and [Lifecycle] from [Fragment] to create [AssemblyPagingDataFragmentStateAdapter]
*
* @param itemFactoryList The collection of [FragmentItemFactory] passed in from outside, cannot be empty.
* Each type of data in the data set must have a matching [FragmentItemFactory], otherwise an exception will be thrown
* @param diffCallback DiffUtil comparison data callback, the default is [KeyEqualsDiffItemCallback]
*/
constructor(
fragment: Fragment,
itemFactoryList: List<FragmentItemFactory<out Any>>,
diffCallback: DiffUtil.ItemCallback<DATA> = KeyEqualsDiffItemCallback(),
mainDispatcher: CoroutineDispatcher = Dispatchers.Main,
workerDispatcher: CoroutineDispatcher = Dispatchers.Default,
) : this(
fragment.childFragmentManager,
fragment.lifecycle,
itemFactoryList,
diffCallback,
mainDispatcher,
workerDispatcher,
)
init {
require(itemFactoryList.isNotEmpty()) { "itemFactoryList Can not be empty" }
if (diffCallback is KeyEqualsDiffItemCallback) {
KeyEqualsDiffItemCallback.checkDataClass(
itemFactoryList.map { it.dataClass }.filter { it.java != Placeholder::class.java }
)
}
}
fun getItemData(position: Int): DATA? {
return peek(position)
}
override fun getItemViewType(position: Int): Int {
val data = peek(position) ?: Placeholder
return itemFactoryStorage.getItemTypeByData(data)
}
override fun createFragment(position: Int): Fragment {
// Here you must use the getItem method to trigger append load
val data = getItem(position) ?: Placeholder
@Suppress("UnnecessaryVariable") val bindingAdapterPosition = position
val parentAdapter = recyclerView?.adapter
val absoluteAdapterPosition = if (parentAdapter is ConcatAdapter) {
concatAdapterAbsoluteHelper.findAbsoluteAdapterPosition(parentAdapter, this, position)
} else {
bindingAdapterPosition
}
@Suppress("UNCHECKED_CAST")
val itemFactory = itemFactoryStorage.getItemFactoryByData(data) as FragmentItemFactory<Any>
return itemFactory.dispatchCreateFragment(
bindingAdapterPosition, absoluteAdapterPosition, data
)
}
override fun getItemFactoryByPosition(position: Int): FragmentItemFactory<Any> {
val data = peek(position) ?: Placeholder
return itemFactoryStorage.getItemFactoryByData(data) as FragmentItemFactory<Any>
}
override fun getItemFactoryByData(data: DATA): FragmentItemFactory<Any> {
return itemFactoryStorage.getItemFactoryByData(data) as FragmentItemFactory<Any>
}
override fun <T : FragmentItemFactory<out Any>> getItemFactoryByClass(itemFactoryClass: Class<T>): T {
return itemFactoryStorage.getItemFactoryByClass(itemFactoryClass)
}
override fun onAttachedToRecyclerView(recyclerView: RecyclerView) {
super.onAttachedToRecyclerView(recyclerView)
this.recyclerView = recyclerView
}
override fun onDetachedFromRecyclerView(recyclerView: RecyclerView) {
super.onDetachedFromRecyclerView(recyclerView)
this.recyclerView = null
}
}