com.facebook.litho.sections.widget

Class RecyclerBinderConfiguration.Builder

java.lang.Object

com.facebook.litho.sections.widget.RecyclerBinderConfiguration.Builder

Enclosing class:

RecyclerBinderConfiguration

public static class RecyclerBinderConfiguration.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static LayoutThreadPoolConfiguration	DEFAULT_THREAD_POOL_CONFIG

Method Summary

Modifier and Type	Method and Description
RecyclerBinderConfiguration	build()
RecyclerBinderConfiguration.Builder	canInterruptAndMoveLayoutsBetweenThreads(boolean isEnabled)
RecyclerBinderConfiguration.Builder	changeSetThreadHandler(LithoHandler changeSetThreadHandler)
RecyclerBinderConfiguration.Builder	componentWarmer(ComponentWarmer componentWarmer)
RecyclerBinderConfiguration.Builder	enableDetach(boolean enableDetach) If true, detach components under the hood when RecyclerBinder#detach() is called.
RecyclerBinderConfiguration.Builder	enableStableIds(boolean enableStableIds)
RecyclerBinderConfiguration.Builder	estimatedViewportCount(int estimatedViewportCount) Deprecated.
RecyclerBinderConfiguration.Builder	hasDynamicItemHeight(boolean hasDynamicItemHeight) TODO T23919104 mihaelao Do not enable this.
RecyclerBinderConfiguration.Builder	hScrollAsyncMode(boolean hScrollAsyncMode) Experimental.
RecyclerBinderConfiguration.Builder	idleExecutor(LayoutHandlerFactory idleExecutor)
RecyclerBinderConfiguration.Builder	invalidStateLogParamsList(List<ComponentLogParams> invalidStateLogParamsList)
RecyclerBinderConfiguration.Builder	isCircular(boolean isCircular)
RecyclerBinderConfiguration.Builder	isLayoutDiffingEnabled(boolean isEnabled)
RecyclerBinderConfiguration.Builder	isReconciliationEnabled(boolean isEnabled)
RecyclerBinderConfiguration.Builder	lithoViewFactory(LithoViewFactory lithoViewFactory)
RecyclerBinderConfiguration.Builder	postToFrontOfQueueForFirstChangeset(boolean postToFrontOfQueueForFirstChangeset)
RecyclerBinderConfiguration.Builder	rangeRatio(float rangeRatio)
RecyclerBinderConfiguration.Builder	recyclingMode(int recyclingMode)
RecyclerBinderConfiguration.Builder	threadPoolConfiguration(LayoutThreadPoolConfiguration threadPoolConfiguration) Null value will fall back to the non-null default one.
RecyclerBinderConfiguration.Builder	useBackgroundChangeSets(boolean useBackgroundChangeSets) Experimental.
RecyclerBinderConfiguration.Builder	useCancelableLayoutFutures(boolean isEnabled)
RecyclerBinderConfiguration.Builder	wrapContent(boolean isWrapContent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_THREAD_POOL_CONFIG

public static final LayoutThreadPoolConfiguration DEFAULT_THREAD_POOL_CONFIG

Method Detail

idleExecutor

public RecyclerBinderConfiguration.Builder idleExecutor(LayoutHandlerFactory idleExecutor)

Parameters:

idleExecutor - This determines the thread on which the Component layout calculation will be processed in. Null means that the computation will be done in the background thread.

invalidStateLogParamsList

public RecyclerBinderConfiguration.Builder invalidStateLogParamsList(List<ComponentLogParams> invalidStateLogParamsList)

threadPoolConfiguration

public RecyclerBinderConfiguration.Builder threadPoolConfiguration(LayoutThreadPoolConfiguration threadPoolConfiguration)

Null value will fall back to the non-null default one.

rangeRatio

public RecyclerBinderConfiguration.Builder rangeRatio(float rangeRatio)

Parameters:

rangeRatio - Ratio to determine the number of components before and after the androidx.recyclerview.widget.RecyclerView's total number of currently visible items to have their Component layout computed ahead of time.

e.g total number of visible items = 5 rangeRatio = 10 total number of items before the 1st visible item to be computed = 5 * 10 = 50 total number of items after the last visible item to be computed = 5 * 10 = 50

isCircular

public RecyclerBinderConfiguration.Builder isCircular(boolean isCircular)

Parameters:

isCircular - If true, the underlying RecyclerBinder will have a circular behaviour. Note: circular lists DO NOT support any operation that changes the size of items like insert, remove, insert range, remove range

wrapContent

public RecyclerBinderConfiguration.Builder wrapContent(boolean isWrapContent)

Parameters:

isWrapContent - If true, the underlying RecyclerBinder will measure the parent height by the height of children if the orientation is vertical, or measure the parent width by the width of children if the orientation is horizontal.

hasDynamicItemHeight

public RecyclerBinderConfiguration.Builder hasDynamicItemHeight(boolean hasDynamicItemHeight)

TODO T23919104 mihaelao Do not enable this. This is an experimental feature and your Section surface will take a perf hit if you use it. Talk to the Litho team if you think you need this.

useBackgroundChangeSets

public RecyclerBinderConfiguration.Builder useBackgroundChangeSets(boolean useBackgroundChangeSets)

Experimental. See SectionTree.Target#supportsBackgroundChangeSets() for more info.

hScrollAsyncMode

public RecyclerBinderConfiguration.Builder hScrollAsyncMode(boolean hScrollAsyncMode)

Experimental. See RecyclerBinder.Builder#hscrollAsyncMode(boolean) for more info.

enableStableIds

public RecyclerBinderConfiguration.Builder enableStableIds(boolean enableStableIds)

canInterruptAndMoveLayoutsBetweenThreads

public RecyclerBinderConfiguration.Builder canInterruptAndMoveLayoutsBetweenThreads(boolean isEnabled)

useCancelableLayoutFutures

public RecyclerBinderConfiguration.Builder useCancelableLayoutFutures(boolean isEnabled)

changeSetThreadHandler

public RecyclerBinderConfiguration.Builder changeSetThreadHandler(LithoHandler changeSetThreadHandler)

enableDetach

public RecyclerBinderConfiguration.Builder enableDetach(boolean enableDetach)

If true, detach components under the hood when RecyclerBinder#detach() is called.

isReconciliationEnabled

public RecyclerBinderConfiguration.Builder isReconciliationEnabled(boolean isEnabled)

recyclingMode

public RecyclerBinderConfiguration.Builder recyclingMode(int recyclingMode)

isLayoutDiffingEnabled

public RecyclerBinderConfiguration.Builder isLayoutDiffingEnabled(boolean isEnabled)

postToFrontOfQueueForFirstChangeset

public RecyclerBinderConfiguration.Builder postToFrontOfQueueForFirstChangeset(boolean postToFrontOfQueueForFirstChangeset)

componentWarmer

public RecyclerBinderConfiguration.Builder componentWarmer(ComponentWarmer componentWarmer)

lithoViewFactory

public RecyclerBinderConfiguration.Builder lithoViewFactory(LithoViewFactory lithoViewFactory)

estimatedViewportCount

@Deprecated
public RecyclerBinderConfiguration.Builder estimatedViewportCount(int estimatedViewportCount)

Deprecated.

This is a temporary hack that allows a surface to manually provide an estimated range. It will go away so don't depend on it.

build

public RecyclerBinderConfiguration build()