litho-core/com.facebook.litho/ComponentContext

ComponentContext

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

componentsConfig

val ComponentContext.componentsConfig: ComponentsConfiguration

mLithoConfiguration

open var mLithoConfiguration: LithoConfiguration

Functions

applyLazyStateUpdatesForContainer

open fun applyLazyStateUpdatesForContainer(container: StateContainer): StateContainer

inline fun ComponentContext.boolAttr(@AttrRes attrResId: Int, @BoolRes defResId: Int = 0): Boolean

Return a boolean for an attribute resource ID.

inline fun ComponentContext.boolRes(@BoolRes id: Int): Boolean

Return a boolean for a resource ID.

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()

inline fun ComponentContext.colorAttr(@AttrRes id: Int, @ColorRes defResId: Int = 0): Int

Return a ColorInt value, corresponding to an attribute resource ID. If given attribute ID can not be found, default color resource ID defResId is used.

inline fun ComponentContext.colorRes(@ColorRes id: Int): Int

Return a ColorInt value for a color resource ID.

createScopedComponentContextWithStateForTest

@VisibleForTesting

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

inline fun ComponentContext.dimenAttr(@AttrRes id: Int, @DimenRes defResId: Int = 0): Dimen

Return a dimen for an attribute resource ID.

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

Resolve a dimen resource ID as a Dimen value.

inline fun ComponentContext.drawableAttr(@AttrRes id: Int, @DrawableRes defResId: Int = 0): Drawable

Retrieve a android.graphics.drawable.Drawable, corresponding to an attribute resource ID, as a Drawable instance. If given attribute ID can not be found, default Drawable resource ID defResId is used.

inline fun ComponentContext.drawableRes(@DrawableRes id: Int): Drawable

Retrieve a android.graphics.drawable.Drawable for a resource ID as a Drawable instance.

findViewWithTag

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.

findViewWithTagValue

open fun findViewWithTagValue(key: Int, tag: Any): View

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

inline fun ComponentContext.floatAttr(@AttrRes id: Int, @DimenRes defResId: Int = 0): Float

inline fun ComponentContext.floatRes(@DimenRes id: Int): Float

getAndroidContext

fun getAndroidContext(): Context

getApplicationContext

fun getApplicationContext(): Context

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

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

getComponentScope

open fun getComponentScope(): Component

getErrorComponentReceiver

open fun getErrorComponentReceiver(): ErrorComponentReceiver

getErrorEventHandler

open fun getErrorEventHandler(): EventHandler<ErrorEvent>

open fun getGlobalKey(): String

getLayoutStateContext

open fun getLayoutStateContext(): LithoLayoutContext

getLayoutStateFuture

@VisibleForTesting

open fun getLayoutStateFuture(): TreeFuture

getLayoutVersion

open fun getLayoutVersion(): Int

getLithoConfiguration

open fun getLithoConfiguration(): LithoConfiguration

getLithoVisibilityEventsController

open fun getLithoVisibilityEventsController(): LithoVisibilityEventsController

open fun getLogger(): ComponentsLogger

open fun getLogTag(): String

getParentTreeProp

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

getParentTreePropContainer

open fun getParentTreePropContainer(): TreePropContainer

getRenderStateContext

open fun getRenderStateContext(): ResolveContext

getResourceCache

open fun getResourceCache(): ResourceCache

getResourceResolver

open fun getResourceResolver(): ResourceResolver

open fun getResources(): Resources

getScopedComponentInfo

open fun getScopedComponentInfo(): ScopedComponentInfo

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

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

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

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

getTreePropContainer

open fun getTreePropContainer(): TreePropContainer

getTreePropContainerCopy

open fun getTreePropContainerCopy(): TreePropContainer

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

inline fun ComponentContext.intAttr(@AttrRes id: Int, @IntegerRes defResId: Int = 0): Int

inline fun ComponentContext.intRes(@IntegerRes id: Int): Int

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.

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.

obtainStyledAttributes

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

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

quantityStringRes

inline fun ComponentContext.quantityStringRes(@PluralsRes id: Int, quantity: Int): String

inline fun ComponentContext.quantityStringRes(@PluralsRes id: Int, quantity: Int, arg: Any): String

inline fun ComponentContext.quantityStringRes(@PluralsRes id: Int, quantity: Int, vararg formatArgs: Any): String

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)

shouldUseNonRebindingEventHandlers

fun shouldUseNonRebindingEventHandlers(): Boolean

inline fun ComponentContext.stringAttr(@AttrRes attrResId: Int, @StringRes defResId: Int = 0): String

Return a string for an attribute resource ID.

inline fun ComponentContext.stringRes(@StringRes id: Int): String

Return a string for a resource ID.

inline fun ComponentContext.stringRes(@StringRes id: Int, arg: Any): String

Return a string for a resource ID, substituting the format arguments with arg.

inline fun ComponentContext.stringRes(@StringRes id: Int, vararg formatArgs: Any): String

Return a string for a resource ID, substituting the format arguments with formatArgs.

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)