com.facebook.litho.widget

Class HorizontalScroll

java.lang.Object

com.facebook.litho.Component

com.facebook.litho.SpecGeneratedComponent

com.facebook.litho.widget.HorizontalScroll

All Implemented Interfaces:

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

public final class HorizontalScroll
extends SpecGeneratedComponent

A component that wraps another component and allow it to be horizontally scrollable. It's analogous to a android.widget.HorizontalScrollView.

See Also:

com.facebook.litho.widget.HorizontalScrollSpec

Required Props

contentProps

Type:

com.facebook.litho.Component

Optional Props

eventsController

Type:

com.facebook.litho.widget.HorizontalScrollEventsController

fillViewport

Type:

boolean

incrementalMountEnabled

Type:

boolean

initialScrollPosition

Type:

int

onScrollChangeListener

Type:

com.facebook.litho.widget.HorizontalScrollLithoView.OnScrollChangeListener

overScrollMode

Type:

int

scrollStateListener

Type:

com.facebook.litho.widget.ScrollStateListener

scrollbarEnabled

Type:

boolean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HorizontalScroll.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.
protected void	copyInterStageImpl(InterStagePropsContainer copyIntoInterStagePropsContainer, InterStagePropsContainer copyFromInterStagePropsContainer)
static HorizontalScroll.Builder	create(ComponentContext context)
static HorizontalScroll.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes)
protected void	createInitialState(ComponentContext c)
protected com.facebook.litho.widget.HorizontalScroll.HorizontalScrollInterStagePropsContainer	createInterStagePropsContainer()
protected com.facebook.litho.widget.HorizontalScroll.HorizontalScrollStateContainer	createStateContainer()
Component.MountType	getMountType() This indicates the type of the Object that will be returned by com.facebook.litho.Component#mount.
protected boolean	hasState()
boolean	isEquivalentProps(Component other, boolean shouldCompareCommonProps) Determine if this component has equivalent props to a given component.
protected boolean	isMountSizeDependent()
HorizontalScroll	makeShallowCopy()
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	onLoadStyle(ComponentContext c)
protected void	onMeasure(ComponentContext context, ComponentLayout layout, int widthSpec, int heightSpec, Size size, InterStagePropsContainer _5)
protected void	onMount(ComponentContext context, java.lang.Object horizontalScrollLithoView, InterStagePropsContainer _2) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onUnmount(ComponentContext context, java.lang.Object mountedView, InterStagePropsContainer _2) Unload UI elements associated with this component.
int	poolSize() This API informs the framework about the size of the content pool.
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, copyPrepareInterStageImpl, createContent, createPoolableContent, createPrepareInterStagePropsContainer, createRecyclingPool, dispatchOnEnteredRange, dispatchOnExitedRange, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getInterStagePropsContainer, getPoolableContentType, getPrepareInterStagePropsContainer, getSimpleName, getSimpleNameDelegate, getTreePropsForChildren, hasAttachDetachCallback, hasOwnErrorHandler, implementsAccessibility, implementsExtraAccessibilityNodes, isRecyclingDisabled, needsPreviousRenderData, onAttached, onBind, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onDetached, onError, onMeasureBaseline, onPrepare, onUnbind, populateTreeProps, prepare, recordEventTrigger, recordRenderData, render, shouldAlwaysRemeasure, usesLocalStateContainer

Methods inherited from class com.facebook.litho.Component

clone, createMountContent, dispatchErrorEvent, dispatchOnEvent, dispatchOnEventImpl, equals, excludeFromIncrementalMount, getCommonProps, getDynamicProps, getErrorHandler, getEventDispatcher, getEventTrigger, getEventTrigger, getHandle, getTreePropFromParent, getTypeId, hasChildLithoViews, hasClickHandlerSet, hashCode, implementsShouldUpdate, isEqualivalentTreeProps, isEquivalentCommonProps, isEquivalentTo, isEquivalentTo, isLayoutSpecWithSizeSpec, isPureRender, isPureRender, measure, measure, measureMightNotCacheInternalNode, newEventHandler, newEventTrigger, newEventTrigger, onCreateTransition, 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.widget.HorizontalScroll.HorizontalScrollStateContainer createStateContainer()

Overrides:

createStateContainer in class SpecGeneratedComponent

createInterStagePropsContainer

protected com.facebook.litho.widget.HorizontalScroll.HorizontalScrollInterStagePropsContainer createInterStagePropsContainer()

Overrides:

createInterStagePropsContainer 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

copyInterStageImpl

protected void copyInterStageImpl(InterStagePropsContainer copyIntoInterStagePropsContainer,
                                  InterStagePropsContainer copyFromInterStagePropsContainer)

Overrides:

copyInterStageImpl in class SpecGeneratedComponent

makeShallowCopy

public HorizontalScroll makeShallowCopy()

Overrides:

makeShallowCopy in class Component

onLoadStyle

protected void onLoadStyle(ComponentContext c)

Overrides:

onLoadStyle in class Component

onMeasure

protected void onMeasure(ComponentContext context,
                         ComponentLayout layout,
                         int widthSpec,
                         int heightSpec,
                         Size size,
                         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 context,
                       java.lang.Object horizontalScrollLithoView,
                       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:

context - The ComponentContext to mount the component into.

onUnmount

protected void onUnmount(ComponentContext context,
                         java.lang.Object mountedView,
                         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.

mountedView - The Drawable or View mounted by this component.

createInitialState

protected void createInitialState(ComponentContext c)

Overrides:

createInitialState in class SpecGeneratedComponent

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.

isMountSizeDependent

protected boolean isMountSizeDependent()

Overrides:

isMountSizeDependent in class SpecGeneratedComponent

Returns:

true if Mount uses @FromMeasure or @FromOnBoundsDefined parameters.

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

create

public static HorizontalScroll.Builder create(ComponentContext context)

create

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