litho-core/com.facebook.litho/ViewCompatComponent

ViewCompatComponent

class ~~ViewCompatComponent~~<V : View> : SpecGeneratedComponent

Deprecated

ViewCompatComponent is not efficient as it will do measurement of views twice. Recommended way now is to use either ViewRenderInfo (which utilizes same interfaces as this class: ViewCreator and ViewBinder) if the view is used with sections API or create a custom MountSpec.

A component that can wrap a view using a ViewBinder class to bind the view and a ViewCreator to create the mount contents. This component will have a different recycle pool per ViewCreator instance.

Types

Builder

class Builder<V : View>(context: ComponentContext, viewCompatComponent: ViewCompatComponent<V>) : Component.Builder<ViewCompatComponent.Builder<V>?>

Companion

object Companion

Properties

onContentDiscarded

open val onContentDiscarded: (Any?) -> Any??

poolingPolicy

open val poolingPolicy: PoolingPolicy

renderType

open override val renderType: RenderUnit.RenderType

Functions

acceptTriggerEvent

@Nullable

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

acquireContent

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

canPreallocate

open override fun canPreallocate(): Boolean

create

fun create(componentContext: ComponentContext): ViewCompatComponent.Builder<V>

createContent

open override fun createContent(context: Context): Any

createMountContent

fun createMountContent(c: Context): Any

dispatchOnEvent

@Nullable

override fun dispatchOnEvent(eventHandler: EventHandler<Any>, eventState: Any): Any?

equals

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

getBuilderContextName

@Nullable

fun getBuilderContextName(): String?

getCommonProps

@Nullable

fun getCommonProps(): CommonProps?

getDebugAttribute

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

getDebugAttributes

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

getEventDispatcher

override fun ~~getEventDispatcher~~(): EventDispatcher

getHandle

@Nullable

fun getHandle(): Handle?

getMountType

open override fun getMountType(): Component.MountType

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

getPoolKey

open override fun getPoolKey(): Any

getSimpleName

override fun getSimpleName(): String

getTypeId

fun getTypeId(): Int

hasClickHandlerSet

fun hasClickHandlerSet(): Boolean

hasCustomDynamicProps

fun Component.hasCustomDynamicProps(): Boolean

hashCode

override fun hashCode(): Int

isEquivalentTo

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

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

fun isEquivalentTo(@Nullable other: Component?, shouldCompareCommonProps: Boolean): 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! 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.

onCreateMountContent