com.facebook.litho

Class ComponentContext

java.lang.Object

com.facebook.litho.ComponentContext

Direct Known Subclasses:

SectionContext

public class ComponentContext
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static InternalNode	NULL_LAYOUT

Constructor Summary

Constructors

Constructor and Description
ComponentContext(ComponentContext context, StateHandler stateHandler, HooksHandler hooksHandler, TreeProps treeProps, com.facebook.litho.LayoutState.LayoutStateContext layoutStateContext)
ComponentContext(ComponentContext context, StateHandler stateHandler, TreeProps treeProps, com.facebook.litho.LayoutState.LayoutStateContext layoutStateContext)
ComponentContext(Context context)
ComponentContext(Context context, com.facebook.litho.LayoutState.LayoutStateContext layoutStateContext)
ComponentContext(Context context, StateHandler stateHandler)
ComponentContext(Context context, String logTag, ComponentsLogger logger) Constructor that can be used to receive log data from components.
ComponentContext(Context context, String logTag, ComponentsLogger logger, StateHandler stateHandler, HooksHandler hooksHandler, TreeProps treeProps)
ComponentContext(Context context, String logTag, ComponentsLogger logger, StateHandler stateHandler, TreeProps treeProps)
ComponentContext(Context context, String logTag, ComponentsLogger logger, TreeProps treeProps)

Method Summary

Modifier and Type	Method and Description
void	applyLazyStateUpdatesForContainer(StateContainer container)
Context	getAndroidContext()
Context	getApplicationContext()
Object	getCachedValue(Object cachedValueInputs)
int	getColor(int id)
Component	getComponentScope()
com.facebook.litho.ComponentTree.LayoutStateFuture	getLayoutStateFuture()
int	getLayoutVersion()
ComponentsLogger	getLogger()
String	getLogTag()
Looper	getMainLooper()
int	getRecyclingMode()
ResourceCache	getResourceCache()
ResourceResolver	getResourceResolver()
Resources	getResources()
String	getString(int resId)
String	getString(int resId, Object... formatArgs)
CharSequence	getText(int resId)
<T> T	getTreeProp(Class<T> key)
protected TreeProps	getTreeProps()
TreeProps	getTreePropsCopy() Obtain a copy of the tree props currently held by this context.
static boolean	isIncrementalMountEnabled(ComponentContext c) 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.
protected boolean	isParentTreePropsCloned()
boolean	isReconciliationEnabled()
static boolean	isVisibilityProcessingEnabled(ComponentContext c)
<E> EventHandler<E>	newEventHandler(int id, Object[] params)
TypedArray	obtainStyledAttributes(int[] attrs, int defStyleAttr)
void	putCachedValue(Object cachedValueInputs, Object cachedValue)
void	setLayoutStateContextForTesting()
protected void	setParentTreePropsCloned(boolean isParentTreePropsCloned)
protected void	setTreeProps(TreeProps treeProps)
<T> void	updateHookStateAsync(HookUpdater<T> updateBlock) EXPERIMENTAL - called to enqueue a HookUpdater that will update State that was created via useState.
void	updateStateAsync(StateContainer.StateUpdate stateUpdate, String attribution) Notify the Component Tree that it needs to asynchronously perform a state update.
void	updateStateLazy(StateContainer.StateUpdate stateUpdate)
void	updateStateSync(StateContainer.StateUpdate stateUpdate, String attribution) Notify the Component Tree that it needs to synchronously perform a state update.
void	updateStateWithTransition(StateContainer.StateUpdate stateUpdate, String attribution)
static ComponentContext	withComponentScope(ComponentContext context, Component scope) Creates a new ComponentContext instance scoped to the given component and sets it on the component.
static ComponentContext	withComponentTree(ComponentContext context, ComponentTree componentTree) Creates a new ComponentContext instance and sets the ComponentTree on the component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL_LAYOUT

public static final InternalNode NULL_LAYOUT

Constructor Detail

ComponentContext

public ComponentContext(Context context)

ComponentContext

public ComponentContext(Context context,
                        com.facebook.litho.LayoutState.LayoutStateContext layoutStateContext)

ComponentContext

public ComponentContext(Context context,
                        StateHandler stateHandler)

ComponentContext

public ComponentContext(Context context,
                        String logTag,
                        ComponentsLogger logger)

Constructor that can be used to receive log data from components. Check ComponentsLogger for the type of events you can listen for.

Parameters:

context - Android context.

logTag - a log tag to be used with the logger.

logger - a lifecycle logger to be used.

ComponentContext

public ComponentContext(Context context,
                        String logTag,
                        ComponentsLogger logger,
                        TreeProps treeProps)

ComponentContext

public ComponentContext(Context context,
                        String logTag,
                        ComponentsLogger logger,
                        StateHandler stateHandler,
                        TreeProps treeProps)

ComponentContext

public ComponentContext(Context context,
                        String logTag,
                        ComponentsLogger logger,
                        StateHandler stateHandler,
                        HooksHandler hooksHandler,
                        TreeProps treeProps)

ComponentContext

public ComponentContext(ComponentContext context,
                        StateHandler stateHandler,
                        TreeProps treeProps,
                        com.facebook.litho.LayoutState.LayoutStateContext layoutStateContext)

ComponentContext

public ComponentContext(ComponentContext context,
                        StateHandler stateHandler,
                        HooksHandler hooksHandler,
                        TreeProps treeProps,
                        com.facebook.litho.LayoutState.LayoutStateContext layoutStateContext)

Method Detail

setLayoutStateContextForTesting

public void setLayoutStateContextForTesting()

getAndroidContext

public final Context getAndroidContext()

getApplicationContext

public final Context getApplicationContext()

getResources

public Resources getResources()

getResourceResolver

public ResourceResolver getResourceResolver()

getMainLooper

public final Looper getMainLooper()

getText

public CharSequence getText(int resId)

getString

public String getString(int resId)

getString

public String getString(int resId,
                        Object... formatArgs)

getColor

public int getColor(int id)

getComponentScope

public Component getComponentScope()

getLayoutStateFuture

public com.facebook.litho.ComponentTree.LayoutStateFuture getLayoutStateFuture()

updateStateSync

public void updateStateSync(StateContainer.StateUpdate stateUpdate,
                            String attribution)

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

Parameters:

stateUpdate - state update to perform

updateStateAsync

public void updateStateAsync(StateContainer.StateUpdate stateUpdate,
                             String attribution)

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

Parameters:

stateUpdate - state update to perform

updateStateWithTransition

public void updateStateWithTransition(StateContainer.StateUpdate stateUpdate,
                                      String attribution)

updateStateLazy

public void updateStateLazy(StateContainer.StateUpdate stateUpdate)

updateHookStateAsync

public <T> void updateHookStateAsync(HookUpdater<T> updateBlock)

EXPERIMENTAL - called to enqueue a HookUpdater that will update State that was created via useState.

applyLazyStateUpdatesForContainer

public void applyLazyStateUpdatesForContainer(StateContainer container)

obtainStyledAttributes

public TypedArray obtainStyledAttributes(int[] attrs,
                                         int defStyleAttr)

getLogTag

public String getLogTag()

getLogger

public ComponentsLogger getLogger()

setTreeProps

protected void setTreeProps(TreeProps treeProps)

getTreeProps

protected TreeProps getTreeProps()

isParentTreePropsCloned

protected boolean isParentTreePropsCloned()

Returns:

true if parent's TreeProps are cloned and assigned to mTreeProps. Notice this method should be accessed by Kotlin API only.

setParentTreePropsCloned

protected void setParentTreePropsCloned(boolean isParentTreePropsCloned)

getTreeProp

public <T> T getTreeProp(Class<T> key)

getTreePropsCopy

public TreeProps getTreePropsCopy()

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

getLayoutVersion

public int getLayoutVersion()

getResourceCache

public ResourceCache getResourceCache()

newEventHandler

public <E> EventHandler<E> newEventHandler(int id,
                                           Object[] params)

getCachedValue

public Object getCachedValue(Object cachedValueInputs)

putCachedValue

public void putCachedValue(Object cachedValueInputs,
                           Object cachedValue)

withComponentTree

public static ComponentContext withComponentTree(ComponentContext context,
                                                 ComponentTree componentTree)

Creates a new ComponentContext instance and sets the ComponentTree on the component.

Parameters:

context - context scoped to the parent component

componentTree - component tree associated with the newly created context

Returns:

a new ComponentContext instance

withComponentScope

public static ComponentContext withComponentScope(ComponentContext context,
                                                  Component scope)

Creates a new ComponentContext instance scoped to the given component and sets it on the component.

Parameters:

context - context scoped to the parent component

scope - component associated with the newly created scoped context

Returns:

a new ComponentContext instance scoped to the given component

isIncrementalMountEnabled

public static boolean isIncrementalMountEnabled(ComponentContext c)

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. you use visibility callbacks). This is static to avoid polluting the ComponentContext API.

isVisibilityProcessingEnabled

public static boolean isVisibilityProcessingEnabled(ComponentContext c)

isReconciliationEnabled

public boolean isReconciliationEnabled()

getRecyclingMode

public int getRecyclingMode()