com.facebook.litho

Class LayoutState

java.lang.Object

com.facebook.litho.LayoutState

All Implemented Interfaces:

EndToEndTestingExtension.EndToEndTestingExtensionInput, IncrementalMountExtension.IncrementalMountExtensionInput, TransitionsExtension.TransitionsExtensionInput, com.facebook.litho.VisibilityOutputsExtension.VisibilityOutputsExtensionInput, MountDelegate.MountDelegateInput

public class LayoutState
extends java.lang.Object
implements IncrementalMountExtension.IncrementalMountExtensionInput, com.facebook.litho.VisibilityOutputsExtension.VisibilityOutputsExtensionInput, TransitionsExtension.TransitionsExtensionInput, EndToEndTestingExtension.EndToEndTestingExtensionInput

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(RenderTreeNode, ComponentContext, DebugHierarchy.Node, InternalNode, LayoutState, DiffNode) which prepares the before-mentioned outputs based on the provided InternalNode for later use in MountState.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LayoutState.CalculateLayoutSource

Method Summary

Modifier and Type	Method and Description
protected void	clearCachedLayout(Component component)
java.util.List<Component>	getComponentsNeedingPreviousRenderData()
int	getComponentTreeId()
DiffNode	getDiffTree()
int	getLayoutOutputPositionForId(long layoutOutputId)
OutputUnitsAffinityGroup<com.facebook.litho.LayoutOutput>	getLayoutOutputsForTransitionId(TransitionId transitionId) Gets a group of LayoutOutput given transition key
InternalNode	getLayoutRoot()
RenderTreeNode	getMountableOutputAt(int index)
java.util.ArrayList<RenderTreeNode>	getMountableOutputBottoms()
int	getMountableOutputCount()
java.util.ArrayList<RenderTreeNode>	getMountableOutputTops()
java.lang.String	getRootComponentName()
TransitionId	getRootTransitionId()
com.facebook.litho.TestOutput	getTestOutputAt(int index)
int	getTestOutputCount()
java.util.Map<TransitionId,OutputUnitsAffinityGroup<com.facebook.litho.LayoutOutput>>	getTransitionIdMapping() Gets a mapping from transition ids to a group of LayoutOutput.
java.util.List<Transition>	getTransitions()
VisibilityModuleInput	getVisibilityModuleInput()
java.util.List<com.facebook.litho.VisibilityOutput>	getVisibilityOutputs()
boolean	isIncrementalVisibilityEnabled()
boolean	needsToRerunTransitions()
void	setNeedsToRerunTransitions(boolean needsToRerunTransitions)

Methods inherited from class java.lang.Object

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

Method Detail

isIncrementalVisibilityEnabled

public boolean isIncrementalVisibilityEnabled()

Specified by:

isIncrementalVisibilityEnabled in interface com.facebook.litho.VisibilityOutputsExtension.VisibilityOutputsExtensionInput

clearCachedLayout

protected void clearCachedLayout(Component component)

getMountableOutputCount

public int getMountableOutputCount()

Specified by:

getMountableOutputCount in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

Specified by:

getMountableOutputCount in interface IncrementalMountExtension.IncrementalMountExtensionInput

Specified by:

getMountableOutputCount in interface TransitionsExtension.TransitionsExtensionInput

getMountableOutputAt

public RenderTreeNode getMountableOutputAt(int index)

Specified by:

getMountableOutputAt in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

Specified by:

getMountableOutputAt in interface TransitionsExtension.TransitionsExtensionInput

Specified by:

getMountableOutputAt in interface MountDelegate.MountDelegateInput

getMountableOutputTops

public java.util.ArrayList<RenderTreeNode> getMountableOutputTops()

Specified by:

getMountableOutputTops in interface IncrementalMountExtension.IncrementalMountExtensionInput

getMountableOutputBottoms

public java.util.ArrayList<RenderTreeNode> getMountableOutputBottoms()

Specified by:

getMountableOutputBottoms in interface IncrementalMountExtension.IncrementalMountExtensionInput

getVisibilityOutputs

public java.util.List<com.facebook.litho.VisibilityOutput> getVisibilityOutputs()

Specified by:

getVisibilityOutputs in interface com.facebook.litho.VisibilityOutputsExtension.VisibilityOutputsExtensionInput

getVisibilityModuleInput

public VisibilityModuleInput getVisibilityModuleInput()

Specified by:

getVisibilityModuleInput in interface com.facebook.litho.VisibilityOutputsExtension.VisibilityOutputsExtensionInput

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()

getComponentTreeId

public int getComponentTreeId()

Specified by:

getComponentTreeId in interface TransitionsExtension.TransitionsExtensionInput

Returns:

The id of the ComponentTree that generated this LayoutState

getLayoutRoot

public InternalNode getLayoutRoot()

getLayoutOutputPositionForId

public int getLayoutOutputPositionForId(long layoutOutputId)

Specified by:

getLayoutOutputPositionForId in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

Specified by:

getLayoutOutputPositionForId in interface IncrementalMountExtension.IncrementalMountExtensionInput

Specified by:

getLayoutOutputPositionForId in interface MountDelegate.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

getTransitions

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

Specified by:

getTransitions in interface TransitionsExtension.TransitionsExtensionInput

getTransitionIdMapping

public java.util.Map<TransitionId,OutputUnitsAffinityGroup<com.facebook.litho.LayoutOutput>> getTransitionIdMapping()

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

Specified by:

getTransitionIdMapping in interface TransitionsExtension.TransitionsExtensionInput

getLayoutOutputsForTransitionId

public OutputUnitsAffinityGroup<com.facebook.litho.LayoutOutput> getLayoutOutputsForTransitionId(TransitionId transitionId)

Gets a group of LayoutOutput given transition key

Specified by:

getLayoutOutputsForTransitionId in interface TransitionsExtension.TransitionsExtensionInput

getComponentsNeedingPreviousRenderData

public java.util.List<Component> getComponentsNeedingPreviousRenderData()

Specified by:

getComponentsNeedingPreviousRenderData in interface TransitionsExtension.TransitionsExtensionInput

Returns:

the list of Components in this LayoutState that care about the previously mounted versions of their @Prop/@State params.

getRootTransitionId

public TransitionId getRootTransitionId()

Specified by:

getRootTransitionId in interface TransitionsExtension.TransitionsExtensionInput

needsToRerunTransitions

public boolean needsToRerunTransitions()

Specified by:

needsToRerunTransitions in interface TransitionsExtension.TransitionsExtensionInput

setNeedsToRerunTransitions

public void setNeedsToRerunTransitions(boolean needsToRerunTransitions)

Specified by:

setNeedsToRerunTransitions in interface TransitionsExtension.TransitionsExtensionInput

getRootComponentName

public java.lang.String getRootComponentName()

Specified by:

getRootComponentName in interface TransitionsExtension.TransitionsExtensionInput