com.facebook.litho.sections

Class SectionLifecycle

java.lang.Object

com.facebook.litho.sections.SectionLifecycle

All Implemented Interfaces:

EventDispatcher, EventTriggerTarget

Direct Known Subclasses:

Section

public abstract class SectionLifecycle
extends java.lang.Object
implements EventDispatcher, EventTriggerTarget

Constructor Summary

Constructors

Constructor and Description
SectionLifecycle()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	acceptTriggerEvent(EventTrigger eventTrigger, java.lang.Object eventState, java.lang.Object[] params)
protected java.lang.Object	acceptTriggerEventImpl(EventTrigger eventTrigger, java.lang.Object eventState, java.lang.Object[] params)
protected void	bindService(SectionContext c)
protected Children	createChildren(SectionContext c) This methods will delegate to the GroupSectionSpec method annotated with OnCreateChildren
protected void	createInitialState(SectionContext c)
protected void	createService(SectionContext c)
protected void	dataBound(SectionContext c) This method will delegate to the SectionSpec method annotated with OnDataBound
protected void	dataRendered(SectionContext c, boolean isDataChanged, boolean isMounted, long uptimeMillis, int firstVisibleIndex, int lastVisibleIndex, ChangesInfo changesInfo, int globalOffset) This method will delegate to the SectionSpec method annotated with OnDataRendered.
static void	dispatchLoadingEvent(SectionContext context, boolean isEmpty, LoadingEvent.LoadingState loadingState, java.lang.Throwable t)
java.lang.Object	dispatchOnEvent(EventHandler eventHandler, java.lang.Object eventState)
protected java.lang.Object	dispatchOnEventImpl(EventHandler eventHandler, java.lang.Object eventState)
protected void	generateChangeSet(SectionContext c, ChangeSet changeSet, SectionContext previousContext, Section previous, SectionContext nextContext, Section next) This method will delegate to the DiffSectionSpec method annotated with OnDiff
protected static EventTrigger	getEventTrigger(SectionContext c, int id, Handle handle)
protected static EventTrigger	getEventTrigger(SectionContext c, int id, java.lang.String key)
static EventHandler	getLoadingEventHandler(SectionContext context)
protected java.lang.Object	getService(Section section)
protected TreeProps	getTreePropsForChildren(SectionContext c, TreeProps previousTreeProps) Updates the TreeProps map with outputs from all OnCreateTreeProp methods.
boolean	isDiffSectionSpec()
static boolean	isSectionIndexValid(SectionContext c, java.lang.String keyString, int index) Check to see if an index provided for within a section is valid
protected static <E> EventHandler<E>	newEventHandler(java.lang.Class<? extends Section> reference, java.lang.String className, SectionContext c, int id, java.lang.Object[] params)
protected static <E> EventTrigger<E>	newEventTrigger(SectionContext c, Section section, int methodId) This variant is used to create an EventTrigger used to register this component as a target in EventTriggersContainer
protected static <E> EventTrigger<E>	newEventTrigger(SectionContext c, java.lang.String childKey, int methodId) Deprecated.
protected void	populateTreeProps(TreeProps parentTreeProps) Retrieves all of the tree props used by this Section from the TreeProps map and sets the tree props as fields on the ComponentImpl.
protected void	refresh(SectionContext sectionContext)
static void	requestFocus(SectionContext c, int index) Scroll to the index of the section.
static void	requestFocus(SectionContext c, java.lang.String sectionKey) Scroll to the beginning of the section with the given key.
static void	requestFocus(SectionContext c, java.lang.String sectionKey, FocusType focusType) Scroll to the index in the section with the given key.
static void	requestFocusWithOffset(SectionContext c, int index, int offset) Scroll to the index in the section with an additional offset.
static void	requestFocusWithOffset(SectionContext c, java.lang.String sectionKey, int offset) Scroll to the beginning of the section with the given key and an additional offset.
static void	requestFocusWithOffset(SectionContext c, java.lang.String sectionKey, int index, int offset) Scroll to the index in the section with the given key and an additional offset.
static void	requestSmoothFocus(SectionContext c, int index)
static void	requestSmoothFocus(SectionContext c, int index, SmoothScrollAlignmentType type)
static void	requestSmoothFocus(SectionContext c, java.lang.String keyString, int index, int offset, SmoothScrollAlignmentType type)
protected boolean	shouldUpdate(SectionContext previousScopedContext, Section previous, SectionContext nextScopedContext, Section next)
protected void	transferService(SectionContext c, Section oldSection, Section newSection) Call this to transfer the Services between two Section with the same global scope.
protected void	transferState(StateContainer previousStateContainer, StateContainer nextStateContainer) Call this to transfer the State annotated values between two Section with the same global scope.
protected void	unbindService(SectionContext c)
protected java.lang.String	verifyChangeSet(SectionContext context)
protected void	viewportChanged(SectionContext sectionContext, int firstVisibleItem, int lastVisibleItem, int totalItemsCount, int firstFullyVisibleItem, int lastFullyVisibleItem)

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionLifecycle

public SectionLifecycle()

Method Detail

createChildren

protected Children createChildren(SectionContext c)

This methods will delegate to the GroupSectionSpec method annotated with OnCreateChildren

generateChangeSet

protected void generateChangeSet(SectionContext c,
                                 ChangeSet changeSet,
                                 SectionContext previousContext,
                                 Section previous,
                                 SectionContext nextContext,
                                 Section next)

This method will delegate to the DiffSectionSpec method annotated with OnDiff

dataBound

protected void dataBound(SectionContext c)

This method will delegate to the SectionSpec method annotated with OnDataBound

dataRendered

protected void dataRendered(SectionContext c,
                            boolean isDataChanged,
                            boolean isMounted,
                            long uptimeMillis,
                            int firstVisibleIndex,
                            int lastVisibleIndex,
                            ChangesInfo changesInfo,
                            int globalOffset)

This method will delegate to the SectionSpec method annotated with OnDataRendered.

bindService

protected void bindService(SectionContext c)

unbindService

protected void unbindService(SectionContext c)

createInitialState

protected void createInitialState(SectionContext c)

createService

protected void createService(SectionContext c)

dispatchOnEvent

public final java.lang.Object dispatchOnEvent(EventHandler eventHandler,
                                              java.lang.Object eventState)

Specified by:

dispatchOnEvent in interface EventDispatcher

dispatchOnEventImpl

protected java.lang.Object dispatchOnEventImpl(EventHandler eventHandler,
                                               java.lang.Object eventState)

acceptTriggerEvent

public final java.lang.Object acceptTriggerEvent(EventTrigger eventTrigger,
                                                 java.lang.Object eventState,
                                                 java.lang.Object[] params)

Specified by:

acceptTriggerEvent in interface EventTriggerTarget

acceptTriggerEventImpl

protected java.lang.Object acceptTriggerEventImpl(EventTrigger eventTrigger,
                                                  java.lang.Object eventState,
                                                  java.lang.Object[] params)

viewportChanged

protected void viewportChanged(SectionContext sectionContext,
                               int firstVisibleItem,
                               int lastVisibleItem,
                               int totalItemsCount,
                               int firstFullyVisibleItem,
                               int lastFullyVisibleItem)

refresh

protected void refresh(SectionContext sectionContext)

transferState

protected void transferState(StateContainer previousStateContainer,
                             StateContainer nextStateContainer)

Call this to transfer the State annotated values between two Section with the same global scope.

transferService

protected void transferService(SectionContext c,
                               Section oldSection,
                               Section newSection)

Call this to transfer the Services between two Section with the same global scope.

getService

protected java.lang.Object getService(Section section)

shouldUpdate

protected boolean shouldUpdate(SectionContext previousScopedContext,
                               Section previous,
                               SectionContext nextScopedContext,
                               Section next)

isDiffSectionSpec

public boolean isDiffSectionSpec()

Returns:

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

verifyChangeSet

protected java.lang.String verifyChangeSet(SectionContext context)

newEventHandler

protected static <E> EventHandler<E> newEventHandler(java.lang.Class<? extends Section> reference,
                                                     java.lang.String className,
                                                     SectionContext c,
                                                     int id,
                                                     java.lang.Object[] params)

newEventTrigger

protected static <E> EventTrigger<E> newEventTrigger(SectionContext c,
                                                     Section section,
                                                     int methodId)

This variant is used to create an EventTrigger used to register this component as a target in EventTriggersContainer

newEventTrigger

@Deprecated
protected static <E> EventTrigger<E> newEventTrigger(SectionContext c,
                                                                 java.lang.String childKey,
                                                                 int methodId)

Deprecated.

This is used to create a Trigger to be invoked later, e.g. in the context of the deprecated trigger API TextInput.requestFocusTrigger(c, "my_key").

getEventTrigger

protected static EventTrigger getEventTrigger(SectionContext c,
                                              int id,
                                              java.lang.String key)

getEventTrigger

protected static EventTrigger getEventTrigger(SectionContext c,
                                              int id,
                                              Handle handle)

populateTreeProps

protected void populateTreeProps(TreeProps parentTreeProps)

Retrieves all of the tree props used by this Section from the TreeProps map and sets the tree props as fields on the ComponentImpl.

getTreePropsForChildren

protected TreeProps getTreePropsForChildren(SectionContext c,
                                            TreeProps previousTreeProps)

Updates the TreeProps map with outputs from all OnCreateTreeProp methods.

getLoadingEventHandler

public static EventHandler getLoadingEventHandler(SectionContext context)

dispatchLoadingEvent

public static void dispatchLoadingEvent(SectionContext context,
                                        boolean isEmpty,
                                        LoadingEvent.LoadingState loadingState,
                                        java.lang.Throwable t)

requestFocus

public static void requestFocus(SectionContext c,
                                int index)

Scroll to the index of the section.

requestFocus

public static void requestFocus(SectionContext c,
                                java.lang.String sectionKey)

Scroll to the beginning of the section with the given key.

requestFocus

public static void requestFocus(SectionContext c,
                                java.lang.String sectionKey,
                                FocusType focusType)

Scroll to the index in the section with the given key.

requestFocusWithOffset

public static void requestFocusWithOffset(SectionContext c,
                                          int index,
                                          int offset)

Scroll to the index in the section with an additional offset. One notable difference between this and the requestFocus(SectionContext, int) API is that this will *always* take an action, while requestFocus(SectionContext, int) will ignore the command if the item is visible on the screen.

Parameters:

offset - distance, in pixels, from the top of the screen to scroll the requested item

requestFocusWithOffset

public static void requestFocusWithOffset(SectionContext c,
                                          java.lang.String sectionKey,
                                          int offset)

Scroll to the beginning of the section with the given key and an additional offset. One notable difference between this and the requestFocus(SectionContext, String) API is that this will *always* take an action, while requestFocus(SectionContext, String) will ignore the command if the item is visible on the screen.

Parameters:

sectionKey - the key of the section component.

offset - distance, in pixels, from the top of the screen to scroll the requested item.

requestFocusWithOffset

public static void requestFocusWithOffset(SectionContext c,
                                          java.lang.String sectionKey,
                                          int index,
                                          int offset)

Scroll to the index in the section with the given key and an additional offset. One notable difference between this and the requestFocus(SectionContext, String) API is that this will *always* take an action, while requestFocus(SectionContext, String) will ignore the command if the item is visible on the screen.

Parameters:

sectionKey - the key of the section component.

index - the index the section component

offset - distance, in pixels, from the top of the screen to scroll the requested item.

requestSmoothFocus

public static void requestSmoothFocus(SectionContext c,
                                      int index)

requestSmoothFocus

public static void requestSmoothFocus(SectionContext c,
                                      int index,
                                      SmoothScrollAlignmentType type)

requestSmoothFocus

public static void requestSmoothFocus(SectionContext c,
                                      java.lang.String keyString,
                                      int index,
                                      int offset,
                                      SmoothScrollAlignmentType type)

isSectionIndexValid

public static boolean isSectionIndexValid(SectionContext c,
                                          java.lang.String keyString,
                                          int index)

Check to see if an index provided for within a section is valid

Parameters:

keyString - the key of the section component

index - the index in the section component

Returns:

if the index is valid for that section component