com.facebook.litho.sections.widget

Class RecyclerCollectionComponent

java.lang.Object

com.facebook.litho.Component

com.facebook.litho.SpecGeneratedComponent

com.facebook.litho.sections.widget.RecyclerCollectionComponent

All Implemented Interfaces:

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

public final class RecyclerCollectionComponent
extends SpecGeneratedComponent

A Component that renders a Recycler backed by a Section tree. See recycler-collection-component for details.

This Component handles the loading events from the Section hierarchy and shows the appropriate error,loading or empty Component passed in as props. If either the empty or the error components are not passed in and the RecyclerCollectionComponent is in one of these states it will simply not render anything.

The RecyclerCollectionComponent also exposes a LoadEventsHandler and a OnScrollListener as Props so its users can receive events about the state of the loading and about the state of the Recycler scrolling.

clipToPadding, clipChildren, itemDecoration, scrollBarStyle, horizontalPadding, verticalPadding and recyclerViewId Props will be directly applied to the Recycler component.

The RecyclerCollectionEventsController Prop is a way to send commands to the RecyclerCollectionComponentSpec, such as scrollTo(position) and refresh().

To trigger scrolling from the Section use SectionLifecycle#requestFocus(SectionContext, int). See communicating-with-the-ui for details.

See Also:

com.facebook.litho.sections.widget.RecyclerCollectionComponentSpec

Required Props

section

Type:

com.facebook.litho.sections.Section

Optional Props

asyncPropUpdates

Type:

boolean

asyncStateUpdates

Type:

boolean

bottomPadding

Type:

int

canMeasureRecycler

Type:

boolean

clipChildren

Type:

boolean

clipToPadding

Type:

boolean

disablePTR

Type:

boolean

emptyComponent

Type:

com.facebook.litho.Component

errorComponent

Type:

com.facebook.litho.Component

eventsController

Type:

com.facebook.litho.sections.widget.RecyclerCollectionEventsController

fadingEdgeLength

Type:

int

forceSyncStateUpdates

Type:

boolean

horizontalFadingEdgeEnabled

Type:

boolean

ignoreLoadingUpdates

Type:

boolean

incrementalMount

Type:

boolean

itemAnimator

This prop defines the animations that take place on items as changes are made. To remove change animation use {@link NoUpdateItemAnimator}. To completely disable all animations use {@link NotAnimatedItemAnimator}.

Type:

androidx.recyclerview.widget.RecyclerView.ItemAnimator

itemDecoration

Type:

androidx.recyclerview.widget.RecyclerView.ItemDecoration

itemTouchListener

Type:

androidx.recyclerview.widget.RecyclerView.OnItemTouchListener

leftPadding

Type:

int

loadEventsHandler

Type:

com.facebook.litho.sections.LoadEventsHandler

loadingComponent

Type:

com.facebook.litho.Component

nestedScrollingEnabled

Type:

boolean

onScrollListeners

Type:

java.util.List

overScrollMode

Type:

int

recyclerConfiguration

Type:

com.facebook.litho.sections.widget.RecyclerConfiguration

recyclerTouchEventHandler

Type:

com.facebook.litho.EventHandler

recyclerViewId

Type:

int

refreshProgressBarBackgroundColor

Type:

java.lang.Integer

refreshProgressBarColor

Type:

int

rightPadding

Type:

int

scrollBarStyle

Type:

int

sectionTreeTag

Type:

java.lang.String

sectionsViewLogger

Type:

com.facebook.litho.widget.SectionsRecyclerView.SectionsRecyclerViewLogger

setRootAsync

Type:

boolean

startupLogger

Type:

com.facebook.litho.LithoStartupLogger

stickyHeaderControllerFactory

Type:

com.facebook.litho.widget.StickyHeaderControllerFactory

topPadding

Type:

int

touchInterceptor

Type:

com.facebook.litho.widget.LithoRecyclerView.TouchInterceptor

verticalFadingEdgeEnabled

Type:

boolean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecyclerCollectionComponent.Builder

Nested classes/interfaces inherited from class com.facebook.litho.SpecGeneratedComponent

SpecGeneratedComponent.TransitionContainer

Nested classes/interfaces inherited from class com.facebook.litho.Component

Component.ContainerBuilder<T extends Component.ContainerBuilder<T>>, Component.MountType, Component.RenderData

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	acceptTriggerEventImpl(EventTrigger eventTrigger, java.lang.Object eventState, java.lang.Object[] params)
static RecyclerCollectionComponent.Builder	create(ComponentContext context)
static RecyclerCollectionComponent.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes)
protected void	createInitialState(ComponentContext c)
protected com.facebook.litho.sections.widget.RecyclerCollectionComponent.RecyclerCollectionComponentStateContainer	createStateContainer()
protected java.lang.Object	dispatchOnEventImpl(EventHandler eventHandler, java.lang.Object eventState)
static EventHandler<PTRRefreshEvent>	getPTRRefreshEventHandler(ComponentContext context)
protected boolean	hasAttachDetachCallback()
protected boolean	hasState()
protected static void	lazyUpdateHasSetSectionTreeRoot(ComponentContext c, boolean lazyUpdateValue)
RecyclerCollectionComponent	makeShallowCopy()
static void	onClearRefreshing(ComponentContext c, Handle handle) This will send the onClearRefreshing trigger to the component with the given handle.
static void	onClearRefreshing(ComponentContext c, java.lang.String key) Deprecated. Use onClearRefreshing(ComponentContext, Handle) instead.
static void	onClearRefreshing(EventTrigger trigger) Deprecated. Use onClearRefreshing(ComponentContext, Handle) instead.
static EventTrigger<ClearRefreshingEvent>	onClearRefreshingTrigger(ComponentContext c, java.lang.String key) Deprecated. Do not use this method to get a EventTrigger to use later. Instead give the component a Handle and use onClearRefreshing(ComponentContext, Handle).
protected Component	onCreateLayout(ComponentContext c) Generate a tree of ComponentLayout representing the layout structure of the Component and its sub-components.
protected void	onDetached(ComponentContext c) Called when the component is detached from the ComponentTree.
static void	onRecyclerConfigChanged(ComponentContext c, Handle handle, int commitPolicy) This will send the onRecyclerConfigChanged trigger to the component with the given handle.
static void	onRecyclerConfigChanged(ComponentContext c, java.lang.String key, int commitPolicy) Deprecated. Use #onRecyclerConfigChanged(ComponentContext, Handle) instead.
static void	onRecyclerConfigChanged(EventTrigger trigger, int commitPolicy) Deprecated. Use #onRecyclerConfigChanged(ComponentContext, Handle) instead.
static EventTrigger<RecyclerDynamicConfigEvent>	onRecyclerConfigChangedTrigger(ComponentContext c, java.lang.String key) Deprecated. Do not use this method to get a EventTrigger to use later. Instead give the component a Handle and use #onRecyclerConfigChanged(ComponentContext, Handle).
static EventHandler<PTRRefreshEvent>	onRefresh(ComponentContext c, SectionTree sectionTree)
static void	onScroll(ComponentContext c, Handle handle, int position, boolean animate) This will send the onScroll trigger to the component with the given handle.
static void	onScroll(ComponentContext c, java.lang.String key, int position, boolean animate) Deprecated. Use #onScroll(ComponentContext, Handle) instead.
static void	onScroll(EventTrigger trigger, int position, boolean animate) Deprecated. Use #onScroll(ComponentContext, Handle) instead.
static EventTrigger<ScrollEvent>	onScrollTrigger(ComponentContext c, java.lang.String key) Deprecated. Do not use this method to get a EventTrigger to use later. Instead give the component a Handle and use #onScroll(ComponentContext, Handle).
void	recordEventTrigger(ComponentContext c, EventTriggersContainer container)
protected void	transferState(StateContainer _prevStateContainer, StateContainer _nextStateContainer) Call this to transfer the State annotated values between two Component with the same global scope.
protected static void	updateLoadingState(ComponentContext c, RecyclerCollectionComponentSpec.LoadingState currentLoadingState)
protected static void	updateLoadingStateAsync(ComponentContext c, RecyclerCollectionComponentSpec.LoadingState currentLoadingState)
protected static void	updateLoadingStateSync(ComponentContext c, RecyclerCollectionComponentSpec.LoadingState currentLoadingState)

Methods inherited from class com.facebook.litho.SpecGeneratedComponent

acceptTriggerEvent, applyPreviousRenderData, bindDynamicProp, canPreallocate, copyInterStageImpl, copyPrepareInterStageImpl, createContent, createInterStagePropsContainer, createPoolableContent, createPrepareInterStagePropsContainer, createRecyclingPool, dispatchOnEnteredRange, dispatchOnExitedRange, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getInterStagePropsContainer, getPoolableContentType, getPrepareInterStagePropsContainer, getSimpleName, getSimpleNameDelegate, getTreePropsForChildren, hasOwnErrorHandler, implementsAccessibility, implementsExtraAccessibilityNodes, isMountSizeDependent, isRecyclingDisabled, needsPreviousRenderData, onAttached, onBind, onBoundsDefined, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onError, onMeasure, onMeasureBaseline, onMount, onPrepare, onUnbind, onUnmount, poolSize, populateTreeProps, prepare, recordRenderData, render, shouldAlwaysRemeasure, usesLocalStateContainer

Methods inherited from class com.facebook.litho.Component

canMeasure, clone, createMountContent, dispatchErrorEvent, dispatchOnEvent, equals, excludeFromIncrementalMount, getCommonProps, getDynamicProps, getErrorHandler, getEventDispatcher, getEventTrigger, getEventTrigger, getHandle, getMountType, getTreePropFromParent, getTypeId, hasChildLithoViews, hasClickHandlerSet, hashCode, implementsShouldUpdate, isEqualivalentTreeProps, isEquivalentCommonProps, isEquivalentProps, isEquivalentTo, isEquivalentTo, isLayoutSpecWithSizeSpec, isPureRender, isPureRender, measure, measure, measureMightNotCacheInternalNode, newEventHandler, newEventTrigger, newEventTrigger, onCreateMountContent, onCreateTransition, onLoadStyle, onPopulateAccessibilityNode, onPopulateExtraAccessibilityNode, registerWorkingRange, resolve, retrieveValue, shouldUpdate, toString, willRender

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createStateContainer

protected com.facebook.litho.sections.widget.RecyclerCollectionComponent.RecyclerCollectionComponentStateContainer createStateContainer()

Overrides:

createStateContainer in class SpecGeneratedComponent

makeShallowCopy

public RecyclerCollectionComponent makeShallowCopy()

Overrides:

makeShallowCopy in class Component

onCreateLayout

protected Component onCreateLayout(ComponentContext c)

Description copied from class: SpecGeneratedComponent

Generate a tree of ComponentLayout representing the layout structure of the Component and its sub-components.

Overrides:

onCreateLayout in class SpecGeneratedComponent

Parameters:

c - The ComponentContext to build a ComponentLayout tree.

createInitialState

protected void createInitialState(ComponentContext c)

Overrides:

createInitialState in class SpecGeneratedComponent

onDetached

protected void onDetached(ComponentContext c)

Description copied from class: SpecGeneratedComponent

Called when the component is detached from the ComponentTree.

Overrides:

onDetached in class SpecGeneratedComponent

Parameters:

c - The ComponentContext the Component was constructed with.

hasAttachDetachCallback

protected boolean hasAttachDetachCallback()

Overrides:

hasAttachDetachCallback in class SpecGeneratedComponent

Returns:

true if the component implements OnAttached or OnDetached delegate methods.

getPTRRefreshEventHandler

public static EventHandler<PTRRefreshEvent> getPTRRefreshEventHandler(ComponentContext context)

onRefresh

public static EventHandler<PTRRefreshEvent> onRefresh(ComponentContext c,
                                                      SectionTree sectionTree)

dispatchOnEventImpl

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

Overrides:

dispatchOnEventImpl in class Component

onScrollTrigger

@Deprecated
public static EventTrigger<ScrollEvent> onScrollTrigger(ComponentContext c,
                                                                    java.lang.String key)

Deprecated. Do not use this method to get a EventTrigger to use later. Instead give the component a Handle and use #onScroll(ComponentContext, Handle).

onRecyclerConfigChangedTrigger

@Deprecated
public static EventTrigger<RecyclerDynamicConfigEvent> onRecyclerConfigChangedTrigger(ComponentContext c,
                                                                                                  java.lang.String key)

Deprecated. Do not use this method to get a EventTrigger to use later. Instead give the component a Handle and use #onRecyclerConfigChanged(ComponentContext, Handle).

onClearRefreshingTrigger

@Deprecated
public static EventTrigger<ClearRefreshingEvent> onClearRefreshingTrigger(ComponentContext c,
                                                                                      java.lang.String key)

Deprecated. Do not use this method to get a EventTrigger to use later. Instead give the component a Handle and use onClearRefreshing(ComponentContext, Handle).

onScroll

public static void onScroll(ComponentContext c,
                            Handle handle,
                            int position,
                            boolean animate)

This will send the onScroll trigger to the component with the given handle. For more information about using triggers, see https://fblitho.com/docs/trigger-events

onScroll

@Deprecated
public static void onScroll(ComponentContext c,
                                        java.lang.String key,
                                        int position,
                                        boolean animate)

Deprecated. Use #onScroll(ComponentContext, Handle) instead.

onScroll

@Deprecated
public static void onScroll(EventTrigger trigger,
                                        int position,
                                        boolean animate)

Deprecated. Use #onScroll(ComponentContext, Handle) instead.

onRecyclerConfigChanged

public static void onRecyclerConfigChanged(ComponentContext c,
                                           Handle handle,
                                           int commitPolicy)

This will send the onRecyclerConfigChanged trigger to the component with the given handle. For more information about using triggers, see https://fblitho.com/docs/trigger-events

onRecyclerConfigChanged

@Deprecated
public static void onRecyclerConfigChanged(ComponentContext c,
                                                       java.lang.String key,
                                                       int commitPolicy)

Deprecated. Use #onRecyclerConfigChanged(ComponentContext, Handle) instead.

onRecyclerConfigChanged

@Deprecated
public static void onRecyclerConfigChanged(EventTrigger trigger,
                                                       int commitPolicy)

Deprecated. Use #onRecyclerConfigChanged(ComponentContext, Handle) instead.

onClearRefreshing

public static void onClearRefreshing(ComponentContext c,
                                     Handle handle)

This will send the onClearRefreshing trigger to the component with the given handle. For more information about using triggers, see https://fblitho.com/docs/trigger-events

onClearRefreshing

@Deprecated
public static void onClearRefreshing(ComponentContext c,
                                                 java.lang.String key)

Deprecated. Use onClearRefreshing(ComponentContext, Handle) instead.

onClearRefreshing

@Deprecated
public static void onClearRefreshing(EventTrigger trigger)

Deprecated. Use onClearRefreshing(ComponentContext, Handle) instead.

acceptTriggerEventImpl

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

Overrides:

acceptTriggerEventImpl in class SpecGeneratedComponent

recordEventTrigger

public void recordEventTrigger(ComponentContext c,
                               EventTriggersContainer container)

Specified by:

recordEventTrigger in interface HasEventTrigger

Overrides:

recordEventTrigger in class SpecGeneratedComponent

hasState

protected boolean hasState()

Overrides:

hasState in class SpecGeneratedComponent

Returns:

true if the Component is using state, false otherwise.

transferState

protected void transferState(StateContainer _prevStateContainer,
                             StateContainer _nextStateContainer)

Description copied from class: Component

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

Overrides:

transferState in class Component

updateLoadingState

protected static void updateLoadingState(ComponentContext c,
                                         RecyclerCollectionComponentSpec.LoadingState currentLoadingState)

updateLoadingStateAsync

protected static void updateLoadingStateAsync(ComponentContext c,
                                              RecyclerCollectionComponentSpec.LoadingState currentLoadingState)

updateLoadingStateSync

protected static void updateLoadingStateSync(ComponentContext c,
                                             RecyclerCollectionComponentSpec.LoadingState currentLoadingState)

lazyUpdateHasSetSectionTreeRoot

protected static void lazyUpdateHasSetSectionTreeRoot(ComponentContext c,
                                                      boolean lazyUpdateValue)

create

public static RecyclerCollectionComponent.Builder create(ComponentContext context)

create

public static RecyclerCollectionComponent.Builder create(ComponentContext context,
                                                         int defStyleAttr,
                                                         int defStyleRes)