com.facebook.litho.sections.common

Class SingleComponentSection

java.lang.Object

com.facebook.litho.sections.SectionLifecycle

com.facebook.litho.sections.Section

com.facebook.litho.sections.common.SingleComponentSection

All Implemented Interfaces:

Equivalence<Section>, EventDispatcher, EventTriggerTarget, HasEventDispatcher, HasEventTrigger, Cloneable

public final class SingleComponentSection
extends Section

This is the simplest Section within a Sections hierarchy and it can be used to represent one row in a complex list.

 final Section loadingSection = SingleComponentSection.create(c)
      .component(MyComponent.create(c).build())
      .isFullSpan(true)
      .build();
 

See Also:

com.facebook.litho.sections.common.SingleComponentSectionSpec

Required Props

component

Component this section wraps.

Type:

com.facebook.litho.Component

Optional Props

customAttributes

java.lang.Object>

Type:

java.util.Map

data

Type:

java.lang.Object

isFullSpan

It is {@code false} by default making section fit one column. Set it to {@code true} if this section should span all columns in a multi-column layout.

Type:

java.lang.Boolean

spanSize

Number of columns occupied by this section (relevant for multi-column layouts).

Type:

java.lang.Integer

sticky

If this section is a sticky header.

Type:

java.lang.Boolean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleComponentSection.Builder

Method Summary

Modifier and Type	Method and Description
static SingleComponentSection.Builder	create(SectionContext context)
protected void	generateChangeSet(SectionContext context, ChangeSet changeSet, Section _prevAbstractImpl, Section _nextAbstractImpl) This method will delegate to the DiffSectionSpec method annotated with OnDiff
boolean	isDiffSectionSpec()
boolean	isEquivalentTo(Section other) Compares this section to a different one to check if they are the same
SingleComponentSection	makeShallowCopy(boolean deepCopy)

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

generateUniqueGlobalKeyForChild, getChildren, getEventDispatcher, getGlobalKey, getHandle, getKey, getLogTag, getParent, getScopedContext, getSimpleName, getStateContainer, makeShallowCopy, recordEventTrigger, setChildren, setCount, setGlobalKey, setKey, setScopedContext

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

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

Methods inherited from class java.lang.Object

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

Method Detail

isEquivalentTo

public boolean isEquivalentTo(Section other)

Description copied from class: Section

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>

Overrides:

isEquivalentTo in class Section

Parameters:

other - the component to compare to

Returns:

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

makeShallowCopy

public SingleComponentSection makeShallowCopy(boolean deepCopy)

Overrides:

makeShallowCopy in class Section

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.

create

public static SingleComponentSection.Builder create(SectionContext context)

generateChangeSet

protected void generateChangeSet(SectionContext context,
                                 ChangeSet changeSet,
                                 Section _prevAbstractImpl,
                                 Section _nextAbstractImpl)

Description copied from class: SectionLifecycle

This method will delegate to the DiffSectionSpec method annotated with OnDiff

Overrides:

generateChangeSet in class SectionLifecycle

isDiffSectionSpec

public boolean isDiffSectionSpec()

Overrides:

isDiffSectionSpec in class SectionLifecycle

Returns:

true if this lifecycle will generate a changeSet. If false this lifecycle will instead implement createChildren.