litho-core/com.facebook.litho/SpecGeneratedComponent

SpecGeneratedComponent

abstract class SpecGeneratedComponent : Component, ContentAllocator<Content> , HasEventDispatcher, EventDispatcher, EventTriggerTarget, HasEventTrigger

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

Inheritors

Types

TransitionContainer

interface TransitionContainer

Generated component's state container could implement this interface along with when componentspec specifies state update method with annotation.

Properties

Companion

val Companion: ContentAllocator.Companion

DEFAULT_MAX_PREALLOCATION

val DEFAULT_MAX_PREALLOCATION: Int = 3

UNSET_POOL_SIZE

val UNSET_POOL_SIZE: Int = -1

Functions

acceptTriggerEvent

@Nullable

fun acceptTriggerEvent(eventTrigger: EventTrigger, eventState: Any, params: Array<Any>): Any

acquireContent

open fun acquireContent(context: Context, poolScope: PoolScope): Any

canPreallocate

open fun canPreallocate(): Boolean

createContent

open fun createContent(context: Context): Any

createMountContent

fun createMountContent(c: Context): Any

dispatchErrorEvent

open fun dispatchErrorEvent(c: ComponentContext, e: ErrorEvent)

For internal use, only.

dispatchOnEvent

@Nullable

fun dispatchOnEvent(eventHandler: EventHandler, eventState: Any): Any

equals

fun equals(@Nullable obj: Any): Boolean

getBuilderContextName

@Nullable

fun getBuilderContextName(): String

open fun getBuilderContextName(@Nullable context: Context): String

getCommonProps

@Nullable

fun getCommonProps(): CommonProps

getDebugAttribute

open fun <T> getDebugAttribute(attributeKey: AttributeKey<T>): T

getDebugAttributes

open fun getDebugAttributes(): Map<AttributeKey<out Any>, Any>

getEventDispatcher

fun ~~getEventDispatcher~~(): EventDispatcher

getHandle

@Nullable

fun getHandle(): Handle

getMountType

open fun getMountType(): Component.MountType

This indicates the type of the Object that will be returned by mount.

getOnContentDiscarded

open fun getOnContentDiscarded(): (Any) -> Unit

getPoolingPolicy

open fun getPoolingPolicy(): PoolingPolicy

getPoolKey

open fun getPoolKey(): Any

getRenderType

open fun getRenderType(): RenderUnit.RenderType

getSimpleName

fun getSimpleName(): String

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

getTreePropFromParent

@Nullable

open fun <T> getTreePropFromParent(parentTreePropContainer: TreePropContainer, key: Class<T>): T

getTypeId

fun getTypeId(): Int

hasClickHandlerSet

fun hasClickHandlerSet(): Boolean

hasCustomDynamicProps

fun Component.hasCustomDynamicProps(): Boolean

hashCode

fun hashCode(): Int

isEquivalentTo

fun isEquivalentTo(@Nullable other: Component): Boolean

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.

fun isEquivalentTo(@Nullable other: Component, shouldCompareCommonProps: Boolean): Boolean

abstract fun isEquivalentTo(p: T): Boolean

isLayoutSpecWithSizeSpec

open fun isLayoutSpecWithSizeSpec(@Nullable component: Component): Boolean

isPureRender

@VisibleForTesting

open fun isPureRender(@Nullable component: Component): Boolean

makeShallowCopy

open fun makeShallowCopy(): Component

measure

fun measure(c: ComponentContext, widthSpec: Int, heightSpec: Int, outputSize: Size)

Measure a component with the given SizeSpec constrain.

fun measure(c: ComponentContext, widthSpec: Int, heightSpec: Int, outputSize: Size, shouldCacheResult: Boolean)

measureMightNotCacheInternalNode

fun ~~measureMightNotCacheInternalNode~~(c: ComponentContext, widthSpec: Int, heightSpec: Int, outputSize: Size)

Should not be used!

onCreateMountContentPool

open fun onCreateMountContentPool(poolSizeOverride: Int): MountContentPools.ContentPool

poolSize

open fun poolSize(): Int

recordEventTrigger

open fun recordEventTrigger(c: ComponentContext, container: EventTriggersContainer)

recycleContent

open fun recycleContent(context: Context, content: Any, poolScope: PoolScope)

setBuilderContextName

fun setBuilderContextName(@Nullable name: String)

setDebugAttributeKey

abstract fun <T> setDebugAttributeKey(attributeKey: AttributeKey<T>, value: T)

open fun <T> setDebugAttributeKey(attributeKey: AttributeKey<T>, value: T)

toString

fun toString(): String

willRender

open fun ~~willRender~~(c: ComponentContext, component: Component): Boolean