litho-widget/com.facebook.litho.widget/RecyclerBinder

RecyclerBinder

@ThreadSafe

open class RecyclerBinder : Binder<V> , LayoutInfo.RenderInfoCollection, HasStickyHeader

This binder class is used to asynchronously layout Components given a list of Component and attaching them to a Recycler.

Types

Builder

class Builder

CommitPolicy

@Retention(value = RetentionPolicy.SOURCE)

annotation class CommitPolicy

Defines when a batch should be committed: - IMMEDIATE: Commit batches to the RecyclerView as soon as possible.

PaginationStrategy

annotation class PaginationStrategy

RecyclerViewLayoutManagerOverrideParams

open class RecyclerViewLayoutManagerOverrideParams : RecyclerView.LayoutParams, LithoView.LayoutManagerOverrideParams

RecyclingStrategy

annotation class RecyclingStrategy

Strategies for recycling layouts of items in binder

Properties

ID_CUSTOM_ATTR_KEY

val ID_CUSTOM_ATTR_KEY: String = "id"

Functions

appendItem

@UiThread

fun appendItem(component: Component)

See appendItem.

@UiThread

fun appendItem(renderInfo: RenderInfo)

Inserts a new item at tail.

clearAsync

fun clearAsync()

Removes all items in this binder async.

detach

open fun detach()

Detach items under the hood.

findFirstFullyVisibleItemPosition

open fun findFirstFullyVisibleItemPosition(): Int

findFirstVisibleItemPosition

open fun findFirstVisibleItemPosition(): Int

findLastFullyVisibleItemPosition

open fun findLastFullyVisibleItemPosition(): Int

findLastVisibleItemPosition

open fun findLastVisibleItemPosition(): Int

getChildHeightSpec

open fun getChildHeightSpec(index: Int): Int

getChildWidthSpec

open fun getChildWidthSpec(index: Int): Int

getComponentAt

@Nullable

fun getComponentAt(position: Int): ComponentTree

Returns the ComponentTree for the item at index position.

getComponentForStickyHeaderAt

fun getComponentForStickyHeaderAt(position: Int): ComponentTree

getComponentTreeHolderAt

@UiThread

fun getComponentTreeHolderAt(position: Int): ComponentTreeHolder

getInternalAdapter

open fun getInternalAdapter(): RecyclerView.Adapter

getItemCount

open fun getItemCount(): Int

Gets the number of items currently in the adapter attached to this binder (i.e.

getMeasuredHeight

@VisibleForTesting

open fun getMeasuredHeight(): Int

getMeasuredWidth

@VisibleForTesting

open fun getMeasuredWidth(): Int

getRenderInfoAt

@UiThread

fun getRenderInfoAt(position: Int): RenderInfo

insertItemAt

@UiThread

fun insertItemAt(position: Int, component: Component)

See insertItemAt.

@UiThread

fun insertItemAt(position: Int, renderInfo: RenderInfo)

Inserts a new item at position.

insertItemAtAsync

fun insertItemAtAsync(position: Int, renderInfo: RenderInfo)

Inserts an item at position.

insertRangeAt

@UiThread

fun insertRangeAt(position: Int, renderInfos: List<RenderInfo>)

Inserts the new items starting from position.

insertRangeAtAsync

fun insertRangeAtAsync(position: Int, renderInfos: List<RenderInfo>)

Inserts the new items starting from position.

isCrossAxisWrapContent

open fun isCrossAxisWrapContent(): Boolean

Return true if wrap content is enabled for the cross axis, false otherwise.

isMainAxisWrapContent

open fun isMainAxisWrapContent(): Boolean

Return true if wrap content is enabled for the main axis, false otherwise.

isSticky

@UiThread

open fun isSticky(position: Int): Boolean

isValidPosition

@UiThread

open fun isValidPosition(position: Int): Boolean

measure

open fun measure(outSize: Size, widthSpec: Int, heightSpec: Int, @Nullable reMeasureEventHandler: EventHandler<ReMeasureEvent>)

A component mounting a RecyclerView can use this method to determine its size.

mount

@UiThread

open fun mount(view: RecyclerView)

Call from the owning Component's onMount.

moveItem

@UiThread

fun moveItem(fromPosition: Int, toPosition: Int)

Moves an item from fromPosition to toPosition.

moveItemAsync

fun moveItemAsync(fromPosition: Int, toPosition: Int)

Moves an item from fromPosition to toPosition.

notifyChangeSetComplete

@UiThread

open fun notifyChangeSetComplete(isDataChanged: Boolean, @Nullable changeSetCompleteCallback: ChangeSetCompleteCallback)

Called after all the change set operations (inserts, removes, etc.) in a batch have completed.

notifyChangeSetCompleteAsync

open fun notifyChangeSetCompleteAsync(isDataChanged: Boolean, changeSetCompleteCallback: ChangeSetCompleteCallback)

Called after all the change set operations (inserts, removes, etc.) in a batch have completed.

notifyItemRenderCompleteAt

@UiThread

open fun notifyItemRenderCompleteAt(position: Int, timestampMillis: Long)

removeItemAt

@UiThread

fun removeItemAt(position: Int)

Removes an item from index position.

removeItemAtAsync

fun removeItemAtAsync(position: Int)

Removes an item from position.

removeRangeAt

@UiThread

fun removeRangeAt(position: Int, count: Int)

Removes count items starting from position.

removeRangeAtAsync

fun removeRangeAtAsync(position: Int, count: Int)

Removes count items starting from position.

removeSubAdapterModeRecyclerView

open fun removeSubAdapterModeRecyclerView(recyclerView: RecyclerView)

replaceAll

@UiThread

fun replaceAll(renderInfos: List<RenderInfo>)

Replaces all items in the RecyclerBinder with the provided RenderInfos.

scrollSmoothToPosition

@UiThread

open fun scrollSmoothToPosition(position: Int, offset: Int, type: SmoothScrollAlignmentType)

@UiThread

open fun scrollSmoothToPosition(id: Any, offset: Int, type: SmoothScrollAlignmentType)

scrollToPosition

@UiThread

open fun scrollToPosition(position: Int)

scrollToPositionWithOffset

@UiThread

open fun scrollToPositionWithOffset(position: Int, offset: Int)

@UiThread

open fun scrollToPositionWithOffset(id: Any, offset: Int)

setCommitPolicy

@AnyThread

open fun setCommitPolicy(commitPolicy: Int)

setSize

open fun setSize(width: Int, height: Int)

This should be called when the owner Component's onBoundsDefined is called.

setSubAdapterModeRecyclerView

open fun setSubAdapterModeRecyclerView(recyclerView: RecyclerView)

setViewportChangedListener

@UiThread

open fun setViewportChangedListener(@Nullable viewportChangedListener: ViewportInfo.ViewportChanged)

Bind a ViewportInfo.ViewportChanged listener to this Binder.

unmount

@UiThread

open fun unmount(view: RecyclerView)

Call from the owning Component's onUnmount.

updateItemAt

@UiThread

fun updateItemAt(position: Int, component: Component)

See updateItemAt.

@UiThread

fun updateItemAt(position: Int, renderInfo: RenderInfo)

Updates the item at position.

updateItemAtAsync

fun updateItemAtAsync(position: Int, renderInfo: RenderInfo)

Update the item at index position.

updateRangeAt

@UiThread

fun updateRangeAt(position: Int, renderInfos: List<RenderInfo>)

Updates the range of items starting at position.

updateRangeAtAsync

fun updateRangeAtAsync(position: Int, renderInfos: List<RenderInfo>)

Update the items starting from the given index position.

updateSubAdapterVisibleRange

open fun updateSubAdapterVisibleRange(firstVisiblePosition: Int, lastVisiblePosition: Int)

Updates the visible range when in sub adapter mode.

updateSubAdapterWorkingRange

open fun updateSubAdapterWorkingRange(firstVisibleIndex: Int, lastVisibleIndex: Int, firstFullyVisibleIndex: Int, lastFullyVisibleIndex: Int)

Updates the working range when in sub adapter mode.