com.facebook.litho.widget

Class Recycler

java.lang.Object

com.facebook.litho.Component

com.facebook.litho.SpecGeneratedComponent

com.facebook.litho.widget.Recycler

All Implemented Interfaces:

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

public final class Recycler
extends SpecGeneratedComponent

Components that renders a RecyclerView.

See Also:

com.facebook.litho.widget.RecyclerSpec

Required Props

binder

Binder for RecyclerView.

Type:

com.facebook.litho.widget.Binder

Optional Props

bottomPadding

Type:

int

clipChildren

Clip RecyclerView children to their bounds.

Type:

boolean

clipToPadding

Clip RecyclerView to its padding.

Type:

boolean

contentDescription

Type:

java.lang.CharSequence

fadingEdgeLength

Type:

int

hasFixedSize

If set, makes RecyclerView not affected by adapter changes.

Type:

boolean

horizontalFadingEdgeEnabled

Type:

boolean

itemAnimator

Type:

androidx.recyclerview.widget.RecyclerView.ItemAnimator

itemDecoration

Item decoration for the RecyclerView.

Type:

androidx.recyclerview.widget.RecyclerView.ItemDecoration

leftPadding

Type:

int

nestedScrollingEnabled

Enables nested scrolling on the RecyclerView.

Type:

boolean

onItemTouchListener

Type:

androidx.recyclerview.widget.RecyclerView.OnItemTouchListener

onScrollListeners

Type:

java.util.List

overScrollMode

Type:

int

pullToRefresh

Type:

boolean

recyclerEventsController

Controller to pass events from outside the component.

Type:

com.facebook.litho.widget.RecyclerEventsController

recyclerViewId

View ID for the RecyclerView.

Type:

int

refreshHandler

Event handler for refresh event.

Type:

com.facebook.litho.EventHandler

refreshProgressBarBackgroundColor

Color for progress background.

Type:

java.lang.Integer

refreshProgressBarColor

Color for progress animation.

Type:

int

rightPadding

Type:

int

scrollBarStyle

Type:

int

sectionsViewLogger

Type:

com.facebook.litho.widget.SectionsRecyclerView.SectionsRecyclerViewLogger

snapHelper

Type:

androidx.recyclerview.widget.SnapHelper

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	Recycler.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 boolean	canMeasure() Whether this Component is able to measure itself according to specific size constraints.
boolean	canPreallocate() This API informs the framework to fill the content pool for this Mountable ahead of time.
static Recycler.Builder	create(ComponentContext context)
static Recycler.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes)
protected void	createInitialState(ComponentContext _0)
protected com.facebook.litho.widget.Recycler.RecyclerStateContainer	createStateContainer()
protected java.lang.Object	dispatchOnEventImpl(EventHandler eventHandler, java.lang.Object eventState)
Component.MountType	getMountType() This indicates the type of the Object that will be returned by com.facebook.litho.Component#mount.
static EventHandler<PTRRefreshEvent>	getPTRRefreshEventHandler(ComponentContext context)
boolean	hasChildLithoViews() Whether this Component mounts views that contain component-based content that can be incrementally mounted e.g.
protected boolean	hasState()
boolean	implementsShouldUpdate()
boolean	isEquivalentProps(Component other, boolean shouldCompareCommonProps) Determine if this component has equivalent props to a given component.
boolean	isPureRender()
Recycler	makeShallowCopy()
protected void	onBind(ComponentContext context, java.lang.Object sectionsRecycler, InterStagePropsContainer _2)
protected void	onBoundsDefined(ComponentContext context, ComponentLayout layout, InterStagePropsContainer _2) Called after the layout calculation is finished and the given ComponentLayout has its bounds defined.
protected java.lang.Object	onCreateMountContent(Context c) Create the object that will be mounted in the LithoView.
protected void	onMeasure(ComponentContext c, ComponentLayout layout, int widthSpec, int heightSpec, Size measureOutput, InterStagePropsContainer _5)
protected void	onMount(ComponentContext c, java.lang.Object sectionsRecycler, InterStagePropsContainer _2) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
static EventHandler<ReMeasureEvent>	onRemeasure(ComponentContext c)
protected void	onUnbind(ComponentContext context, java.lang.Object sectionsRecycler, InterStagePropsContainer _2)
protected void	onUnmount(ComponentContext context, java.lang.Object sectionsRecycler, InterStagePropsContainer _2) Unload UI elements associated with this component.
protected static void	onUpdateMeasure(ComponentContext c, int measureVer)
protected static void	onUpdateMeasureAsync(ComponentContext c, int measureVer)
protected static void	onUpdateMeasureSync(ComponentContext c, int measureVer)
int	poolSize() This API informs the framework about the size of the content pool.
protected boolean	shouldAlwaysRemeasure()
protected boolean	shouldUpdate(Component _prevAbstractImpl, StateContainer _prevStateContainer, Component _nextAbstractImpl, StateContainer _nextStateContainer) Whether the component needs updating.
protected void	transferState(StateContainer _prevStateContainer, StateContainer _nextStateContainer) Call this to transfer the State annotated values between two Component with the same global scope.

Methods inherited from class com.facebook.litho.SpecGeneratedComponent

acceptTriggerEvent, acceptTriggerEventImpl, applyPreviousRenderData, bindDynamicProp, copyInterStageImpl, copyPrepareInterStageImpl, createContent, createInterStagePropsContainer, createPoolableContent, createPrepareInterStagePropsContainer, createRecyclingPool, dispatchOnEnteredRange, dispatchOnExitedRange, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getInterStagePropsContainer, getPoolableContentType, getPrepareInterStagePropsContainer, getSimpleName, getSimpleNameDelegate, getTreePropsForChildren, hasAttachDetachCallback, hasOwnErrorHandler, implementsAccessibility, implementsExtraAccessibilityNodes, isMountSizeDependent, isRecyclingDisabled, needsPreviousRenderData, onAttached, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onDetached, onError, onMeasureBaseline, onPrepare, populateTreeProps, prepare, recordEventTrigger, recordRenderData, render, usesLocalStateContainer

Methods inherited from class com.facebook.litho.Component

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

Methods inherited from class java.lang.Object

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

Method Detail

createStateContainer

protected com.facebook.litho.widget.Recycler.RecyclerStateContainer createStateContainer()

Overrides:

createStateContainer in class SpecGeneratedComponent

isEquivalentProps

public boolean isEquivalentProps(Component other,
                                 boolean shouldCompareCommonProps)

Description copied from class: Component

Determine if this component has equivalent props to a given component. This method does not compare common props.

Overrides:

isEquivalentProps in class Component

Parameters:

other - the component to compare to

Returns:

true if the components have equivalent props

makeShallowCopy

public Recycler makeShallowCopy()

Overrides:

makeShallowCopy in class Component

onMeasure

protected void onMeasure(ComponentContext c,
                         ComponentLayout layout,
                         int widthSpec,
                         int heightSpec,
                         Size measureOutput,
                         InterStagePropsContainer _5)

Overrides:

onMeasure in class SpecGeneratedComponent

canMeasure

protected boolean canMeasure()

Description copied from class: Component

Whether this Component is able to measure itself according to specific size constraints.

Overrides:

canMeasure in class Component

onBoundsDefined

protected void onBoundsDefined(ComponentContext context,
                               ComponentLayout layout,
                               InterStagePropsContainer _2)

Description copied from class: SpecGeneratedComponent

Called after the layout calculation is finished and the given ComponentLayout has its bounds defined. You can use ComponentLayout.getX(), ComponentLayout.getY(), ComponentLayout.getWidth(), and ComponentLayout.getHeight() to get the size and position of the component in the layout tree.

Overrides:

onBoundsDefined in class SpecGeneratedComponent

Parameters:

context - The Context used by this component.

layout - The ComponentLayout with defined position and size.

onCreateMountContent

protected java.lang.Object onCreateMountContent(Context c)

Description copied from class: Component

Create the object that will be mounted in the LithoView.

Overrides:

onCreateMountContent in class Component

Parameters:

c - The Context to be used to create the content.

Returns:

an Object that can be mounted for this component.

onMount

protected void onMount(ComponentContext c,
                       java.lang.Object sectionsRecycler,
                       InterStagePropsContainer _2)

Description copied from class: SpecGeneratedComponent

Deploy all UI elements representing the final bounds defined in the given ComponentLayout. Return either a Drawable or a View or null to be mounted.

Overrides:

onMount in class SpecGeneratedComponent

Parameters:

c - The ComponentContext to mount the component into.

onBind

protected void onBind(ComponentContext context,
                      java.lang.Object sectionsRecycler,
                      InterStagePropsContainer _2)

Overrides:

onBind in class SpecGeneratedComponent

onUnbind

protected void onUnbind(ComponentContext context,
                        java.lang.Object sectionsRecycler,
                        InterStagePropsContainer _2)

Overrides:

onUnbind in class SpecGeneratedComponent

onUnmount

protected void onUnmount(ComponentContext context,
                         java.lang.Object sectionsRecycler,
                         InterStagePropsContainer _2)

Description copied from class: SpecGeneratedComponent

Unload UI elements associated with this component.

Overrides:

onUnmount in class SpecGeneratedComponent

Parameters:

context - The Context for this mount operation.

sectionsRecycler - The Drawable or View mounted by this component.

shouldUpdate

protected boolean shouldUpdate(Component _prevAbstractImpl,
                               StateContainer _prevStateContainer,
                               Component _nextAbstractImpl,
                               StateContainer _nextStateContainer)

Description copied from class: Component

Whether the component needs updating.

For layout components, the framework will verify that none of the children of the component need updating, and that both components have the same number of children. Therefore this method just needs to determine any changes to the top-level component that would cause it to need to be updated (for example, a click handler was added).

For mount specs, the framework does nothing extra and this method alone determines whether the component is updated or not.

Overrides:

shouldUpdate in class Component

Parameters:

_prevAbstractImpl - the previous component to compare against.

_nextAbstractImpl - the component that is now in use.

Returns:

true if the component needs an update, false otherwise.

implementsShouldUpdate

public boolean implementsShouldUpdate()

Overrides:

implementsShouldUpdate in class Component

createInitialState

protected void createInitialState(ComponentContext _0)

Overrides:

createInitialState in class SpecGeneratedComponent

shouldAlwaysRemeasure

protected boolean shouldAlwaysRemeasure()

Overrides:

shouldAlwaysRemeasure in class SpecGeneratedComponent

Returns:

true if the Component should always be measured when receiving a remeasure event, false otherwise.

getMountType

public Component.MountType getMountType()

Description copied from class: Component

This indicates the type of the Object that will be returned by com.facebook.litho.Component#mount.

Overrides:

getMountType in class Component

Returns:

one of Component.MountType

poolSize

public int poolSize()

Description copied from interface: ContentAllocator

This API informs the framework about the size of the content pool. The default is 3.

Experimental. Currently for Litho team internal use only.

Specified by:

poolSize in interface ContentAllocator

Overrides:

poolSize in class SpecGeneratedComponent

canPreallocate

public boolean canPreallocate()

Description copied from interface: ContentAllocator

This API informs the framework to fill the content pool for this Mountable ahead of time. The default value is false, i.e. content is not pre-allocated. Pre-allocation of the content can improve performance in some circumstances where creating the content is expensive.

Specified by:

canPreallocate in interface ContentAllocator

Overrides:

canPreallocate in class SpecGeneratedComponent

Returns:

true if this component can be preallocated.

hasChildLithoViews

public boolean hasChildLithoViews()

Description copied from class: Component

Whether this Component mounts views that contain component-based content that can be incrementally mounted e.g. if the mounted view has a LithoView with incremental mount enabled.

Overrides:

hasChildLithoViews in class Component

isPureRender

public boolean isPureRender()

Overrides:

isPureRender in class Component

getPTRRefreshEventHandler

public static EventHandler<PTRRefreshEvent> getPTRRefreshEventHandler(ComponentContext context)

onRemeasure

public static EventHandler<ReMeasureEvent> onRemeasure(ComponentContext c)

dispatchOnEventImpl

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

Overrides:

dispatchOnEventImpl in class Component

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

onUpdateMeasure

protected static void onUpdateMeasure(ComponentContext c,
                                      int measureVer)

onUpdateMeasureAsync

protected static void onUpdateMeasureAsync(ComponentContext c,
                                           int measureVer)

onUpdateMeasureSync

protected static void onUpdateMeasureSync(ComponentContext c,
                                          int measureVer)

create

public static Recycler.Builder create(ComponentContext context)

create

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