litho-core/com.facebook.litho/Component

Component

abstract class Component : Cloneable, Equivalence<T> , AttributesAcceptor

Represents a unique instance of a component. To create new Component instances, use the create() method in the generated subclass which returns a builder that allows you to set values for individual props. Component instances are immutable after creation.

Inheritors

SpecGeneratedComponent

PrimitiveComponent

Types

abstract class Builder<T : Component.Builder<T>?>

ContainerBuilder

abstract class ContainerBuilder<T : Component.ContainerBuilder<T>?> : Component.Builder<T>

interface RenderData

A per-Component-class data structure to keep track of some of the last mounted @Prop/@State params a component was rendered with.

Functions

createMountContent

fun createMountContent(c: Context): Any

dispatchErrorEvent

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

For internal use, only.

fun equals(@Nullable obj: Any): Boolean

getBuilderContextName

fun getBuilderContextName(): String

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

getDebugAttribute

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

getDebugAttributes

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

fun getHandle(): Handle

open fun getMountType(): Component.MountType

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

open fun getSimpleName(): String

getTreePropFromParent

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

fun getTypeId(): Int

hasCustomDynamicProps

fun Component.hasCustomDynamicProps(): Boolean

fun hashCode(): Int

open 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.

isLayoutSpecWithSizeSpec

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

@VisibleForTesting

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

makeShallowCopy

open fun makeShallowCopy(): Component

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!

setBuilderContextName

fun setBuilderContextName(@Nullable name: String)

setDebugAttributeKey

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

fun toString(): String

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