recycler/co.anitrend.arch.recycler.adapter/SupportListAdapter

SupportListAdapter

abstract class SupportListAdapter<T>(differCallback: DiffUtil.ItemCallback<T>, supportsStableIds: Boolean = false) : ListAdapter<T, SupportViewHolder> , SupportAdapter<T>

Core implementation for handling complex logic for Lists and androidx.recyclerview.widget.RecyclerView.ViewHolder binding logic

Since

v1.2.0

Parameters

differCallback

Callback for calculating the diff between two non-null items in a list.

supportsStableIds

Sets PagedListAdapter.setHasStableIds which is defaulted to true

Constructors

SupportListAdapter

constructor(differCallback: DiffUtil.ItemCallback<T>, supportsStableIds: Boolean = false)

Properties

open override val clickableFlow: MutableStateFlow<ClickableItem>

An observer to listen for clicks on clickable items

open override val controller: SupportAdapterController<T>

Special dispatcher controller for custom logic handling

customSupportAnimator

abstract val customSupportAnimator: AbstractAnimator?

Get currently set animation type for recycler view holder items

isUsingConcatAdapter

open override var isUsingConcatAdapter: Boolean

Internal use only indicator for checking against the use of a concat adapter for headers and footers, which is in turn used to figure out how to get the view holder id

lastAnimatedPosition

open override var lastAnimatedPosition: Int

abstract val mapper: (T) -> IRecyclerItem

Mapper for adapters to converting models to recycler items

abstract val resources: Resources

stateConfiguration

abstract val stateConfiguration: IStateLayoutConfig

Configuration for the state based footer

abstract val supportAction: ISupportSelectionMode<Long>?

Assigned if the current adapter supports needs to supports action mode

Functions

animateViewHolder

open fun animateViewHolder(holder: SupportViewHolder?, position: Int)

Applies an animation on a SupportViewHolder when it is seen for the first time

fun bindViewHolder(@NonNull p0: SupportViewHolder, p1: Int)

bindViewHolderByType

open fun bindViewHolderByType(holder: SupportViewHolder, position: Int, payloads: List<Any> = emptyList())

Binds view holder by view type at position

createDefaultViewHolder

abstract fun createDefaultViewHolder(parent: ViewGroup, @LayoutRes viewType: Int, layoutInflater: LayoutInflater): SupportViewHolder

Should provide the required view holder, this function is a substitute for androidx.recyclerview.widget.RecyclerView.Adapter.onCreateViewHolder which now has extended functionality

createViewHolder

fun createViewHolder(@NonNull p0: ViewGroup, p1: Int): SupportViewHolder

findRelativeAdapterPositionIn

open fun findRelativeAdapterPositionIn(@NonNull p0: RecyclerView.Adapter<out RecyclerView.ViewHolder>, @NonNull p1: RecyclerView.ViewHolder, p2: Int): Int

open fun getCurrentList(): MutableList<T>

open override fun getItemCount(): Int

open override fun getItemId(position: Int): Long

Return the stable ID for the item at position. If hasStableIds would return false this method should return RecyclerView.NO_ID.

getItemViewType

open override fun getItemViewType(position: Int): Int

Return the view type of the item at position for the purposes of view recycling.

getSpanSizeForItemAt

open fun getSpanSizeForItemAt(position: Int, spanCount: Int?): Int?

Should return the span size for the item at position, when called from androidx.recyclerview.widget.GridLayoutManager will be the span size for the item at the position.

open fun getStableIdFor(item: T?): Long

Used to get stable ids for androidx.recyclerview.widget.RecyclerView.Adapter but only if androidx.recyclerview.widget.RecyclerView.Adapter.setHasStableIds is set to true.

getStateRestorationPolicy

fun getStateRestorationPolicy(): RecyclerView.Adapter.StateRestorationPolicy

fun hasObservers(): Boolean

fun hasStableIds(): Boolean

fun ISupportAdapter<*>.isEmpty(): Boolean

Check if ISupportAdapter ->SupportListAdapter contains any list items

notifyDataSetChanged

fun notifyDataSetChanged()

notifyDataSetNeedsRefreshing

open override fun notifyDataSetNeedsRefreshing()

Informs view adapter of changes related to it's view holder

notifyItemChanged

fun notifyItemChanged(p0: Int)

fun notifyItemChanged(p0: Int, @Nullable p1: Any?)

notifyItemInserted

fun notifyItemInserted(p0: Int)

notifyItemMoved

fun notifyItemMoved(p0: Int, p1: Int)

notifyItemRangeChanged

fun notifyItemRangeChanged(p0: Int, p1: Int)

fun notifyItemRangeChanged(p0: Int, p1: Int, @Nullable p2: Any?)

notifyItemRangeInserted

fun notifyItemRangeInserted(p0: Int, p1: Int)

notifyItemRangeRemoved

fun notifyItemRangeRemoved(p0: Int, p1: Int)

notifyItemRemoved

fun notifyItemRemoved(p0: Int)

onAttachedToRecyclerView

open override fun onAttachedToRecyclerView(recyclerView: RecyclerView)

Called by RecyclerView when it starts observing this Adapter.

onBindViewHolder

open override fun onBindViewHolder(holder: SupportViewHolder, position: Int)

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

Calls the the recycler view holder to perform view binding, and selection mode decorations are set up

open override fun onCreate(owner: LifecycleOwner)

onCreateViewHolder

open override fun onCreateViewHolder(parent: ViewGroup, @LayoutRes viewType: Int): SupportViewHolder

Overridden implementation createDefaultViewHolder calls to resolve the view holder type

onCurrentListChanged

open fun onCurrentListChanged(@NonNull p0: MutableList<T>, @NonNull p1: MutableList<T>)

open override fun onDestroy(owner: LifecycleOwner)

onDetachedFromRecyclerView

open fun onDetachedFromRecyclerView(@NonNull p0: RecyclerView)

onFailedToRecycleView

open fun onFailedToRecycleView(@NonNull p0: SupportViewHolder): Boolean

open override fun onPause(owner: LifecycleOwner)

Notifies that ON_PAUSE event occurred.

open override fun onResume(owner: LifecycleOwner)

open override fun onStart(owner: LifecycleOwner)

open override fun onStop(owner: LifecycleOwner)

onViewAttachedToWindow

open override fun onViewAttachedToWindow(holder: SupportViewHolder)

Called when a view created by this adapter has been attached to a window.

onViewDetachedFromWindow

open override fun onViewDetachedFromWindow(holder: SupportViewHolder)

Called when a view created by this adapter has been detached from its window.

open override fun onViewRecycled(holder: SupportViewHolder)

Calls the the recycler view holder impl to perform view recycling

registerAdapterDataObserver

open fun registerAdapterDataObserver(@NonNull p0: RecyclerView.AdapterDataObserver)

open override fun requireItem(position: Int): T

Returns the non-nullable item for this adapter

setHasStableIds

open fun setHasStableIds(p0: Boolean)

setLayoutSpanSize

open fun setLayoutSpanSize(layoutManager: GridLayoutManager)

open fun setLayoutSpanSize(layoutParams: StaggeredGridLayoutManager.LayoutParams, position: Int)

Initial implementation is only specific for group types of recyclers, in order to customize this an override is required.

open fun setLoadState(state: LoadState)

Sets loading state

setStateRestorationPolicy

open fun setStateRestorationPolicy(@NonNull p0: RecyclerView.Adapter.StateRestorationPolicy)

open fun submitList(@Nullable p0: MutableList<T>?)

open fun submitList(@Nullable p0: MutableList<T>?, @Nullable p1: Runnable?)

unregisterAdapterDataObserver

open fun unregisterAdapterDataObserver(@NonNull p0: RecyclerView.AdapterDataObserver)

withLoadStateFooter

open fun withLoadStateFooter(footer: SupportLoadStateAdapter): ConcatAdapter

Create a ConcatAdapter with the provided SupportLoadStateAdapters

withLoadStateHeader

open fun withLoadStateHeader(header: SupportLoadStateAdapter): ConcatAdapter

Create a ConcatAdapter with the provided SupportLoadStateAdapters

withLoadStateHeaderAndFooter

open fun withLoadStateHeaderAndFooter(header: SupportLoadStateAdapter, footer: SupportLoadStateAdapter): ConcatAdapter

Create a ConcatAdapter with the provided SupportLoadStateAdapters