com.facebook.litho

Class LayoutState

java.lang.Object

com.facebook.litho.LayoutState

All Implemented Interfaces:

EndToEndTestingExtension.EndToEndTestingExtensionInput, TransitionsExtensionInput, IncrementalMountExtensionInput, MountDelegateInput, VisibilityExtensionInput

public class LayoutState
extends Object
implements IncrementalMountExtensionInput, VisibilityExtensionInput, 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)
AnimatableItem	getAnimatableItem(long id)
OutputUnitsAffinityGroup<AnimatableItem>	getAnimatableItemForTransitionId(TransitionId transitionId) Gets a group of LayoutOutput given transition key
AnimatableItem	getAnimatableRootItem()
List<String>	getComponentKeysNeedingPreviousRenderData()
List<Component>	getComponentsNeedingPreviousRenderData()
int	getComponentTreeId()
DiffNode	getDiffTree()
InternalNode	getLayoutRoot()
RenderTreeNode	getMountableOutputAt(int index) Returns the RenderTreeNode given its absolute position.
ArrayList<RenderTreeNode>	getMountableOutputBottoms()
int	getMountableOutputCount()
ArrayList<RenderTreeNode>	getMountableOutputTops()
int	getPositionForId(long layoutOutputId) Returns the position of RenderUnit given its id.
String	getRootComponentName()
TransitionId	getRootTransitionId()
com.facebook.litho.TestOutput	getTestOutputAt(int index)
int	getTestOutputCount()
Map<TransitionId,OutputUnitsAffinityGroup<AnimatableItem>>	getTransitionIdMapping() Gets a mapping from transition ids to a group of LayoutOutput.
List<Transition>	getTransitions()
VisibilityModuleInput	getVisibilityModuleInput() returns the meta data required to process visibility events.
List<VisibilityOutput>	getVisibilityOutputs() returns a list of items for which visibility events will be processed
boolean	isIncrementalVisibilityEnabled() Experimental Specifies if visibility event are processed incrementally.
boolean	needsToRerunTransitions()
boolean	renderUnitWithIdHostsRenderTrees(long id)
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()

Description copied from interface: VisibilityExtensionInput

Experimental Specifies if visibility event are processed incrementally.

Specified by:

isIncrementalVisibilityEnabled in interface VisibilityExtensionInput

Returns:

true only if visibility events should be processed incrementally.

clearCachedLayout

protected void clearCachedLayout(Component component)

getMountableOutputCount

public int getMountableOutputCount()

Specified by:

getMountableOutputCount in interface EndToEndTestingExtension.EndToEndTestingExtensionInput

Specified by:

getMountableOutputCount in interface TransitionsExtensionInput

Specified by:

getMountableOutputCount 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 TransitionsExtensionInput

Specified by:

getMountableOutputAt in interface MountDelegateInput

getAnimatableRootItem

public AnimatableItem getAnimatableRootItem()

Specified by:

getAnimatableRootItem in interface TransitionsExtensionInput

getAnimatableItem

public AnimatableItem getAnimatableItem(long id)

Specified by:

getAnimatableItem in interface TransitionsExtensionInput

getMountableOutputTops

public ArrayList<RenderTreeNode> getMountableOutputTops()

Specified by:

getMountableOutputTops in interface IncrementalMountExtensionInput

getMountableOutputBottoms

public ArrayList<RenderTreeNode> getMountableOutputBottoms()

Specified by:

getMountableOutputBottoms in interface IncrementalMountExtensionInput

getVisibilityOutputs

public 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

getVisibilityModuleInput

public VisibilityModuleInput getVisibilityModuleInput()

Description copied from interface: VisibilityExtensionInput

returns the meta data required to process visibility events.

Specified by:

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

getComponentTreeId

public int getComponentTreeId()

Specified by:

getComponentTreeId in interface TransitionsExtensionInput

Returns:

The id of the ComponentTree that generated this LayoutState

getLayoutRoot

public InternalNode getLayoutRoot()

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

getTransitions

public List<Transition> getTransitions()

Specified by:

getTransitions in interface TransitionsExtensionInput

getTransitionIdMapping

public 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

getComponentsNeedingPreviousRenderData

public List<Component> getComponentsNeedingPreviousRenderData()

Specified by:

getComponentsNeedingPreviousRenderData in interface TransitionsExtensionInput

Returns:

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

getComponentKeysNeedingPreviousRenderData

public List<String> getComponentKeysNeedingPreviousRenderData()

Specified by:

getComponentKeysNeedingPreviousRenderData 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

getRootComponentName

public String getRootComponentName()

Specified by:

getRootComponentName in interface TransitionsExtensionInput