litho-core/com.facebook.litho/TreeState

TreeState

class TreeState

Constructors

constructor(fromState: TreeState? = null, effectsHandler: EffectHandler? = null)

constructor(initialResolveState: InitialState, initialLayoutState: InitialState)

Types

object Companion

class TreeMountInfo

This class represents whether this Litho tree has been mounted before. The usage is a bit convoluted and will need to be cleaned out properly in the future.

Properties

val effectsHandler: EffectHandler

eventHandlersController

@get:VisibleForTesting

val eventHandlersController: EventHandlersController

val isEmpty: Boolean

keysForAppliedStateUpdates

val keysForAppliedStateUpdates: Set<GlobalKey>

keysForPendingStateUpdates

val keysForPendingStateUpdates: Set<GlobalKey>

val layoutState: StateHandler

val mountInfo: TreeState.TreeMountInfo

pendingStateUpdateTransitions

val pendingStateUpdateTransitions: List<Transition>

val resolveState: StateHandler

Functions

addMountUpdates

fun addMountUpdates(updates: Set<StateId>)

fun addState(key: GlobalKey, state: ComponentState<*>, isLayoutState: Boolean)

applyLazyStateUpdatesForContainer

fun applyLazyStateUpdatesForContainer(key: StateId, container: StateContainer, isNestedTree: Boolean): StateContainer

applyStateUpdatesEarly

fun applyStateUpdatesEarly(context: ComponentContext, component: Component?, prevTreeRootNode: LithoNode?, isLayoutState: Boolean)

canSkipStateUpdate

fun <T> canSkipStateUpdate(stateId: StateId, newValue: T, isLayoutState: Boolean): Boolean

fun <T> canSkipStateUpdate(updater: (T) -> T, stateId: StateId, isLayoutState: Boolean): Boolean

clearEventHandlersAndTriggers

fun clearEventHandlersAndTriggers()

clearUnusedTriggerHandlers

fun clearUnusedTriggerHandlers()

fun commit()

commitLayoutState

fun commitLayoutState(localTreeState: TreeState, trackForPromotion: Boolean = false, resolveVersion: Int = UNSET_VERSION)

commitResolveState

fun commitResolveState(localTreeState: TreeState, trackForPromotion: Boolean = false, resolveVersion: Int = UNSET_VERSION)

consumeMountUpdates

fun consumeMountUpdates(): Set<StateId>

createOrGetEventDispatchInfoForComponent

fun createOrGetEventDispatchInfoForComponent(scopedContext: ComponentContext, component: Component, key: GlobalKey): EventDispatchInfo

createOrGetInitialHookStateByHookKey

fun <T> createOrGetInitialHookStateByHookKey(key: GlobalKey, hookKey: HookKey, deps: Array<*>, initializer: HookInitializer<T>, isLayoutState: Boolean, componentName: String): ComponentState<KStateContainer>

createOrGetState

fun createOrGetState(scopedContext: ComponentContext, component: Component, key: GlobalKey): ComponentState<out StateContainer>

fun TreeState.enqueue(update: PendingStateUpdate): TreeState

fun TreeState.enqueue(updates: List<PendingStateUpdate>): TreeState

fun getCachedValue(cacheKey: HookGlobalKey, cachedValueInputs: Any, isLayoutState: Boolean): Any?

getEventTrigger

fun getEventTrigger(triggerKey: Any): EventTrigger<*>?

fun getEventTrigger(handle: Handle, methodId: Int): EventTrigger<*>?

fun getState(key: GlobalKey, isLayoutState: Boolean): ComponentState<out StateContainer>?

getStateIdsForPendingLayoutStateUpdates

fun getStateIdsForPendingLayoutStateUpdates(): Set<StateId>

getStateIdsForPendingResolveStateUpdates

fun getStateIdsForPendingResolveStateUpdates(): Set<StateId>

getStateIdsForPendingStateUpdates

fun getStateIdsForPendingStateUpdates(): Set<StateId>

getUpdatesForPromotion

fun getUpdatesForPromotion(localTreeState: TreeState): Map<StateId, Int>

Computes the effective updates for promotion by combining both resolve and layout handlers.

hasUncommittedUpdates

fun hasUncommittedUpdates(): Boolean

markAllStateInUse

fun markAllStateInUse(isLayoutState: Boolean)

fun markStateInUse(key: GlobalKey, isLayoutState: Boolean)

peekOrSeedInitialHookStateByHookKey

fun <T> peekOrSeedInitialHookStateByHookKey(key: GlobalKey, hookKey: HookKey, deps: Array<*>, initializer: HookInitializer<T>, isLayoutState: Boolean, componentName: String): CachedValue

fun putCachedValue(cacheKey: HookGlobalKey, cachedValueInputs: Any, cachedValue: Any?, isLayoutState: Boolean)

queueHookStateUpdate

fun queueHookStateUpdate(stateId: StateId, updater: HookUpdater, isLayoutState: Boolean)

queueStateUpdate

fun queueStateUpdate(key: StateId, stateUpdate: StateContainer.StateUpdate, isLazyStateUpdate: Boolean, isLayoutState: Boolean)

recordRenderData

fun recordRenderData(layoutState: LayoutState)

removePendingStateUpdate

fun removePendingStateUpdate(key: StateId, isLayoutState: Boolean)

subtractPromotedUpdates

fun subtractPromotedUpdates(promoted: Map<StateId, Int>)

Subtracts promoted counts from both resolve and layout handlers.

updateEventDispatchers

fun updateEventDispatchers(toUpdate: List<ScopedComponentInfo>)