litho-core/com.facebook.litho/LithoLayoutContext

LithoLayoutContext

class LithoLayoutContext @JvmOverloads constructor(val treeId: Int, val cache: MeasuredResultCache, rootContext: ComponentContext?, treeState: TreeState?, val layoutVersion: Int, val rootComponentId: Int, val isAccessibilityEnabled: Boolean, val layoutCache: LayoutCache, currentDiffTree: DiffNode?, layoutStateFuture: TreeFuture<*>?, val scopesToUpdate: DirtyScopeIndex = DirtyScopeIndex.EMPTY) : CalculationContext

Wraps objects which should only be available for the duration of a LayoutState, to access them in other classes such as ComponentContext during layout state calculation. When the layout calculation finishes, the LayoutState reference is nullified. Using a wrapper instead of passing the instances directly helps with clearing out the reference from all objects that hold on to it, without having to keep track of all these objects to clear out the references.

Constructors

LithoLayoutContext

@JvmOverloads

constructor(treeId: Int, cache: MeasuredResultCache, rootContext: ComponentContext?, treeState: TreeState?, layoutVersion: Int, rootComponentId: Int, isAccessibilityEnabled: Boolean, layoutCache: LayoutCache, currentDiffTree: DiffNode?, layoutStateFuture: TreeFuture<*>?, scopesToUpdate: DirtyScopeIndex = DirtyScopeIndex.EMPTY)

Properties

cache

open override val cache: MeasuredResultCache

currentDiffTree

val currentDiffTree: DiffNode?

eventHandlers

open override val eventHandlers: List<Pair<GlobalKey, EventHandler<*>>>?

isAccessibilityEnabled

open override val isAccessibilityEnabled: Boolean

isFutureReleased

open override val isFutureReleased: Boolean

isReleased

var isReleased: Boolean

layoutCache

val layoutCache: LayoutCache

layoutVersion

open override val layoutVersion: Int

reflowTargetSizes

var reflowTargetSizes: MutableScatterMap<GlobalKey, IntSize>?

Natural sizes captured for every reflow node this commit (changed and unchanged), keyed by LithoNode.transitionGlobalKey; the commit itself is pinned to the previous/in-flight size. StyleTransitionsExtension reconciles each against the live store target at mount, so a background walk that read a stale target cannot make the wrong retarget decision. Null when the tree declares no reflow node, or when every reflow node was driving its own animation frame.

rootComponentContext

val rootComponentContext: ComponentContext?

rootComponentId

open override val rootComponentId: Int

rootOffset

var rootOffset: Point

scopesToUpdate

open override val scopesToUpdate: DirtyScopeIndex

treeFuture

open override val treeFuture: TreeFuture<*>?

treeId

open override val treeId: Int

treeState

open override val treeState: TreeState

Functions

consumeDiffNodeForDeferredNode

fun consumeDiffNodeForDeferredNode(): DiffNode?

hasDiffNodeSetForDeferredNode

fun hasDiffNodeSetForDeferredNode(): Boolean

recordEventHandler

open override fun recordEventHandler(globalKey: GlobalKey, eventHandler: EventHandler<*>)

Records a Spec-generated EventHandler. This EventHandlers are an output of the calculation and will be used by EventHandlersController to rebind existing EventHandlers.

release

fun release()

setDiffNodeForDeferredNode

fun setDiffNodeForDeferredNode(diff: DiffNode?)