litho-core/com.facebook.litho/LayoutState

LayoutState

open class LayoutState : IncrementalMountExtensionInput, VisibilityExtensionInput, TransitionsExtensionInput, EndToEndTestingExtension.EndToEndTestingExtensionInput, PotentiallyPartialResult, LithoViewAttributesExtension.ViewAttributesInput, 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 setSizeAfterMeasureAndCollectResults which prepares the before-mentioned outputs based on the provided LithoNode for later use in MountState.

This needs to be accessible to statically mock the class in tests.

Properties

mHasComponentsExcludedFromIncrementalMount

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)

open var mHasComponentsExcludedFromIncrementalMount: Boolean

Functions

fun LayoutState.cleanup()

fun LayoutState.commit()

getAnimatableItem

open fun getAnimatableItem(id: Long): AnimatableItem

getAnimatableItemForTransitionId

open fun getAnimatableItemForTransitionId(transitionId: TransitionId): OutputUnitsAffinityGroup<AnimatableItem>

Gets a group of LayoutOutput given transition key

getAnimatableRootItem

open fun getAnimatableRootItem(): AnimatableItem

getComponentContext

open fun getComponentContext(): ComponentContext

getComponentTreeId

open fun getComponentTreeId(): Int

open fun getDiffTree(): DiffNode

getDynamicValueOutputs

open fun getDynamicValueOutputs(): Map<Long, DynamicValueOutput>

open fun getHeight(): Int

getIncrementalMountOutputCount

open fun getIncrementalMountOutputCount(): Int

getIncrementalMountOutputForId

open fun getIncrementalMountOutputForId(id: Long): IncrementalMountOutput

getIncrementalMountOutputs

open fun getIncrementalMountOutputs(): Collection<IncrementalMountOutput>

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)

open fun getLayoutRoot(): LithoNode

getMountableOutputAt

open fun getMountableOutputAt(index: Int): RenderTreeNode

getMountableOutputCount

open fun getMountableOutputCount(): Int

getMountTimeTransitions

open fun getMountTimeTransitions(): List<Transition>

getOutputsOrderedByBottomBounds

open fun getOutputsOrderedByBottomBounds(): ArrayList<IncrementalMountOutput>

getOutputsOrderedByTopBounds

open fun getOutputsOrderedByTopBounds(): ArrayList<IncrementalMountOutput>

getPositionForId

open fun getPositionForId(layoutOutputId: Long): Int

getRenderUnitIdsWhichHostRenderTrees

open fun getRenderUnitIdsWhichHostRenderTrees(): Set<Long>

getResolveResult

open fun getResolveResult(): ResolveResult

getRootHeightAnimation

open fun getRootHeightAnimation(): Transition.RootBoundsTransition

getRootLayoutResult

open fun getRootLayoutResult(): LayoutResult

open fun getRootName(): String

getRootTransitionId

open fun getRootTransitionId(): TransitionId

getRootWidthAnimation

open fun getRootWidthAnimation(): Transition.RootBoundsTransition

getScopedComponentInfosNeedingPreviousRenderData

open fun getScopedComponentInfosNeedingPreviousRenderData(): List<ScopedComponentInfo>

getSizeConstraints

open fun getSizeConstraints(): SizeConstraints

getTestOutputAt

open fun getTestOutputAt(index: Int): TestOutput

getTestOutputCount

open fun getTestOutputCount(): Int

open fun getTracer(): Systracer

getTransitionIdMapping

open fun getTransitionIdMapping(): Map<TransitionId, OutputUnitsAffinityGroup<AnimatableItem>>

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

open fun getTransitions(): List<Transition>

open fun getTreeId(): Int

getViewAttributes

open fun getViewAttributes(): Map<Long, ViewAttributes>

getVisibilityBoundsTransformer

open fun getVisibilityBoundsTransformer(): VisibilityBoundsTransformer

getVisibilityOutputs

open fun getVisibilityOutputs(): List<VisibilityOutput>

open fun getWidth(): Int

open fun isEmpty(): Boolean

isFromSyncLayout

open fun isFromSyncLayout(source: Int): Boolean

isIncrementalMountEnabled

open fun isIncrementalMountEnabled(): Boolean

open fun isNullOrEmpty(@Nullable layoutState: LayoutState): Boolean

isPartialResult

open fun isPartialResult(): Boolean

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

isProcessingVisibilityOutputsEnabled

open fun isProcessingVisibilityOutputsEnabled(): Boolean

needsToRerunTransitions

open fun needsToRerunTransitions(): Boolean

renderUnitWithIdHostsRenderTrees

open fun renderUnitWithIdHostsRenderTrees(id: Long): Boolean

fun LayoutState.runEffects()

setInitialRootBoundsForAnimation

open fun setInitialRootBoundsForAnimation(@Nullable rootWidth: Transition.RootBoundsTransition, @Nullable rootHeight: Transition.RootBoundsTransition)

setNeedsToRerunTransitions

open fun setNeedsToRerunTransitions(needsToRerunTransitions: Boolean)

setShouldProcessVisibilityOutputs

open fun setShouldProcessVisibilityOutputs(value: Boolean)

open fun toRenderTree(): RenderTree