com.facebook.litho.sections

Class SectionTree

java.lang.Object

com.facebook.litho.sections.SectionTree

public class SectionTree
extends java.lang.Object

Represents a tree of Section and manages their lifecycle. SectionTree takes a root Section and generates the complete tree by recursively invoking OnCreateChildren. SectionTree is also responsible for regenerating the tree in response to state update events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SectionTree.Builder A builder class that can be used to create a SectionTree.
static interface	SectionTree.SectionMatcher
static interface	SectionTree.Target The class implementing this interface will be responsible to translate the ChangeSet into UI updates.

Method Summary

Modifier and Type	Method and Description
static SectionTree.Builder	create(SectionContext context, SectionTree.Target target) Create a SectionTree.Builder that can be used to configure a SectionTree.
static Looper	getDefaultChangeSetThreadLooper()
int	getIndexForMatcher(SectionTree.SectionMatcher sectionMatcher)
boolean	isReleased()
boolean	isSectionIndexValid(java.lang.String globalKey, int index)
void	refresh() Asks all the Section in the tree to refresh themselves.
void	release() Call this when to release this SectionTree and make sure that all the Services in the tree get destroyed.
void	requestFocusOnRoot(int index)
void	requestFocusOnRoot(int index, int offset)
void	requestFocusOnRoot(java.lang.Object id, int offset)
void	requestSmoothFocusOnRoot(int index, int offset, SmoothScrollAlignmentType type)
void	requestSmoothFocusOnRoot(java.lang.Object id, int offset, SmoothScrollAlignmentType type)
void	setLoadEventsHandler(LoadEventsHandler loadEventsHandler) Sets the LoadEventsHandler that will be used to dispatch LoadingEvent outside this SectionTree.
void	setRoot(Section section) Update the root Section.
void	setRootAsync(Section section) Update the root Section.
void	setTargetConfig(SectionTree.Target.DynamicConfig dynamicConfig) Set a new set of configurations to the SectionTree.Target.
void	viewPortChanged(int firstVisibleIndex, int lastVisibleIndex, int firstFullyVisibleIndex, int lastFullyVisibleIndex, int state)
void	viewPortChangedFromScrolling(int firstVisibleIndex, int lastVisibleIndex, int firstFullyVisibleIndex, int lastFullyVisibleIndex)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SectionTree.Builder create(SectionContext context,
                                         SectionTree.Target target)

Create a SectionTree.Builder that can be used to configure a SectionTree.

Parameters:

context - The SectionContext taht will be used to create the child Components

target - The SectionTree.Target that will be responsible to apply the ChangeSet to the UI.

setRoot

public void setRoot(Section section)

Update the root Section. This will create the new Section tree and generate a ChangeSet to be applied to the UI. In response to this Target#applyNewChangeSet(int) ()} will be invoked once the ChangeSet has been calculated. The generation of the ChangeSet will happen synchronously in the thread calling this method.

Parameters:

section - The new root.

setRootAsync

public void setRootAsync(Section section)

Update the root Section. This will create the new Section tree and generate a ChangeSet to be applied to the UI. In response to this Target#applyNewChangeSet(int, String, Throwable) will be invoked once the ChangeSet has been calculated. The generation of the ChangeSet will happen asynchronously in this SectionTree ChangeSetThread.

Parameters:

section - The new root.

refresh

public void refresh()

Asks all the Section in the tree to refresh themselves. The refresh is by default a no-op. Sections that need a refresh behaviour should implement a method annotated with OnRefresh.

setLoadEventsHandler

public void setLoadEventsHandler(LoadEventsHandler loadEventsHandler)

Sets the LoadEventsHandler that will be used to dispatch LoadingEvent outside this SectionTree.

setTargetConfig

public void setTargetConfig(SectionTree.Target.DynamicConfig dynamicConfig)

Set a new set of configurations to the SectionTree.Target. Only those allowed to be modified will be included in SectionTree.Target.DynamicConfig.

viewPortChangedFromScrolling

public void viewPortChangedFromScrolling(int firstVisibleIndex,
                                         int lastVisibleIndex,
                                         int firstFullyVisibleIndex,
                                         int lastFullyVisibleIndex)

viewPortChanged

public void viewPortChanged(int firstVisibleIndex,
                            int lastVisibleIndex,
                            int firstFullyVisibleIndex,
                            int lastFullyVisibleIndex,
                            int state)

requestFocusOnRoot

public void requestFocusOnRoot(int index)

requestFocusOnRoot

public void requestFocusOnRoot(int index,
                               int offset)

requestFocusOnRoot

public void requestFocusOnRoot(java.lang.Object id,
                               int offset)

getIndexForMatcher

public int getIndexForMatcher(SectionTree.SectionMatcher sectionMatcher)

requestSmoothFocusOnRoot

public void requestSmoothFocusOnRoot(int index,
                                     int offset,
                                     SmoothScrollAlignmentType type)

requestSmoothFocusOnRoot

public void requestSmoothFocusOnRoot(java.lang.Object id,
                                     int offset,
                                     SmoothScrollAlignmentType type)

isSectionIndexValid

public boolean isSectionIndexValid(java.lang.String globalKey,
                                   int index)

release

public void release()

Call this when to release this SectionTree and make sure that all the Services in the tree get destroyed.

isReleased

public boolean isReleased()

getDefaultChangeSetThreadLooper

public static Looper getDefaultChangeSetThreadLooper()