com.facebook.litho.widget

Class SizeSpecMountWrapperComponent

java.lang.Object

com.facebook.litho.Component

com.facebook.litho.SpecGeneratedComponent

com.facebook.litho.widget.SizeSpecMountWrapperComponent

All Implemented Interfaces:

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

public final class SizeSpecMountWrapperComponent
extends SpecGeneratedComponent

A MountSpec implementation to provide width and height information to the wrapped component.

Usage: Create a SizeSpecMountWrapperComponentSpec with a Component added to it, and it will provide the width and height information through a Size typed TreeProp.

See Also:

com.facebook.litho.widget.SizeSpecMountWrapperComponentSpec

Required Props

component

Type:

com.facebook.litho.Component

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SizeSpecMountWrapperComponent.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 SizeSpecMountWrapperComponent.Builder	create(ComponentContext context)
static SizeSpecMountWrapperComponent.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes)
protected void	createInitialState(ComponentContext c)
protected com.facebook.litho.widget.SizeSpecMountWrapperComponent.SizeSpecMountWrapperComponentStateContainer	createStateContainer()
Component.MountType	getMountType() This indicates the type of the Object that will be returned by com.facebook.litho.Component#mount.
protected boolean	hasAttachDetachCallback()
boolean	hasChildLithoViews() Whether this Component mounts views that contain component-based content that can be incrementally mounted e.g.
protected boolean	hasState()
boolean	isEquivalentProps(Component other, boolean shouldCompareCommonProps) Determine if this component has equivalent props to a given component.
SizeSpecMountWrapperComponent	makeShallowCopy()
protected void	onBind(ComponentContext c, java.lang.Object wrapperView, InterStagePropsContainer _2)
protected void	onBoundsDefined(ComponentContext c, 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	onDetached(ComponentContext c) Called when the component is detached from the ComponentTree.
protected void	onMeasure(ComponentContext c, ComponentLayout layout, int widthSpec, int heightSpec, Size size, InterStagePropsContainer _5)
protected void	onMount(ComponentContext c, java.lang.Object wrapperView, InterStagePropsContainer _2) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onUnbind(ComponentContext c, java.lang.Object wrapperView, InterStagePropsContainer _2)
protected void	onUnmount(ComponentContext c, java.lang.Object wrapperView, 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, copyInterStageImpl, copyPrepareInterStageImpl, createContent, createInterStagePropsContainer, createPoolableContent, createPrepareInterStagePropsContainer, createRecyclingPool, dispatchOnEnteredRange, dispatchOnExitedRange, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getInterStagePropsContainer, getPoolableContentType, getPrepareInterStagePropsContainer, getSimpleName, getSimpleNameDelegate, getTreePropsForChildren, hasOwnErrorHandler, implementsAccessibility, implementsExtraAccessibilityNodes, isMountSizeDependent, isRecyclingDisabled, needsPreviousRenderData, onAttached, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onError, onMeasureBaseline, onPrepare, 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, hasClickHandlerSet, hashCode, implementsShouldUpdate, isEqualivalentTreeProps, isEquivalentCommonProps, isEquivalentTo, isEquivalentTo, isLayoutSpecWithSizeSpec, isPureRender, isPureRender, measure, measure, measureMightNotCacheInternalNode, newEventHandler, newEventTrigger, newEventTrigger, 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.widget.SizeSpecMountWrapperComponent.SizeSpecMountWrapperComponentStateContainer 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 SizeSpecMountWrapperComponent makeShallowCopy()

Overrides:

makeShallowCopy in class Component

createInitialState

protected void createInitialState(ComponentContext c)

Overrides:

createInitialState in class SpecGeneratedComponent

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 wrapperView,
                       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.

onUnmount

protected void onUnmount(ComponentContext c,
                         java.lang.Object wrapperView,
                         InterStagePropsContainer _2)

Description copied from class: SpecGeneratedComponent

Unload UI elements associated with this component.

Overrides:

onUnmount in class SpecGeneratedComponent

Parameters:

c - The Context for this mount operation.

wrapperView - The Drawable or View mounted by this component.

onMeasure

protected void onMeasure(ComponentContext c,
                         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 c,
                               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:

c - The Context used by this component.

layout - The ComponentLayout with defined position and size.

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.

onBind

protected void onBind(ComponentContext c,
                      java.lang.Object wrapperView,
                      InterStagePropsContainer _2)

Overrides:

onBind in class SpecGeneratedComponent

onUnbind

protected void onUnbind(ComponentContext c,
                        java.lang.Object wrapperView,
                        InterStagePropsContainer _2)

Overrides:

onUnbind in class SpecGeneratedComponent

hasAttachDetachCallback

protected boolean hasAttachDetachCallback()

Overrides:

hasAttachDetachCallback in class SpecGeneratedComponent

Returns:

true if the component implements OnAttached or OnDetached delegate methods.

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

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 SizeSpecMountWrapperComponent.Builder create(ComponentContext context)

create

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