com.facebook.litho.widget

Class Recycler

java.lang.Object

com.facebook.litho.ComponentLifecycle

com.facebook.litho.Component

com.facebook.litho.widget.Recycler

All Implemented Interfaces:

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

public final class Recycler
extends Component

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

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

snapHelper

Type:

androidx.recyclerview.widget.SnapHelper

topPadding

Type:

int

touchInterceptor

Type:

com.facebook.litho.widget.LithoRecylerView.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.Component

Component.ContainerBuilder<T extends Component.ContainerBuilder<T>>

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

ComponentLifecycle.MountType, ComponentLifecycle.RenderData, ComponentLifecycle.TransitionContainer

Method Summary

Modifier and Type	Method and Description
boolean	callsShouldUpdateOnMount()
protected boolean	canMeasure() Whether this ComponentLifecycle is able to measure itself according to specific size constraints.
protected boolean	canPreallocate()
static Recycler.Builder	create(ComponentContext context)
static Recycler.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes)
protected void	createInitialState(ComponentContext c)
Object	dispatchOnEvent(EventHandler eventHandler, Object eventState)
ComponentLifecycle.MountType	getMountType() This indicates the type of the Object that will be returned by ComponentLifecycle.mount(com.facebook.litho.ComponentContext, java.lang.Object).
static EventHandler	getPTRRefreshEventHandler(ComponentContext context)
protected StateContainer	getStateContainer()
boolean	hasChildLithoViews() Whether this ComponentLifecycle mounts views that contain component-based content that can be incrementally mounted e.g.
protected boolean	hasState()
boolean	isEquivalentTo(Component other) Compares this component to a different one to check if they are the same
boolean	isPureRender()
Recycler	makeShallowCopy()
protected void	onBind(ComponentContext context, Object sectionsRecycler)
protected void	onBoundsDefined(ComponentContext context, ComponentLayout layout) Called after the layout calculation is finished and the given ComponentLayout has its bounds defined.
protected 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)
protected void	onMount(ComponentContext c, Object sectionsRecycler) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
static EventHandler<ReMeasureEvent>	onRemeasure(ComponentContext c)
protected void	onUnbind(ComponentContext context, Object sectionsRecycler)
protected void	onUnmount(ComponentContext context, Object sectionsRecycler) 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)
protected int	poolSize()
protected boolean	shouldAlwaysRemeasure()
protected boolean	shouldUpdate(Component _prevAbstractImpl, Component _nextAbstractImpl) 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.Component

bindDynamicProp, canResolve, clearCachedLayout, copyInterStageImpl, getCommonProps, getDynamicProps, getEventDispatcher, getHandle, getId, getKey, getScopedContext, getSimpleName, getSimpleNameDelegate, hasBackgroundSet, hasClickHandlerSet, measure, measureMightNotCacheInternalNode, recordEventTrigger, registerWorkingRange, retrieveValue, setScopedContext, updateInternalChildState, willRender

Methods inherited from class com.facebook.litho.ComponentLifecycle

acceptTriggerEvent, applyPreviousRenderData, createMountContent, dispatchErrorEvent, dispatchErrorEvent, dispatchOnEnteredRange, dispatchOnExitedRange, getEventTrigger, getEventTrigger, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getTreePropsForChildren, hasAttachDetachCallback, implementsAccessibility, implementsExtraAccessibilityNodes, isLayoutSpecWithSizeSpecCheck, isMountSizeDependent, needsPreviousRenderData, newEventHandler, newEventTrigger, onAttached, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onCreateTransition, onDetached, onError, onLoadStyle, onMeasureBaseline, onPopulateAccessibilityNode, onPopulateExtraAccessibilityNode, onPrepare, onShouldCreateLayoutWithNewSizeSpec, populateTreeProps, recordRenderData, resolve, shouldUseGlobalPool

Methods inherited from class java.lang.Object

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

Method Detail

getStateContainer

protected StateContainer getStateContainer()

Overrides:

getStateContainer in class Component

isEquivalentTo

public boolean isEquivalentTo(Component other)

Description copied from class: Component

Compares this component to a different one to check if they are the same

This is used to be able to skip rendering a component 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<Component>

Overrides:

isEquivalentTo in class Component

Parameters:

other - the component to compare to

Returns:

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

makeShallowCopy

public Recycler makeShallowCopy()

Overrides:

makeShallowCopy in class Component

onMeasure

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

Overrides:

onMeasure in class ComponentLifecycle

canMeasure

protected boolean canMeasure()

Description copied from class: ComponentLifecycle

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

Overrides:

canMeasure in class ComponentLifecycle

onBoundsDefined

protected void onBoundsDefined(ComponentContext context,
                               ComponentLayout layout)

Description copied from class: ComponentLifecycle

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 ComponentLifecycle

Parameters:

context - The Context used by this component.

layout - The ComponentLayout with defined position and size.

onCreateMountContent

protected Object onCreateMountContent(Context c)

Description copied from class: ComponentLifecycle

Create the object that will be mounted in the LithoView.

Overrides:

onCreateMountContent in class ComponentLifecycle

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,
                       Object sectionsRecycler)

Description copied from class: ComponentLifecycle

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 ComponentLifecycle

Parameters:

c - The ComponentContext to mount the component into.

onBind

protected void onBind(ComponentContext context,
                      Object sectionsRecycler)

Overrides:

onBind in class ComponentLifecycle

onUnbind

protected void onUnbind(ComponentContext context,
                        Object sectionsRecycler)

Overrides:

onUnbind in class ComponentLifecycle

onUnmount

protected void onUnmount(ComponentContext context,
                         Object sectionsRecycler)

Description copied from class: ComponentLifecycle

Unload UI elements associated with this component.

Overrides:

onUnmount in class ComponentLifecycle

Parameters:

context - The Context for this mount operation.

sectionsRecycler - The Drawable or View mounted by this component.

shouldUpdate

protected boolean shouldUpdate(Component _prevAbstractImpl,
                               Component _nextAbstractImpl)

Description copied from class: ComponentLifecycle

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 ComponentLifecycle

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.

createInitialState

protected void createInitialState(ComponentContext c)

Overrides:

createInitialState in class ComponentLifecycle

shouldAlwaysRemeasure

protected boolean shouldAlwaysRemeasure()

Overrides:

shouldAlwaysRemeasure in class ComponentLifecycle

Returns:

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

getMountType

public ComponentLifecycle.MountType getMountType()

Description copied from class: ComponentLifecycle

This indicates the type of the Object that will be returned by ComponentLifecycle.mount(com.facebook.litho.ComponentContext, java.lang.Object).

Overrides:

getMountType in class ComponentLifecycle

Returns:

one of ComponentLifecycle.MountType

poolSize

protected int poolSize()

Overrides:

poolSize in class ComponentLifecycle

canPreallocate

protected boolean canPreallocate()

Overrides:

canPreallocate in class ComponentLifecycle

Returns:

true if this component can be preallocated.

hasChildLithoViews

public boolean hasChildLithoViews()

Description copied from class: ComponentLifecycle

Whether this ComponentLifecycle 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 ComponentLifecycle

callsShouldUpdateOnMount

public boolean callsShouldUpdateOnMount()

Overrides:

callsShouldUpdateOnMount in class ComponentLifecycle

isPureRender

public boolean isPureRender()

Overrides:

isPureRender in class ComponentLifecycle

getPTRRefreshEventHandler

public static EventHandler getPTRRefreshEventHandler(ComponentContext context)

onRemeasure

public static EventHandler<ReMeasureEvent> onRemeasure(ComponentContext c)

dispatchOnEvent

public Object dispatchOnEvent(EventHandler eventHandler,
                              Object eventState)

Specified by:

dispatchOnEvent in interface EventDispatcher

Overrides:

dispatchOnEvent in class ComponentLifecycle

hasState

protected boolean hasState()

Overrides:

hasState in class ComponentLifecycle

Returns:

true if the Component is using state, false otherwise.

transferState

protected void transferState(StateContainer _prevStateContainer,
                             StateContainer _nextStateContainer)

Description copied from class: ComponentLifecycle

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

Overrides:

transferState in class ComponentLifecycle

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)