com.facebook.litho

Class LayoutState

java.lang.Object

com.facebook.litho.LayoutState

All Implemented Interfaces:

EndToEndTestingExtension.EndToEndTestingExtensionInput, PotentiallyPartialResult, IncrementalMountExtensionInput, MountDelegateInput, TransitionsExtensionInput, VisibilityExtensionInput

public class LayoutState
extends java.lang.Object
implements IncrementalMountExtensionInput, VisibilityExtensionInput, TransitionsExtensionInput, EndToEndTestingExtension.EndToEndTestingExtensionInput, PotentiallyPartialResult

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 #collectResults(ComponentContext, LithoLayoutResult, LithoNode, LayoutState, RenderTreeNode, DiffNode, DebugHierarchy.Node) 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LayoutState.CalculateLayoutSource

Method Summary

Modifier and Type	Method and Description
static LayoutState	createTestInstance(ComponentContext c) Deprecated. kept around for old code, you should create a real instance instead with `calculate`
AnimatableItem	getAnimatableItem(long id)
OutputUnitsAffinityGroup<AnimatableItem>	getAnimatableItemForTransitionId(TransitionId transitionId) Gets a group of LayoutOutput given transition key
AnimatableItem	getAnimatableRootItem()
ComponentContext	getComponentContext()
int	getComponentTreeId()
DiffNode	getDiffTree()
int	getIncrementalMountOutputCount()
IncrementalMountOutput	getIncrementalMountOutputForId(long id)
java.util.Collection<IncrementalMountOutput>	getIncrementalMountOutputs() Returns a collection of Incremental Mount Outputs iterable by insertion order.
LithoNode	getLayoutRoot()
RenderTreeNode	getMountableOutputAt(int index) Returns the RenderTreeNode given its absolute position.
int	getMountableOutputCount()
java.util.List<Transition>	getMountTimeTransitions()
java.util.ArrayList<IncrementalMountOutput>	getOutputsOrderedByBottomBounds()
java.util.ArrayList<IncrementalMountOutput>	getOutputsOrderedByTopBounds()
int	getPositionForId(long layoutOutputId) Returns the position of RenderUnit given its id.
java.util.Set<java.lang.Long>	getRenderUnitIdsWhichHostRenderTrees() Returns the set of ids of RenderUnits which host RenderTreeHost
LithoLayoutResult	getRootLayoutResult()
java.lang.String	getRootName()
TransitionId	getRootTransitionId()
java.util.List<ScopedComponentInfo>	getScopedComponentInfosNeedingPreviousRenderData()
com.facebook.litho.TestOutput	getTestOutputAt(int index)
int	getTestOutputCount()
Systracer	getTracer()
java.util.Map<TransitionId,OutputUnitsAffinityGroup<AnimatableItem>>	getTransitionIdMapping() Gets a mapping from transition ids to a group of LayoutOutput.
java.util.List<Transition>	getTransitions()
int	getTreeId()
java.util.List<VisibilityOutput>	getVisibilityOutputs() returns a list of items for which visibility events will be processed
static boolean	isFromSyncLayout(int source)
boolean	isIncrementalMountEnabled()
boolean	isPartialResult() Return true if this result calculated from a TreeFuture is partial.
boolean	isProcessingVisibilityOutputsEnabled()
boolean	needsToRerunTransitions()
boolean	renderUnitWithIdHostsRenderTrees(long id)
void	setInitialRootBoundsForAnimation(Transition.RootBoundsTransition rootWidth, Transition.RootBoundsTransition rootHeight)
void	setNeedsToRerunTransitions(boolean needsToRerunTransitions)
void	setShouldProcessVisibilityOutputs(boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isFromSyncLayout

public static boolean isFromSyncLayout(int source)

isPartialResult

public boolean isPartialResult()

Description copied from interface: PotentiallyPartialResult

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

Specified by:

isPartialResult in interface PotentiallyPartialResult

getMountableOutputCount

public int getMountableOutputCount()

Specified by:

getMountableOutputCount in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

Specified by:

getMountableOutputCount in interface MountDelegateInput

Specified by:

getMountableOutputCount in interface TransitionsExtensionInput

getIncrementalMountOutputCount

public int getIncrementalMountOutputCount()

Specified by:

getIncrementalMountOutputCount in interface IncrementalMountExtensionInput

getMountableOutputAt

public RenderTreeNode getMountableOutputAt(int index)

Description copied from interface: MountDelegateInput

Returns the RenderTreeNode given its absolute position.

Specified by:

getMountableOutputAt in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

Specified by:

getMountableOutputAt in interface MountDelegateInput

Specified by:

getMountableOutputAt in interface TransitionsExtensionInput

getIncrementalMountOutputForId

public IncrementalMountOutput getIncrementalMountOutputForId(long id)

Specified by:

getIncrementalMountOutputForId in interface IncrementalMountExtensionInput

getIncrementalMountOutputs

public java.util.Collection<IncrementalMountOutput> getIncrementalMountOutputs()

Description copied from interface: IncrementalMountExtensionInput

Returns a collection of Incremental Mount Outputs iterable by insertion order.

Specified by:

getIncrementalMountOutputs in interface IncrementalMountExtensionInput

getAnimatableRootItem

public AnimatableItem getAnimatableRootItem()

Specified by:

getAnimatableRootItem in interface TransitionsExtensionInput

getAnimatableItem

public AnimatableItem getAnimatableItem(long id)

Specified by:

getAnimatableItem in interface TransitionsExtensionInput

getOutputsOrderedByTopBounds

public java.util.ArrayList<IncrementalMountOutput> getOutputsOrderedByTopBounds()

Specified by:

getOutputsOrderedByTopBounds in interface IncrementalMountExtensionInput

getOutputsOrderedByBottomBounds

public java.util.ArrayList<IncrementalMountOutput> getOutputsOrderedByBottomBounds()

Specified by:

getOutputsOrderedByBottomBounds in interface IncrementalMountExtensionInput

getVisibilityOutputs

public java.util.List<VisibilityOutput> getVisibilityOutputs()

Description copied from interface: VisibilityExtensionInput

returns a list of items for which visibility events will be processed

Specified by:

getVisibilityOutputs in interface VisibilityExtensionInput

getTestOutputCount

public int getTestOutputCount()

Specified by:

getTestOutputCount in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

getTestOutputAt

public com.facebook.litho.TestOutput getTestOutputAt(int index)

Specified by:

getTestOutputAt in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

getDiffTree

public DiffNode getDiffTree()

getTreeId

public int getTreeId()

Specified by:

getTreeId in interface TransitionsExtensionInput

getComponentTreeId

public int getComponentTreeId()

Returns:

The id of the ComponentTree that generated this LayoutState

getComponentContext

public ComponentContext getComponentContext()

getLayoutRoot

public LithoNode getLayoutRoot()

getRootLayoutResult

public LithoLayoutResult getRootLayoutResult()

getPositionForId

public int getPositionForId(long layoutOutputId)

Description copied from interface: MountDelegateInput

Returns the position of RenderUnit given its id.

Specified by:

getPositionForId in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

Specified by:

getPositionForId in interface MountDelegateInput

Returns:

the position of the LayoutOutput with id layoutOutputId in the LayoutState list of outputs or -1 if no LayoutOutput with that id exists in the LayoutState

renderUnitWithIdHostsRenderTrees

public boolean renderUnitWithIdHostsRenderTrees(long id)

Specified by:

renderUnitWithIdHostsRenderTrees in interface IncrementalMountExtensionInput

Specified by:

renderUnitWithIdHostsRenderTrees in interface TransitionsExtensionInput

getRenderUnitIdsWhichHostRenderTrees

public java.util.Set<java.lang.Long> getRenderUnitIdsWhichHostRenderTrees()

Description copied from interface: VisibilityExtensionInput

Returns the set of ids of RenderUnits which host RenderTreeHost

Specified by:

getRenderUnitIdsWhichHostRenderTrees in interface VisibilityExtensionInput

getTransitions

public java.util.List<Transition> getTransitions()

Specified by:

getTransitions in interface TransitionsExtensionInput

getTransitionIdMapping

public java.util.Map<TransitionId,OutputUnitsAffinityGroup<AnimatableItem>> getTransitionIdMapping()

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

Specified by:

getTransitionIdMapping in interface TransitionsExtensionInput

getAnimatableItemForTransitionId

public OutputUnitsAffinityGroup<AnimatableItem> getAnimatableItemForTransitionId(TransitionId transitionId)

Gets a group of LayoutOutput given transition key

Specified by:

getAnimatableItemForTransitionId in interface TransitionsExtensionInput

getScopedComponentInfosNeedingPreviousRenderData

public java.util.List<ScopedComponentInfo> getScopedComponentInfosNeedingPreviousRenderData()

setInitialRootBoundsForAnimation

public void setInitialRootBoundsForAnimation(Transition.RootBoundsTransition rootWidth,
                                             Transition.RootBoundsTransition rootHeight)

Specified by:

setInitialRootBoundsForAnimation in interface TransitionsExtensionInput

getMountTimeTransitions

public java.util.List<Transition> getMountTimeTransitions()

Specified by:

getMountTimeTransitions in interface TransitionsExtensionInput

isIncrementalMountEnabled

public boolean isIncrementalMountEnabled()

Specified by:

isIncrementalMountEnabled in interface TransitionsExtensionInput

getTracer

public Systracer getTracer()

Specified by:

getTracer in interface TransitionsExtensionInput

getRootTransitionId

public TransitionId getRootTransitionId()

Specified by:

getRootTransitionId in interface TransitionsExtensionInput

needsToRerunTransitions

public boolean needsToRerunTransitions()

Specified by:

needsToRerunTransitions in interface TransitionsExtensionInput

setNeedsToRerunTransitions

public void setNeedsToRerunTransitions(boolean needsToRerunTransitions)

Specified by:

setNeedsToRerunTransitions in interface TransitionsExtensionInput

isProcessingVisibilityOutputsEnabled

public boolean isProcessingVisibilityOutputsEnabled()

Specified by:

isProcessingVisibilityOutputsEnabled in interface VisibilityExtensionInput

setShouldProcessVisibilityOutputs

public void setShouldProcessVisibilityOutputs(boolean value)

getRootName

public java.lang.String getRootName()

Specified by:

getRootName in interface TransitionsExtensionInput

createTestInstance

@Deprecated
public static LayoutState createTestInstance(ComponentContext c)

Deprecated. kept around for old code, you should create a real instance instead with `calculate`