litho-core/com.facebook.litho/ComponentContext

ComponentContext

A Context subclass for use within the Components framework. Contains extra bookkeeping information used internally in the library.

Constructors

ComponentContext

constructor(context: Context)

This constructors takes a Context.

constructor(context: Context, @Nullable lithoConfiguration: LithoConfiguration, @Nullable treePropContainer: TreePropContainer)

constructor(context: ComponentContext)

Properties

mLithoConfiguration

open var mLithoConfiguration: LithoConfiguration

Functions

applyLazyStateUpdatesForContainer

open fun applyLazyStateUpdatesForContainer(container: StateContainer): StateContainer

calculateLayoutOutputId

open fun calculateLayoutOutputId(componentKey: String, type: Int): Long

Calculates a returns a unique ID for a given component key and output type.

clearCalculationStateContext

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)

open fun clearCalculationStateContext()

createScopedComponentContextWithStateForTest

@VisibleForTesting

open fun ~~createScopedComponentContextWithStateForTest~~(parent: ComponentContext, component: Component, key: String): ComponentContext

dimenRes

inline fun ComponentContext.dimenRes(@DimenRes id: Int): Dimen

Resolve a dimen resource ID as a Dimen value.

findViewWithTag

@Nullable

open fun <T : View?> findViewWithTag(tag: Any): T

A utility function to find the View with a given tag under the current Component's LithoView.

getAndroidContext

fun getAndroidContext(): Context

getApplicationContext

fun getApplicationContext(): Context

getCachedValue

@Nullable

open fun getCachedValue(globalKey: String, index: Int, cachedValueInputs: Any): Any

getColor

open fun getColor(@ColorRes id: Int): Int

getComponentScope

@Nullable

open fun getComponentScope(): Component

getErrorComponentReceiver

@Nullable

open fun getErrorComponentReceiver(): ErrorComponentReceiver

getErrorEventHandler

open fun getErrorEventHandler(): EventHandler<ErrorEvent>

getGlobalKey

open fun getGlobalKey(): String

getLayoutStateContext

@Nullable

open fun getLayoutStateContext(): LithoLayoutContext

getLayoutStateFuture

@Nullable

@VisibleForTesting

open fun getLayoutStateFuture(): TreeFuture

getLayoutVersion

open fun getLayoutVersion(): Int

getLifecycleProvider

@Nullable

open fun getLifecycleProvider(): LithoVisibilityEventsController

getLithoConfiguration

open fun getLithoConfiguration(): LithoConfiguration

getLogger

@Nullable

open fun getLogger(): ComponentsLogger

getLogTag

@Nullable

open fun getLogTag(): String

getParentTreeProp

@Nullable

open fun <T> getParentTreeProp(key: Class<T>): T

getParentTreePropContainer

@Nullable

open fun getParentTreePropContainer(): TreePropContainer

getRenderStateContext

@Nullable

open fun getRenderStateContext(): ResolveContext

getResourceCache

@Nullable

open fun getResourceCache(): ResourceCache

getResourceResolver

open fun getResourceResolver(): ResourceResolver

getResources

open fun getResources(): Resources

getScopedComponentInfo

open fun getScopedComponentInfo(): ScopedComponentInfo

getString

open fun getString(@StringRes resId: Int): String

open fun getString(@StringRes resId: Int, formatArgs: Array<Any>): String

getText

open fun getText(@StringRes resId: Int): CharSequence

getTreeProp

@Nullable

open fun <T> getTreeProp(key: Class<T>): T

getTreePropContainer

@Nullable

open fun getTreePropContainer(): TreePropContainer

getTreePropContainerCopy

@Nullable

open fun getTreePropContainerCopy(): TreePropContainer

Obtain a copy of the tree props currently held by this context.

getVisibilityBoundsTransformer

@Nullable

open fun getVisibilityBoundsTransformer(): VisibilityBoundsTransformer

isIncrementalMountEnabled

open fun isIncrementalMountEnabled(c: ComponentContext): Boolean

Checks if incremental mount is enabled given a ComponentContext, so you can throw an error if you require that incremental mount is enabled (e.g.

isPrimitiveVerticalScrollEnabled

open fun isPrimitiveVerticalScrollEnabled(): Boolean

isReconciliationEnabled

open fun isReconciliationEnabled(): Boolean

isVisibilityProcessingEnabled

open fun isVisibilityProcessingEnabled(c: ComponentContext): Boolean

makeCopyForNestedTree

open fun makeCopyForNestedTree(parentTreeContext: ComponentContext): ComponentContext

Creates a new ComponentContext based on the given ComponentContext, propagating log tag, logger, and tree props.

newEventHandler

open fun <E> newEventHandler(id: Int, @Nullable params: Array<Any>): EventHandler<E>

TODO: Add rebind mode to this API.

obtainStyledAttributes

open fun obtainStyledAttributes(attrs: Array<Int>, @AttrRes defStyleAttr: Int): TypedArray

putCachedValue

open fun putCachedValue(globalKey: String, index: Int, cachedValueInputs: Any, @Nullable cachedValue: Any)

setLayoutStateContextForTesting

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)

open fun setLayoutStateContextForTesting()

setLithoLayoutContext

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)

open fun setLithoLayoutContext(lithoLayoutContext: LithoLayoutContext)

setParentTreePropContainer

open fun setParentTreePropContainer(@Nullable treePropContainer: TreePropContainer)

setRenderStateContext

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)

open fun setRenderStateContext(@Nullable renderStateContext: ResolveContext)

setRenderStateContextForTests

@VisibleForTesting

open fun setRenderStateContextForTests(): ResolveContext

For test usage.

setTreePropContainer

@VisibleForTesting(otherwise = VisibleForTesting.PROTECTED)

open fun setTreePropContainer(@Nullable treePropContainer: TreePropContainer)

shouldCacheLayouts

open fun shouldCacheLayouts(): Boolean

shouldUseNonRebindingEventHandlers

fun shouldUseNonRebindingEventHandlers(): Boolean

updateStateAsync

open fun updateStateAsync(stateUpdate: StateContainer.StateUpdate, attribution: String)

Notify the Component Tree that it needs to asynchronously perform a state update.

updateStateLazy

open fun updateStateLazy(stateUpdate: StateContainer.StateUpdate)

updateStateSync

open fun updateStateSync(stateUpdate: StateContainer.StateUpdate, attribution: String)

Notify the Component Tree that it needs to synchronously perform a state update.

updateStateWithTransition

open fun updateStateWithTransition(stateUpdate: StateContainer.StateUpdate, attribution: String)