RecyclerBinder.Builder

java.lang.Object
- com.facebook.litho.widget.RecyclerBinder.Builder

Enclosing class:: RecyclerBinder

public static class RecyclerBinder.Builder
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field and Description

static float DEFAULT_RANGE_RATIO

Fields
Modifier and Type	Field and Description
`static float`	`DEFAULT_RANGE_RATIO`

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecyclerBinder.Builder`	`acquireStateHandlerOnRelease(boolean acquireStateHandlerOnRelease)` Defaults to true.
`RecyclerBinder.Builder`	`asyncInsertLayoutHandler(RunnableHandler handler)`
`RecyclerBinder`	`build(ComponentContext c)`
`RecyclerBinder.Builder`	`canInterruptAndMoveLayoutsBetweenThreads(boolean isEnabled)` Experimental, do not use! If enabled, a layout computation can be interrupted on a bg thread and resumed on the UI thread if it's needed immediately.
`RecyclerBinder.Builder`	`canMeasure(boolean canMeasure)` Only for horizontally scrolling layouts! If true, the height of the RecyclerView is not known when it's measured; the first item is measured and its height will determine the height of the RecyclerView.
`RecyclerBinder.Builder`	`componentsConfiguration(ComponentsConfiguration componentsConfiguration)`
`RecyclerBinder.Builder`	`componentTreeHolderFactory(com.facebook.litho.widget.RecyclerBinder.ComponentTreeHolderFactory componentTreeHolderFactory)`
`RecyclerBinder.Builder`	`componentWarmer(ComponentWarmer componentWarmer)`
`RecyclerBinder.Builder`	`enableCustomViewType(int componentViewType)` Enable setting custom viewTypes on `ViewRenderInfo`s.
`RecyclerBinder.Builder`	`enableStableIds(boolean enableStableIds)` If set, the RecyclerView adapter will have stableId support turned on.
`RecyclerBinder.Builder`	`errorEventHandler(ErrorEventHandler errorEventHandler)`
`RecyclerBinder.Builder`	`estimatedViewportCount(int estimatedViewportCount)` This is used in very specific cases on critical performance paths where measuring the first item cannot be relied on to estimate the viewport count.
`RecyclerBinder.Builder`	`hasDynamicItemHeight(boolean hasDynamicItemHeight)` Do not enable this.
`RecyclerBinder.Builder`	`hscrollAsyncMode(boolean hscrollAsyncMode)` Experimental.
`RecyclerBinder.Builder`	`incrementalMount(boolean incrementalMount)` Don't use this.
`RecyclerBinder.Builder`	`invalidStateLogParamsList(java.util.List<ComponentLogParams> logParamsList)` Provide a list of `ComponentLogParams` that will be used to log invalid states in the LithoView, such as height being 0 while non-0 value was expected.
`RecyclerBinder.Builder`	`isCircular(boolean isCircular)` Whether the underlying RecyclerBinder will have a circular behaviour.
`RecyclerBinder.Builder`	`isLayoutDiffingEnabled(boolean isEnabled)`
`RecyclerBinder.Builder`	`isReconciliationEnabled(boolean isEnabled)`
`RecyclerBinder.Builder`	`isSubAdapter(boolean isSubAdapter)` Note: this is an advanced usage of RecyclerBinder that requires much more manual hand-holding of the RecyclerBinder than normal usage.
`RecyclerBinder.Builder`	`layoutHandlerFactory(LayoutHandlerFactory layoutHandlerFactory)`
`RecyclerBinder.Builder`	`layoutInfo(LayoutInfo layoutInfo)`
`RecyclerBinder.Builder`	`lithoLifecycleProvider(LithoLifecycleProvider lithoLifecycleProvider)`
`RecyclerBinder.Builder`	`lithoViewFactory(LithoViewFactory lithoViewFactory)`
`RecyclerBinder.Builder`	`preallocateMountContentHandler(RunnableHandler preallocateMountContentHandler)`
`RecyclerBinder.Builder`	`rangeRatio(float rangeRatio)`
`RecyclerBinder.Builder`	`recyclerRangeTraverser(RecyclerRangeTraverser traverser)` Set a custom range traverser
`RecyclerBinder.Builder`	`recyclerViewItemPrefetch(boolean recyclerViewItemPrefetch)` Set whether item prefetch should be enabled on the underlying RecyclerView.LayoutManager.
`RecyclerBinder.Builder`	`setAdapterDelegate(RecyclerBinderAdapterDelegate delegate)` Set a delegation to customize the adapter behaviour.
`RecyclerBinder.Builder`	`setItemViewCacheSize(int size)` Set the number of offscreen views to retain before adding them to the potentially shared recycled view pool.
`RecyclerBinder.Builder`	`shouldPreallocatePerMountSpec(boolean shouldPreallocatePerMountSpec)`
`RecyclerBinder.Builder`	`startupLogger(LithoStartupLogger logger)`
`RecyclerBinder.Builder`	`stickyHeaderControllerFactory(StickyHeaderControllerFactory stickyHeaderControllerFactory)` Sets a factory to be used to create a custom controller for sticky section headers
`RecyclerBinder.Builder`	`threadPoolConfig(LayoutThreadPoolConfiguration config)`
`RecyclerBinder.Builder`	`wrapContent(boolean wrapContent)` 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_RANGE_RATIO
```
public static final float DEFAULT_RANGE_RATIO
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - rangeRatio
```
public RecyclerBinder.Builder rangeRatio(float rangeRatio)
```
    Parameters:
    
    rangeRatio - specifies how big a range this binder should try to compute. The range is computed as number of items in the viewport (when the binder is measured) multiplied by the range ratio. The ratio is to be intended in both directions. For example a ratio of 1 means that if there are currently N components on screen, the binder should try to compute the layout for the N components before the first component on screen and for the N components after the last component on screen. If not set, defaults to 4f.
  - acquireStateHandlerOnRelease
```
public RecyclerBinder.Builder acquireStateHandlerOnRelease(boolean acquireStateHandlerOnRelease)
```
    Defaults to true. If false, when a ComponentTreeHolder is released because it exists the prepared range, the StateHandler of the ComponentTree will not be cached and restored when re-entering the range, so previous state will be lost.
  - layoutInfo
```
public RecyclerBinder.Builder layoutInfo(LayoutInfo layoutInfo)
```
    Parameters:
    
    layoutInfo - an implementation of LayoutInfo that will expose information about the LayoutManager this RecyclerBinder will use. If not set, it will default to a vertical list.
  - componentsConfiguration
```
public RecyclerBinder.Builder componentsConfiguration(ComponentsConfiguration componentsConfiguration)
```
  - layoutHandlerFactory
```
public RecyclerBinder.Builder layoutHandlerFactory(LayoutHandlerFactory layoutHandlerFactory)
```
    Parameters:
    
    layoutHandlerFactory - the RecyclerBinder will use this layoutHandlerFactory when creating ComponentTrees in order to specify on which thread layout calculation should happen.
  - lithoViewFactory
```
public RecyclerBinder.Builder lithoViewFactory(LithoViewFactory lithoViewFactory)
```
  - isCircular
```
public RecyclerBinder.Builder isCircular(boolean isCircular)
```
    Whether the underlying RecyclerBinder will have a circular behaviour. Defaults to false. Note: circular lists DO NOT support any operation that changes the size of items like insert, remove, insert range, remove range
  - wrapContent
```
public RecyclerBinder.Builder wrapContent(boolean wrapContent)
```
    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.
  - componentTreeHolderFactory
```
public RecyclerBinder.Builder componentTreeHolderFactory(com.facebook.litho.widget.RecyclerBinder.ComponentTreeHolderFactory componentTreeHolderFactory)
```
    Parameters:
    
    componentTreeHolderFactory - Factory to acquire a new ComponentTreeHolder. Defaults to RecyclerBinder.DEFAULT_COMPONENT_TREE_HOLDER_FACTORY.
  - preallocateMountContentHandler
```
public RecyclerBinder.Builder preallocateMountContentHandler(RunnableHandler preallocateMountContentHandler)
```
  - shouldPreallocatePerMountSpec
```
public RecyclerBinder.Builder shouldPreallocatePerMountSpec(boolean shouldPreallocatePerMountSpec)
```
  - recyclerViewItemPrefetch
```
public RecyclerBinder.Builder recyclerViewItemPrefetch(boolean recyclerViewItemPrefetch)
```
    Set whether item prefetch should be enabled on the underlying RecyclerView.LayoutManager. Defaults to false.
    ItemPrefetching feature of RecyclerView clashes with RecyclerBinder's compute range optimization and in certain scenarios (like sticky header) it might reset ComponentTree of LithoView while it is still on screen making it render blank or zero height.
  - setItemViewCacheSize
```
public RecyclerBinder.Builder setItemViewCacheSize(int size)
```
    Set the number of offscreen views to retain before adding them to the potentially shared recycled view pool.
    The offscreen view cache stays aware of changes in the attached adapter, allowing a LayoutManager to reuse those views unmodified without needing to return to the adapter to rebind them.
    
    Parameters:
    
    size - Number of views to cache offscreen before returning them to the general recycled view pool
  - hasDynamicItemHeight
```
public RecyclerBinder.Builder hasDynamicItemHeight(boolean hasDynamicItemHeight)
```
    Do not enable this. This is an experimental feature and your Section surface will take a perf hit if you use it.
    Whether the items of this RecyclerBinder can change height after the initial measure. Only applicable to horizontally scrolling RecyclerBinders. If true, the children of this h-scroll are all measured with unspecified height. When the ComponentTree of a child is remeasured, this will cause the RecyclerBinder to remeasure in case the height of the child changed and the RecyclerView needs to have a different height to account for it. This only supports changing the height of the item that triggered the remeasuring, not the height of all items in the h-scroll.
  - enableCustomViewType
```
public RecyclerBinder.Builder enableCustomViewType(int componentViewType)
```
    Enable setting custom viewTypes on ViewRenderInfos.
    After this is set, all ViewRenderInfos must be built with a custom viewType through ViewRenderInfo.Builder.customViewType(int), otherwise exception will be thrown.
    
    Parameters:
    
    componentViewType - the viewType to be used for Component types, provided through ComponentRenderInfo. Set this to a value that won't conflict with your custom viewTypes.
  - enableStableIds
```
public RecyclerBinder.Builder enableStableIds(boolean enableStableIds)
```
    If set, the RecyclerView adapter will have stableId support turned on. This is ideally what we want to do always but for now we need this as a parameter to make sure stable Ids are not breaking anything.
  - invalidStateLogParamsList
```
public RecyclerBinder.Builder invalidStateLogParamsList(java.util.List<ComponentLogParams> logParamsList)
```
    Provide a list of ComponentLogParams that will be used to log invalid states in the LithoView, such as height being 0 while non-0 value was expected.
  - threadPoolConfig
```
public RecyclerBinder.Builder threadPoolConfig(LayoutThreadPoolConfiguration config)
```
    Parameters:
    
    config - RecyclerBinder will use this LayoutThreadPoolConfiguration to create ThreadPoolLayoutHandler which will be used to calculate layout in pool of threads. However, this will create a new separate thread pool which might negatively affect the app's performance.
    Note: if layoutHandlerFactory(LayoutHandlerFactory) is provided, the handler created by the factory will be used instead of the one that would have been created by this config.
  - recyclerRangeTraverser
```
public RecyclerBinder.Builder recyclerRangeTraverser(RecyclerRangeTraverser traverser)
```
    Set a custom range traverser
  - setAdapterDelegate
```
public RecyclerBinder.Builder setAdapterDelegate(RecyclerBinderAdapterDelegate delegate)
```
    Set a delegation to customize the adapter behaviour.
  - estimatedViewportCount
```
public RecyclerBinder.Builder estimatedViewportCount(int estimatedViewportCount)
```
    This is used in very specific cases on critical performance paths where measuring the first item cannot be relied on to estimate the viewport count. It should not be used in the common case, use with caution.
  - canMeasure
```
public RecyclerBinder.Builder canMeasure(boolean canMeasure)
```
    Only for horizontally scrolling layouts! If true, the height of the RecyclerView is not known when it's measured; the first item is measured and its height will determine the height of the RecyclerView.
  - hscrollAsyncMode
```
public RecyclerBinder.Builder hscrollAsyncMode(boolean hscrollAsyncMode)
```
    Experimental. Configuration to change the behavior of HScroll's when they are nested within a vertical scroll. With this mode, the hscroll will attempt to compute all layouts in the background before mounting so that no layouts are computed on the main thread. All subsequent insertions will be treated with LAYOUT_BEFORE_INSERT policy to ensure those layouts also do not happen on the main thread.
  - incrementalMount
```
public RecyclerBinder.Builder incrementalMount(boolean incrementalMount)
```
    Don't use this. If false, turns off incremental mount for all subviews of this Recycler.
  - stickyHeaderControllerFactory
```
public RecyclerBinder.Builder stickyHeaderControllerFactory(StickyHeaderControllerFactory stickyHeaderControllerFactory)
```
    Sets a factory to be used to create a custom controller for sticky section headers
  - canInterruptAndMoveLayoutsBetweenThreads
```
public RecyclerBinder.Builder canInterruptAndMoveLayoutsBetweenThreads(boolean isEnabled)
```
    Experimental, do not use! If enabled, a layout computation can be interrupted on a bg thread and resumed on the UI thread if it's needed immediately.
  - isSubAdapter
```
public RecyclerBinder.Builder isSubAdapter(boolean isSubAdapter)
```
    Note: this is an advanced usage of RecyclerBinder that requires much more manual hand-holding of the RecyclerBinder than normal usage.
    In sub adapter mode, the RecyclerBinder doesn't control the entire RecyclerView, but instead just a part of it. This means that the RecyclerBinder can't mount to a RecyclerView and set its adapter, and it won't set a scroll listener on the RecyclerView.
    Instead, the internal adapter will need to be used/observed and plugged into some sort of multi-adapter that can multiplex the RecyclerView's requests between the different sub adapters.
    Additionally, since the RecyclerBinder will never mount to a RecyclerView, the owner of this RecyclerBinder must manually dispatch RecyclerBinder.updateSubAdapterVisibleRange(int, int) and RecyclerBinder.updateSubAdapterWorkingRange(int, int, int, int) events if this RecyclerBinder can contains more than a screens worth of content.
  - isReconciliationEnabled
```
public RecyclerBinder.Builder isReconciliationEnabled(boolean isEnabled)
```
  - isLayoutDiffingEnabled
```
public RecyclerBinder.Builder isLayoutDiffingEnabled(boolean isEnabled)
```
  - componentWarmer
```
public RecyclerBinder.Builder componentWarmer(ComponentWarmer componentWarmer)
```
  - startupLogger
```
public RecyclerBinder.Builder startupLogger(LithoStartupLogger logger)
```
  - asyncInsertLayoutHandler
```
public RecyclerBinder.Builder asyncInsertLayoutHandler(RunnableHandler handler)
```
  - errorEventHandler
```
public RecyclerBinder.Builder errorEventHandler(ErrorEventHandler errorEventHandler)
```
  - lithoLifecycleProvider
```
public RecyclerBinder.Builder lithoLifecycleProvider(LithoLifecycleProvider lithoLifecycleProvider)
```
  - build
```
public RecyclerBinder build(ComponentContext c)
```
    Parameters:
    
    c - The ComponentContext the RecyclerBinder will use.

Class RecyclerBinder.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_RANGE_RATIO

Constructor Detail

Builder

Method Detail

rangeRatio

acquireStateHandlerOnRelease

layoutInfo

componentsConfiguration

layoutHandlerFactory

lithoViewFactory

isCircular

wrapContent

componentTreeHolderFactory

preallocateMountContentHandler

shouldPreallocatePerMountSpec

recyclerViewItemPrefetch

setItemViewCacheSize

hasDynamicItemHeight

enableCustomViewType

enableStableIds

invalidStateLogParamsList

threadPoolConfig

recyclerRangeTraverser

setAdapterDelegate

estimatedViewportCount

canMeasure

hscrollAsyncMode

incrementalMount

stickyHeaderControllerFactory

canInterruptAndMoveLayoutsBetweenThreads

isSubAdapter

isReconciliationEnabled

isLayoutDiffingEnabled

componentWarmer

startupLogger

asyncInsertLayoutHandler

errorEventHandler

lithoLifecycleProvider

build