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

object Companion

Properties

animatableRootItem

open override val animatableRootItem: AnimatableItem?

val attachables: List<Attachable>?

componentContext

val componentContext: ComponentContext

componentHandles

val componentHandles: ScatterSet<Handle>?

componentTreeId

val componentTreeId: Int

the id of the ComponentTree that generated this LayoutState

currentLayoutOutputAffinityGroup

val currentLayoutOutputAffinityGroup: OutputUnitsAffinityGroup<AnimatableItem>?

currentTransitionId

val currentTransitionId: TransitionId?

val diffTree: DiffNode?

dynamicValueOutputs

open override val dynamicValueOutputs: LongObjectMap<DynamicValueOutput>?

Primitive-keyed outputs for render units carrying common dynamic props.

hasComponentsExcludedFromIncrementalMount

@VisibleForTesting(otherwise = 3)

val hasComponentsExcludedFromIncrementalMount: Boolean

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

val height: Int

val id: Int

Id of this LayoutState.

isAccessibilityEnabled

val isAccessibilityEnabled: Boolean

isActivityValid

val isActivityValid: Boolean

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: LayoutCacheData?

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: LongSet?

val resolveResult: ResolveResult

val root: LithoNode?

val rootComponent: Component

rootHeightAnimation

var rootHeightAnimation: Transition.RootBoundsTransition?

rootLayoutResult

var rootLayoutResult: LayoutResult?

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

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.

open override val transitions: List<Transition>?

open override val treeId: Int

val treeState: TreeState

useEmptyVisibleRectOnDetach

open override val useEmptyVisibleRectOnDetach: Boolean

val version: Int

visibilityBoundsTransformer

open override val visibilityBoundsTransformer: VisibilityBoundsTransformer?

visibilityOutputCount

val visibilityOutputCount: Int

visibilityOutputs

open override val visibilityOutputs: List<VisibilityOutput>

Functions

checkWorkingRangeAndDispatch

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

fun LayoutState.cleanup()

fun LayoutState.commit()

consumeComponentScopes

fun consumeComponentScopes(): List<ScopedComponentInfo>?

fun copyWith(updatedResolveResult: ResolveResult, treeState: TreeState, newVersion: Int): LayoutState

dispatchOnExitRangeIfNeeded

fun dispatchOnExitRangeIfNeeded(stateHandler: WorkingRangeStatusHandler)

fun dumpAsString(): String

Debug-only: return a string representation of this LayoutState and its LayoutOutputs.

findBoundsForHandle

fun findBoundsForHandle(handle: Handle): Rect?

getAnimatableItem

open override fun getAnimatableItem(id: Long): AnimatableItem?

getAnimatableItemForTransitionId

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

Gets a group of LayoutOutput given transition key

fun getHeightSpec(): Int

getIncrementalMountOutputCount

open override fun getIncrementalMountOutputCount(): Int

getIncrementalMountOutputForId

open override fun getIncrementalMountOutputForId(id: Long): IncrementalMountOutput?

getIncrementalMountOutputs

open override fun getIncrementalMountOutputs(): Collection<IncrementalMountOutput>?

getMountableOutputAt

open override fun getMountableOutputAt(position: Int): RenderTreeNode

getMountableOutputCount

open override fun getMountableOutputCount(): Int

getMountTimeTransitions

open override fun getMountTimeTransitions(previousInput: TransitionsExtensionInput?): List<Transition>?

getOutputsOrderedByBottomBounds

open override fun getOutputsOrderedByBottomBounds(): List<IncrementalMountOutput>

getOutputsOrderedByTopBounds

open override fun getOutputsOrderedByTopBounds(): List<IncrementalMountOutput>

getPositionForId

open override fun getPositionForId(id: Long): Int

getRenderTreeNode

fun getRenderTreeNode(output: IncrementalMountOutput): RenderTreeNode

getTestOutputAt

open override fun getTestOutputAt(position: Int): TestOutput?

getVisibilityOutputAt

fun getVisibilityOutputAt(index: Int): VisibilityOutput

fun getWidthSpec(): Int

fun isCommitted(): Boolean

isCompatibleComponentAndSpec

fun isCompatibleComponentAndSpec(componentId: Int, widthSpec: Int, heightSpec: Int): Boolean

isCompatibleSize

fun isCompatibleSize(width: Int, height: Int): Boolean

isCompatibleSpec

fun isCompatibleSpec(widthSpec: Int, heightSpec: Int): Boolean

isForComponentId

fun isForComponentId(componentId: Int): Boolean

fun markCommitted()

needsToRerunTransitions

open override fun needsToRerunTransitions(): Boolean

renderUnitWithIdHostsRenderTrees

open override fun renderUnitWithIdHostsRenderTrees(id: Long): Boolean

setInitialRootBoundsForAnimation

open override fun setInitialRootBoundsForAnimation(rootWidth: Transition.RootBoundsTransition?, rootHeight: Transition.RootBoundsTransition?)

setNeedsToRerunTransitions

open override fun setNeedsToRerunTransitions(needsToRerunTransitions: Boolean)

setShouldProcessVisibilityOutputs

fun setShouldProcessVisibilityOutputs(value: Boolean)

fun toRenderTree(): RenderTree