litho-core/com.facebook.litho/PrimitiveComponent

PrimitiveComponent

abstract class PrimitiveComponent : Component

Base class for Kotlin primitive components. This class encapsulates some of the Mount Spec APIs. All Kotlin primitive components must extend this class.

Constructors

PrimitiveComponent

constructor()

Functions

createMountContent

fun createMountContent(c: Context): Any

equals

operator override fun equals(@Nullable other: Any?): Boolean

getBuilderContextName

@Nullable

fun getBuilderContextName(): String?

getDebugAttribute

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

getDebugAttributes

open fun getDebugAttributes(): MutableMap<AttributeKey<*>, Any>

getHandle

@Nullable

fun getHandle(): Handle?

getMountType

override fun getMountType(): Component.MountType

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

getSimpleName

override fun getSimpleName(): String

getTypeId

fun getTypeId(): Int

hashCode

override fun hashCode(): Int

isEquivalentProps

override fun isEquivalentProps(other: Component?, shouldCompareCommonProps: Boolean): Boolean

Compare this component to a different one to check if they are equivalent. This is used to be able to skip rendering a component again.

isEquivalentTo

override fun isEquivalentTo(@Nullable other: Component?): Boolean

Compares this component to a different one to check if they are the same

override fun isEquivalentTo(other: Component?, shouldCompareCommonProps: Boolean): Boolean

makeShallowCopy

override 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! Components should be manually measured only as part of a LayoutState calculation. This will measure a component and set the size in the outputSize object but the measurement result will not be cached and reused for future measurements of this component.

render

abstract fun PrimitiveComponentScope.render(): LithoPrimitive

This function must return LithoPrimitive which are immutable.

setBuilderContextName

fun setBuilderContextName(@Nullable name: String?)

setDebugAttributeKey

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

toString

override fun toString(): String