litho-core/com.facebook.litho/ComponentTree

ComponentTree

open class ComponentTree : LithoVisibilityEventsListener, StateUpdater, MountedViewReference, ErrorComponentReceiver, LithoTreeLifecycleProvider

Represents a tree of components and controls their life cycle. ComponentTree takes in a single root component and recursively invokes its OnCreateLayout to create a tree of components. ComponentTree is responsible for refreshing the mounted state of a component with new props.

The usual use case for ComponentTree is: ComponentTree component = ComponentTree.create(context, MyComponent.create()); myHostView.setRoot(component);

Types

Builder

open class Builder

A builder class that can be used to create a ComponentTree.

MeasureListener

interface MeasureListener

NewLayoutStateReadyListener

interface NewLayoutStateReadyListener

Listener that will be notified when a new LayoutState is computed and ready to be committed to this ComponentTree.

Properties

INVALID_ID

val INVALID_ID: Int = -1

INVALID_LAYOUT_VERSION

val INVALID_LAYOUT_VERSION: Int = -1

SIZE_UNINITIALIZED

val SIZE_UNINITIALIZED: Int = -1

STATE_UPDATES_IN_LOOP_THRESHOLD

val STATE_UPDATES_IN_LOOP_THRESHOLD: Int = 50

Functions

acquireTreeState

open fun acquireTreeState(): TreeState

Provides a new instance of the TreeState that is initialized with the TreeState held by the ComponentTree.

addMeasureListener

open fun addMeasureListener(@Nullable measureListener: ComponentTree.MeasureListener)

The provided measureListener will be called when a valid layout is commited.

addOnReleaseListener

open fun addOnReleaseListener(listener: LithoTreeLifecycleProvider.OnReleaseListener)

applyLazyStateUpdatesForContainer

open fun applyLazyStateUpdatesForContainer(componentKey: String, container: StateContainer, isLayoutState: Boolean): StateContainer

cancelLayoutAndReleaseTree

open fun cancelLayoutAndReleaseTree()

canSkipStateUpdate

open fun <T> canSkipStateUpdate(globalKey: String, hookStateIndex: Int, @Nullable newValue: T, isLayoutState: Boolean): Boolean

open fun <T> canSkipStateUpdate(newValueFunction: (in T) -> out T, globalKey: String, hookStateIndex: Int, isLayoutState: Boolean): Boolean

checkWorkingRangeAndDispatch

open fun checkWorkingRangeAndDispatch(position: Int, firstVisibleIndex: Int, lastVisibleIndex: Int, firstFullyVisibleIndex: Int, lastFullyVisibleIndex: Int)

Check if the any child components stored in LayoutState have entered/exited the working range, and dispatch the event to trigger the corresponding registered methods.

clearMeasureListener

open fun clearMeasureListener(measureListener: ComponentTree.MeasureListener)

create

open fun create(context: ComponentContext): ComponentTree.Builder

open fun create(context: ComponentContext, @Nullable root: Component): ComponentTree.Builder

open fun create(context: ComponentContext, root: Component.Builder<out Any>): ComponentTree.Builder

open fun create(context: ComponentContext, @Nullable root: Component, @Nullable lifecycleProvider: LithoVisibilityEventsController): ComponentTree.Builder

createNestedComponentTree

open fun createNestedComponentTree(parentContext: ComponentContext): ComponentTree.Builder

open fun createNestedComponentTree(parentContext: ComponentContext, @Nullable component: Component): ComponentTree.Builder

Creates a ComponentTree nested inside the ComponentTree of the provided parentContext.

getCachedValue

@Nullable

open fun getCachedValue(globalKey: String, index: Int, cachedValueInputs: Any, isLayoutState: Boolean): Any

Returns a Cached value that is accessible across all re-render operations.

getCommittedLayoutState

@VisibleForTesting(otherwise = VisibleForTesting.NONE)

@Nullable

open fun getCommittedLayoutState(): LayoutState

getContext

open fun getContext(): ComponentContext

getDefaultLayoutThreadLooper

open fun getDefaultLayoutThreadLooper(): Looper

getEventTrigger

@Nullable

open fun getEventTrigger(triggerKey: String): EventTrigger

@Nullable

open fun getEventTrigger(handle: Handle, methodId: Int): EventTrigger

getId

open fun getId(): Int

getLifecycleProvider

@Nullable

open fun getLifecycleProvider(): LithoVisibilityEventsController

@Nullable

open fun getLifecycleProvider(context: ComponentContext): LithoVisibilityEventsController

getLithoConfiguration

open fun getLithoConfiguration(): LithoConfiguration

getLithoView

@UiThread

@Nullable

open fun getLithoView(): LithoView

getLogger

@Nullable

open fun getLogger(): ComponentsLogger

getLogTag

@Nullable

open fun getLogTag(): String

getMountedView

@Nullable

open fun getMountedView(): View

getNewLayoutStateReadyListener

@VisibleForTesting

@Nullable

open fun getNewLayoutStateReadyListener(): ComponentTree.NewLayoutStateReadyListener

getRoot

@Nullable

open fun getRoot(): Component

getSimpleName

@Nullable

open fun getSimpleName(): String

getTreeState

@Nullable

@VisibleForTesting

open fun getTreeState(): TreeState

hasCompatibleLayout

open fun hasCompatibleLayout(widthSpec: Int, heightSpec: Int): Boolean

hasMounted

open fun hasMounted(): Boolean

Whether this ComponentTree has been mounted at least once.

isFirstMount

open fun isFirstMount(): Boolean

isIncrementalMountEnabled

open fun isIncrementalMountEnabled(): Boolean

Returns whether incremental mount is enabled or not in this component.

isReconciliationEnabled

open fun isReconciliationEnabled(): Boolean

isReleased

open fun isReleased(): Boolean

isSubscribedToLifecycleProvider

open fun isSubscribedToLifecycleProvider(): Boolean

onErrorComponent

open fun onErrorComponent(component: Component)

onMovedToState

open fun onMovedToState(state: LithoVisibilityEventsController.LithoVisibilityState)

putCachedValue

open fun putCachedValue(globalKey: String, index: Int, cachedValueInputs: Any, cachedValue: Any, isLayoutState: Boolean)

Stores a Cached value that will be accessible across all re-render operations.

release

open fun release()

The contract is that in order to release a ComponentTree, you must do so from the main thread.

removeOnReleaseListener

open fun removeOnReleaseListener(listener: LithoTreeLifecycleProvider.OnReleaseListener)

removePendingStateUpdate

open fun removePendingStateUpdate(key: String, nestedTreeContext: Boolean)

Removes a state update that was previously enqueued if the state update has not been processed yet.

setDebugLogsBreadcrumb

open fun setDebugLogsBreadcrumb(@Nullable breadcrumb: String)

This method associates this ComponentTree debug logs with the given String This allows you to create an association of the ComponentTree with any identifier or sorts that enables you to trace the logs of this ComponentTree with the identifier.

setFirstMount

open fun setFirstMount(isFirstMount: Boolean)

setNewLayoutStateReadyListener

open fun setNewLayoutStateReadyListener(@Nullable listener: ComponentTree.NewLayoutStateReadyListener)

setRoot

open fun setRoot(@Nullable root: Component)

Update the root component.

setRootAndSizeSpecAsync

open fun setRootAndSizeSpecAsync(@Nullable root: Component, widthSpec: Int, heightSpec: Int)

Compute asynchronously a new layout with the given component root and sizes

open fun setRootAndSizeSpecAsync(@Nullable root: Component, widthSpec: Int, heightSpec: Int, @Nullable treePropContainer: TreePropContainer)

Compute asynchronously a new layout with the given component root, sizes and stored TreePropContainer.

setRootAndSizeSpecSync

open fun setRootAndSizeSpecSync(@Nullable root: Component, widthSpec: Int, heightSpec: Int)

Compute a new layout with the given component root and sizes

open fun setRootAndSizeSpecSync(@Nullable root: Component, widthSpec: Int, heightSpec: Int, @Nullable output: Size)

open fun setRootAndSizeSpecSync(@Nullable root: Component, widthSpec: Int, heightSpec: Int, @Nullable output: Size, @Nullable treePropContainer: TreePropContainer)

setRootAsync

open fun setRootAsync(@Nullable root: Component)

setRootSync

open fun setRootSync(@Nullable root: Component)

setSizeSpec

open fun setSizeSpec(widthSpec: Int, heightSpec: Int)

Update the width/height spec.

open fun setSizeSpec(widthSpec: Int, heightSpec: Int, @Nullable output: Size)

Same as setSizeSpec but fetches the resulting width/height in the given Size.

setSizeSpecAsync

open fun setSizeSpecAsync(widthSpec: Int, heightSpec: Int)

setVersionedRootAndSizeSpec

open fun setVersionedRootAndSizeSpec(@Nullable root: Component, widthSpec: Int, heightSpec: Int, @Nullable output: Size, @Nullable treePropContainer: TreePropContainer, externalRootVersion: Int)

setVersionedRootAndSizeSpecAsync

open fun setVersionedRootAndSizeSpecAsync(@Nullable root: Component, widthSpec: Int, heightSpec: Int, @Nullable output: Size, @Nullable treePropContainer: TreePropContainer, externalRootVersion: Int)

subscribeToLifecycleProvider

open fun subscribeToLifecycleProvider(lifecycleProvider: LithoVisibilityEventsController)

updateHookStateAsync

fun updateHookStateAsync(globalKey: String, updater: HookUpdater, attribution: String, isCreateLayoutInProgress: Boolean, isLayoutState: Boolean)

Same as updateStateAsync but for Hook State.

updateHookStateSync

fun updateHookStateSync(globalKey: String, updater: HookUpdater, attribution: String, isCreateLayoutInProgress: Boolean, isLayoutState: Boolean)

Same as updateStateSync but for Hook State.

updateLayoutThreadHandler

open fun updateLayoutThreadHandler(@Nullable layoutThreadHandler: RunnableHandler)

Provide custom RunnableHandler.

updateStateAsync

@VisibleForTesting

open fun updateStateAsync(componentKey: String, stateUpdate: StateContainer.StateUpdate, attribution: String, isCreateLayoutInProgress: Boolean)

open fun updateStateAsync(componentKey: String, stateUpdate: StateContainer.StateUpdate, attribution: String, isCreateLayoutInProgress: Boolean, isLayoutState: Boolean)

Enqueues a state update that will schedule a new render on a Thread controlled by the Litho infrastructure.

updateStateLazy

open fun updateStateLazy(componentKey: String, stateUpdate: StateContainer.StateUpdate, isLayoutState: Boolean)

Enqueues a state update that will not schedule a new render.

updateStateSync

open fun updateStateSync(componentKey: String, stateUpdate: StateContainer.StateUpdate, attribution: String, isCreateLayoutInProgress: Boolean, isLayoutState: Boolean)

Enqueues a state update that will schedule a new render on the calling thread at the end of its current run-loop.