com.facebook.litho.sections

Class Section

java.lang.Object

com.facebook.litho.sections.SectionLifecycle

com.facebook.litho.sections.Section

All Implemented Interfaces:

Equivalence<Section>, EventDispatcher, EventTriggerTarget, HasEventDispatcher, HasEventTrigger, java.lang.Cloneable

Direct Known Subclasses:

DataDiffSection, HideableDataDiffSection, SectionsTestHelper, SingleComponentSection, TestSectionCreator.TestSection, ViewPagerHelperSection

public abstract class Section
extends SectionLifecycle
implements java.lang.Cloneable, HasEventDispatcher, HasEventTrigger, Equivalence<Section>

Represents a unique instance of a Section that is driven by its matching SectionLifecycle. To create new Section instances, use the create() method in the generated SectionLifecycle subclass which returns a Section.Builder that allows you to set values for individual props. Section instances are immutable after creation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Section.Builder<T extends Section.Builder<T>> A builder to build a Section with a SectionLifecycle L.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Section(java.lang.String simpleName)

Method Summary

Modifier and Type	Method and Description
protected StateContainer	createStateContainer()
java.lang.String	generateUniqueGlobalKeyForChild(Section section, java.lang.String childKey)
java.util.List<Section>	getChildren()
EventDispatcher	getEventDispatcher()
java.lang.String	getGlobalKey()
java.lang.String	getLogTag()
Section	getParent()
SectionContext	getScopedContext()
java.lang.String	getSimpleName() Mostly used by logging to provide more readable messages.
protected StateContainer	getStateContainer()
protected static StateContainer	getStateContainer(ComponentContext c, Section section)
protected boolean	isEquivalentProps(Section other, boolean shouldCompareCommonProps)
boolean	isEquivalentTo(Section other) Compares this section to a different one to check if they are the same
Section	makeShallowCopy()
Section	makeShallowCopy(boolean deepCopy)
void	recordEventTrigger(ComponentContext c, EventTriggersContainer container)
void	setChildren(Children children)
void	setCount(int count) Sets the total number of Component that the subtree of Sections having its root in this Section generated.
void	setGlobalKey(java.lang.String key) Set a unique key for this Section within its tree.
void	setKey(java.lang.String key) Sets the key for this Section.
void	setScopedContext(SectionContext scopedContext)
protected void	setStateContainer(StateContainer stateContainer)

Methods inherited from class com.facebook.litho.sections.SectionLifecycle

acceptTriggerEvent, acceptTriggerEventImpl, bindService, createChildren, createInitialState, createService, dataBound, dataRendered, dispatchLoadingEvent, dispatchOnEvent, dispatchOnEventImpl, generateChangeSet, getEventTrigger, getEventTrigger, getLoadingEventHandler, getService, getTreePropsForChildren, isDiffSectionSpec, isSectionIndexValid, newEventHandler, newEventTrigger, newEventTrigger, populateTreeProps, refresh, requestFocus, requestFocus, requestFocus, requestFocusWithOffset, requestFocusWithOffset, requestFocusWithOffset, requestSmoothFocus, requestSmoothFocus, requestSmoothFocus, shouldUpdate, transferService, transferState, unbindService, verifyChangeSet, viewportChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

Section

protected Section(java.lang.String simpleName)

Method Detail

getEventDispatcher

public EventDispatcher getEventDispatcher()

Specified by:

getEventDispatcher in interface HasEventDispatcher

recordEventTrigger

public void recordEventTrigger(ComponentContext c,
                               EventTriggersContainer container)

Specified by:

recordEventTrigger in interface HasEventTrigger

getGlobalKey

public java.lang.String getGlobalKey()

Returns:

a unique key for this Section within its tree.

setGlobalKey

public void setGlobalKey(java.lang.String key)

Set a unique key for this Section within its tree.

setKey

public void setKey(java.lang.String key)

Sets the key for this Section. This is only used for testing as the key will be set from the Section.Builder

setCount

public void setCount(int count)

Sets the total number of Component that the subtree of Sections having its root in this Section generated.

getChildren

public java.util.List<Section> getChildren()

Returns:

the direct children of this Section.

getParent

public Section getParent()

Returns:

the parent of this Section in the tree.

makeShallowCopy

public Section makeShallowCopy(boolean deepCopy)

Returns:

a clone of this Section. if deepCopy is false the clone won't contain any children or count as it will be returned in a pre - ChangeSet generation state.

makeShallowCopy

public Section makeShallowCopy()

getScopedContext

public SectionContext getScopedContext()

setScopedContext

public void setScopedContext(SectionContext scopedContext)

setChildren

public void setChildren(Children children)

getSimpleName

public final java.lang.String getSimpleName()

Mostly used by logging to provide more readable messages.

isEquivalentProps

protected boolean isEquivalentProps(Section other,
                                    boolean shouldCompareCommonProps)

isEquivalentTo

public boolean isEquivalentTo(Section other)

Compares this section to a different one to check if they are the same

This is used to be able to skip rendering a section again. We avoid using the Object.equals(Object) so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.

Specified by:

isEquivalentTo in interface Equivalence<Section>

Parameters:

other - the component to compare to

Returns:

true if the components are of the same type and have the same props

getStateContainer

protected static StateContainer getStateContainer(ComponentContext c,
                                                  Section section)

getStateContainer

protected StateContainer getStateContainer()

setStateContainer

protected void setStateContainer(StateContainer stateContainer)

createStateContainer

protected StateContainer createStateContainer()

generateUniqueGlobalKeyForChild

public java.lang.String generateUniqueGlobalKeyForChild(Section section,
                                                        java.lang.String childKey)

getLogTag

public java.lang.String getLogTag()