litho-core/com.facebook.litho/LayoutState

LayoutState

class LayoutState : IncrementalMountExtensionInput, VisibilityExtensionInput, TransitionsExtensionInput, EndToEndTestingExtension.EndToEndTestingExtensionInput, PotentiallyPartialResult, DynamicPropsExtensionInput

The main role of LayoutState is to hold the output of layout calculation. This includes mountable outputs and visibility outputs. A centerpiece of the class is LithoReducer#setSizeAfterMeasureAndCollectResults(ComponentContext, LithoLayoutContext, LayoutState) which prepares the before-mentioned outputs based on the provided LithoNode for later use in MountState.

Types

Companion

object Companion

Properties

animatableRootItem

open override val animatableRootItem: AnimatableItem?

attachables

val attachables: List<Attachable>?

componentContext

val componentContext: ComponentContext

componentHandles

val componentHandles: Set<Handle>

componentHandleToBounds

val componentHandleToBounds: Map<Handle, Rect>

componentKeyToBounds

val componentKeyToBounds: Map<String, Rect>

componentTreeId

val componentTreeId: Int

the id of the ComponentTree that generated this LayoutState

currentLayoutOutputAffinityGroup

val currentLayoutOutputAffinityGroup: OutputUnitsAffinityGroup<AnimatableItem>?

currentTransitionId

val currentTransitionId: TransitionId?

diffTree

val diffTree: DiffNode?

dynamicValueOutputs

open override val dynamicValueOutputs: Map<Long, DynamicValueOutput>

hasComponentsExcludedFromIncrementalMount

@VisibleForTesting(otherwise = 3)

val hasComponentsExcludedFromIncrementalMount: Boolean

Whether or not there are components marked as 'ExcludeFromIncrementalMount'.

height

val height: Int

val id: Int

Id of this LayoutState.

isAccessibilityEnabled

val isAccessibilityEnabled: Boolean

isActivityValid

val isActivityValid: Boolean

isEmpty

val isEmpty: Boolean

isIncrementalMountEnabled

open override val isIncrementalMountEnabled: Boolean

isPartialResult

open override val isPartialResult: Boolean = false

Return true if this result calculated from a TreeFuture is partial.

isProcessingVisibilityOutputsEnabled

open override val isProcessingVisibilityOutputsEnabled: Boolean

layoutCacheData

val layoutCacheData: Map<Any, Any?>?

mountableOutputs

val mountableOutputs: List<RenderTreeNode>

previousLayoutStateId

val previousLayoutStateId: Int

Id of the LayoutState that was compared to when calculating this LayoutState.

renderUnitIdsWhichHostRenderTrees

open override val renderUnitIdsWhichHostRenderTrees: Set<Long>

resolveResult

val resolveResult: ResolveResult

root

val root: LithoNode?

rootComponent

val rootComponent: Component

rootHeightAnimation

var rootHeightAnimation: Transition.RootBoundsTransition?

rootLayoutResult

var rootLayoutResult: LayoutResult?

rootName

open override val rootName: String

rootTransitionId

open override val rootTransitionId: TransitionId?

rootWidthAnimation

var rootWidthAnimation: Transition.RootBoundsTransition?

sizeConstraints

val sizeConstraints: SizeConstraints

testOutputCount

open override val testOutputCount: Int

tracer

open override val tracer: Systracer

transitionIdMapping

open override val transitionIdMapping: Map<TransitionId, OutputUnitsAffinityGroup<AnimatableItem>>

Gets a mapping from transition ids to a group of LayoutOutput.

transitions

open override val transitions: List<Transition>?

treeId

open override val treeId: Int

treeState

@get:CheckReturnValue

val treeState: TreeState

Returns the state handler instance currently held by LayoutState.

visibilityBoundsTransformer

open override val visibilityBoundsTransformer: VisibilityBoundsTransformer?

visibilityOutputCount

val visibilityOutputCount: Int

visibilityOutputs

open override val visibilityOutputs: List<VisibilityOutput>

width

val width: Int

Functions

checkWorkingRangeAndDispatch

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

cleanup

fun LayoutState.cleanup()

commit

fun LayoutState.commit()

consumeComponentScopes