com.facebook.litho

Class SpecGeneratedComponent

java.lang.Object

com.facebook.litho.Component

com.facebook.litho.SpecGeneratedComponent

All Implemented Interfaces:

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

Direct Known Subclasses:

Button, Card, CardClip, CardShadow, EditText, HorizontalScroll, Image, Progress, Recycler, RecyclerCollectionComponent, SizeSpecMountWrapperComponent, SolidColor, Spinner, TestComponent, TestSizeDependentComponent, Text, TextInput, TouchableFeedback, TransparencyEnabledCard, TransparencyEnabledCardClip, VerticalScroll, ViewCompatComponent, ViewPagerComponent, Wrapper

public abstract class SpecGeneratedComponent
extends Component
implements ContentAllocator, EventTriggerTarget, HasEventTrigger

Base class for all component generated via the Spec API (@LayoutSpec and @MountSpec).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpecGeneratedComponent.TransitionContainer Generated component's state container could implement this interface along with StateContainer when componentspec specifies state update method with OnUpdateStateWithTransition annotation.

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpecGeneratedComponent(int identityHashCode, java.lang.String simpleName)
protected	SpecGeneratedComponent(java.lang.String simpleName)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	acceptTriggerEvent(EventTrigger eventTrigger, java.lang.Object eventState, java.lang.Object[] params)
protected java.lang.Object	acceptTriggerEventImpl(EventTrigger eventTrigger, java.lang.Object eventState, java.lang.Object[] params)
protected void	applyPreviousRenderData(Component.RenderData previousRenderData)
protected void	bindDynamicProp(int dynamicPropIndex, java.lang.Object value, java.lang.Object content)
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)
protected void	copyPrepareInterStageImpl(PrepareInterStagePropsContainer copyIntoInterStagePropsContainer, PrepareInterStagePropsContainer copyFromInterStagePropsContainer)
java.lang.Object	createContent(Context context) Allocates the mountable content (View or Drawable).
protected void	createInitialState(ComponentContext c)
protected InterStagePropsContainer	createInterStagePropsContainer()
java.lang.Object	createPoolableContent(Context context) Creates a mount-content that can be pooled.
protected PrepareInterStagePropsContainer	createPrepareInterStagePropsContainer()
MountItemsPool.ItemPool	createRecyclingPool() Creates an ItemPool for this mountable content.
protected StateContainer	createStateContainer()
protected void	dispatchOnEnteredRange(ComponentContext c, java.lang.String name)
protected void	dispatchOnExitedRange(ComponentContext c, java.lang.String name)
protected int	getExtraAccessibilityNodeAt(ComponentContext c, int x, int y, InterStagePropsContainer InterStagePropsContainer) Get extra accessibility node id at a given point within the component.
protected int	getExtraAccessibilityNodesCount(ComponentContext c, InterStagePropsContainer interStagePropsContainer) The number of extra accessibility nodes that this component wishes to provides to the accessibility system.
protected InterStagePropsContainer	getInterStagePropsContainer(ComponentContext scopedContext, InterStagePropsContainer interStagePropsContainer)
java.lang.Object	getPoolableContentType() Returns an object defining the type of the mount-content.
protected PrepareInterStagePropsContainer	getPrepareInterStagePropsContainer(ComponentContext scopedContext)
java.lang.String	getSimpleName() Should only be used by logging to provide more readable messages.
protected Component	getSimpleNameDelegate()
protected TreeProps	getTreePropsForChildren(ComponentContext c, TreeProps treeProps) Updates the TreeProps map with outputs from all OnCreateTreeProp methods.
protected boolean	hasAttachDetachCallback()
protected boolean	hasOwnErrorHandler() This method is overridden in the generated component to return true if and only if the Component Spec has an OnError lifecycle callback.
protected boolean	hasState()
protected boolean	implementsAccessibility() Whether this component will populate any accessibility nodes or events that are passed to it.
protected boolean	implementsExtraAccessibilityNodes() Whether this component will expose any virtual views to the accessibility framework
protected boolean	isMountSizeDependent()
boolean	isRecyclingDisabled() Return true if pooling should be disabled for this mount content.
protected boolean	needsPreviousRenderData()
protected void	onAttached(ComponentContext c) Called when the component is attached to the ComponentTree.
protected void	onBind(ComponentContext c, java.lang.Object mountedContent, InterStagePropsContainer interStagePropsContainer)
protected void	onBoundsDefined(ComponentContext c, ComponentLayout layout, InterStagePropsContainer interStagePropsContainer) Called after the layout calculation is finished and the given ComponentLayout has its bounds defined.
protected Component	onCreateLayout(ComponentContext c) Generate a tree of ComponentLayout representing the layout structure of the Component and its sub-components.
protected Component	onCreateLayoutWithSizeSpec(ComponentContext c, int widthSpec, int heightSpec)
MountContentPool	onCreateMountContentPool() Creates the content pool the framework should use for this Mountable.
protected void	onDetached(ComponentContext c) Called when the component is detached from the ComponentTree.
protected void	onError(ComponentContext c, java.lang.Exception e) Called to provide a fallback if a supported lifecycle method throws an exception.
protected void	onMeasure(ComponentContext c, ComponentLayout layout, int widthSpec, int heightSpec, Size size, InterStagePropsContainer interStagePropsContainer)
protected int	onMeasureBaseline(ComponentContext c, int width, int height, InterStagePropsContainer interStagePropsContainer) Called during layout calculation to determine the baseline of a component.
protected void	onMount(ComponentContext c, java.lang.Object convertContent, InterStagePropsContainer interStagePropsContainer) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onPrepare(ComponentContext c)
protected void	onUnbind(ComponentContext c, java.lang.Object mountedContent, InterStagePropsContainer interStagePropsContainer)
protected void	onUnmount(ComponentContext c, java.lang.Object mountedContent, InterStagePropsContainer interStagePropsContainer) Unload UI elements associated with this component.
int	poolSize() This API informs the framework about the size of the content pool.
protected void	populateTreeProps(TreeProps parentTreeProps) Retrieves all of the tree props used by this Component from the TreeProps map and sets the tree props as fields on the ComponentImpl.
protected PrepareResult	prepare(RenderStateContext renderStateContext, ComponentContext c)
void	recordEventTrigger(ComponentContext c, EventTriggersContainer container)
protected Component.RenderData	recordRenderData(ComponentContext c, Component.RenderData toRecycle)
protected RenderResult	render(RenderStateContext renderStateContext, ComponentContext c, int widthSpec, int heightSpec) Invokes the Component-specific render implementation, returning a RenderResult.
protected boolean	shouldAlwaysRemeasure()
protected boolean	usesLocalStateContainer()

Methods inherited from class com.facebook.litho.Component

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecGeneratedComponent

protected SpecGeneratedComponent(java.lang.String simpleName)

SpecGeneratedComponent

protected SpecGeneratedComponent(int identityHashCode,
                                 java.lang.String simpleName)

Method Detail

getSimpleName

public final java.lang.String getSimpleName()

Should only be used by logging to provide more readable messages.

Overrides:

getSimpleName in class Component

createStateContainer

protected StateContainer createStateContainer()

getSimpleNameDelegate

protected Component getSimpleNameDelegate()

Returns:

the Component this Component should delegate its getSimpleName calls to. See LayoutSpec#simpleNameDelegate()

render

protected RenderResult render(RenderStateContext renderStateContext,
                              ComponentContext c,
                              int widthSpec,
                              int heightSpec)

Description copied from class: Component

Invokes the Component-specific render implementation, returning a RenderResult. The RenderResult will have the Component this Component rendered to (which will then need to be render()'ed or #resolve(LayoutStateContext, ComponentContext)'ed), as well as other metadata from that render call such as transitions that should be applied.

Overrides:

render in class Component

prepare

protected final PrepareResult prepare(RenderStateContext renderStateContext,
                                      ComponentContext c)

Overrides:

prepare in class Component

recordEventTrigger

public void recordEventTrigger(ComponentContext c,
                               EventTriggersContainer container)

Specified by:

recordEventTrigger in interface HasEventTrigger

onCreateLayout

protected Component onCreateLayout(ComponentContext c)

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

Parameters:

c - The ComponentContext to build a ComponentLayout tree.

onCreateLayoutWithSizeSpec

protected Component onCreateLayoutWithSizeSpec(ComponentContext c,
                                               int widthSpec,
                                               int heightSpec)

onPrepare

protected void onPrepare(ComponentContext c)

usesLocalStateContainer

protected boolean usesLocalStateContainer()

Overrides:

usesLocalStateContainer in class Component

acceptTriggerEvent

public final java.lang.Object acceptTriggerEvent(EventTrigger eventTrigger,
                                                 java.lang.Object eventState,
                                                 java.lang.Object[] params)

Specified by:

acceptTriggerEvent in interface EventTriggerTarget

acceptTriggerEventImpl

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

applyPreviousRenderData

protected void applyPreviousRenderData(Component.RenderData previousRenderData)

bindDynamicProp

protected void bindDynamicProp(int dynamicPropIndex,
                               java.lang.Object value,
                               java.lang.Object content)

copyInterStageImpl

protected void copyInterStageImpl(InterStagePropsContainer copyIntoInterStagePropsContainer,
                                  InterStagePropsContainer copyFromInterStagePropsContainer)

copyPrepareInterStageImpl

protected void copyPrepareInterStageImpl(PrepareInterStagePropsContainer copyIntoInterStagePropsContainer,
                                         PrepareInterStagePropsContainer copyFromInterStagePropsContainer)

createInitialState

protected void createInitialState(ComponentContext c)

createInterStagePropsContainer

protected InterStagePropsContainer createInterStagePropsContainer()

createPrepareInterStagePropsContainer

protected PrepareInterStagePropsContainer createPrepareInterStagePropsContainer()

dispatchOnEnteredRange

protected void dispatchOnEnteredRange(ComponentContext c,
                                      java.lang.String name)

dispatchOnExitedRange

protected void dispatchOnExitedRange(ComponentContext c,
                                     java.lang.String name)

getExtraAccessibilityNodeAt

protected int getExtraAccessibilityNodeAt(ComponentContext c,
                                          int x,
                                          int y,
                                          InterStagePropsContainer InterStagePropsContainer)

Get extra accessibility node id at a given point within the component.

Parameters:

x - x co-ordinate within the mounted component

y - y co-ordinate within the mounted component

Returns:

the extra virtual view id if one is found, otherwise ExploreByTouchHelper#INVALID_ID

getExtraAccessibilityNodesCount

protected int getExtraAccessibilityNodesCount(ComponentContext c,
                                              InterStagePropsContainer interStagePropsContainer)

The number of extra accessibility nodes that this component wishes to provides to the accessibility system.

Returns:

the number of extra nodes

getInterStagePropsContainer

protected final InterStagePropsContainer getInterStagePropsContainer(ComponentContext scopedContext,
                                                                     InterStagePropsContainer interStagePropsContainer)

getPrepareInterStagePropsContainer

protected final PrepareInterStagePropsContainer getPrepareInterStagePropsContainer(ComponentContext scopedContext)

getTreePropsForChildren

protected TreeProps getTreePropsForChildren(ComponentContext c,
                                            TreeProps treeProps)

Updates the TreeProps map with outputs from all OnCreateTreeProp methods.

hasAttachDetachCallback

protected boolean hasAttachDetachCallback()

Returns:

true if the component implements OnAttached or OnDetached delegate methods.

hasOwnErrorHandler

protected boolean hasOwnErrorHandler()

This method is overridden in the generated component to return true if and only if the Component Spec has an OnError lifecycle callback.

hasState

protected boolean hasState()

Returns:

true if the Component is using state, false otherwise.

implementsAccessibility

protected boolean implementsAccessibility()

Whether this component will populate any accessibility nodes or events that are passed to it.

Returns:

true if the component implements accessibility info

implementsExtraAccessibilityNodes

protected boolean implementsExtraAccessibilityNodes()

Whether this component will expose any virtual views to the accessibility framework

Returns:

true if the component exposes extra accessibility nodes

isMountSizeDependent

protected boolean isMountSizeDependent()

Returns:

true if Mount uses @FromMeasure or @FromOnBoundsDefined parameters.

needsPreviousRenderData

protected boolean needsPreviousRenderData()

onAttached

protected void onAttached(ComponentContext c)

Called when the component is attached to the ComponentTree.

Parameters:

c - The ComponentContext the Component was constructed with.

onBind

protected void onBind(ComponentContext c,
                      java.lang.Object mountedContent,
                      InterStagePropsContainer interStagePropsContainer)

onBoundsDefined

protected void onBoundsDefined(ComponentContext c,
                               ComponentLayout layout,
                               InterStagePropsContainer interStagePropsContainer)

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.

Parameters:

c - The Context used by this component.

layout - The ComponentLayout with defined position and size.

onDetached

protected void onDetached(ComponentContext c)

Called when the component is detached from the ComponentTree.

Parameters:

c - The ComponentContext the Component was constructed with.

onError

protected void onError(ComponentContext c,
                       java.lang.Exception e)

Called to provide a fallback if a supported lifecycle method throws an exception. It is possible to either recover from the error here or reraise the exception to catch it at a higher level or crash the application.

Parameters:

c - The ComponentContext the Component was constructed with.

e - The exception caught.

See Also:

OnError

onMeasure

protected void onMeasure(ComponentContext c,
                         ComponentLayout layout,
                         int widthSpec,
                         int heightSpec,
                         Size size,
                         InterStagePropsContainer interStagePropsContainer)

onMeasureBaseline

protected int onMeasureBaseline(ComponentContext c,
                                int width,
                                int height,
                                InterStagePropsContainer interStagePropsContainer)

Called during layout calculation to determine the baseline of a component.

Parameters:

c - The Context used by this component.

width - The width of this component.

height - The height of this component.

interStagePropsContainer -

onMount

protected void onMount(ComponentContext c,
                       java.lang.Object convertContent,
                       InterStagePropsContainer interStagePropsContainer)

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.

Parameters:

c - The ComponentContext to mount the component into.

onUnbind

protected void onUnbind(ComponentContext c,
                        java.lang.Object mountedContent,
                        InterStagePropsContainer interStagePropsContainer)

onUnmount

protected void onUnmount(ComponentContext c,
                         java.lang.Object mountedContent,
                         InterStagePropsContainer interStagePropsContainer)

Unload UI elements associated with this component.

Parameters:

c - The Context for this mount operation.

mountedContent - The Drawable or View mounted by this component.

interStagePropsContainer -

populateTreeProps

protected void populateTreeProps(TreeProps parentTreeProps)

Retrieves all of the tree props used by this Component from the TreeProps map and sets the tree props as fields on the ComponentImpl.

recordRenderData

protected Component.RenderData recordRenderData(ComponentContext c,
                                                Component.RenderData toRecycle)

shouldAlwaysRemeasure

protected boolean shouldAlwaysRemeasure()

Returns:

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

createContent

public java.lang.Object createContent(Context context)

Description copied from interface: ContentAllocator

Allocates the mountable content (View or Drawable).

Specified by:

createContent in interface ContentAllocator

createPoolableContent

public java.lang.Object createPoolableContent(Context context)

Description copied from interface: ContentAllocator

Creates a mount-content that can be pooled. This is typically a View or Drawable subclass.

Specified by:

createPoolableContent in interface ContentAllocator

getPoolableContentType

public java.lang.Object getPoolableContentType()

Description copied from interface: ContentAllocator

Returns an object defining the type of the mount-content. Typically the mount-content's Class.

Specified by:

getPoolableContentType in interface ContentAllocator

isRecyclingDisabled

public boolean isRecyclingDisabled()

Description copied from interface: ContentAllocator

Return true if pooling should be disabled for this mount content.

Specified by:

isRecyclingDisabled in interface ContentAllocator

createRecyclingPool

public MountItemsPool.ItemPool createRecyclingPool()

Description copied from interface: ContentAllocator

Creates an ItemPool for this mountable content. Returning null will generate a default pool.

Specified by:

createRecyclingPool in interface ContentAllocator

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

Returns:

true if this component can be preallocated.

onCreateMountContentPool

public MountContentPool onCreateMountContentPool()

Description copied from interface: ContentAllocator

Creates the content pool the framework should use for this Mountable.

Experimental. Currently for Litho team internal use only.

Specified by:

onCreateMountContentPool in interface ContentAllocator

Returns:

the MountContentPool that should be used to recycle mount content for this mount spec.

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