LithoView

java.lang.Object
- ViewGroup
- - com.facebook.rendercore.Host
  - - com.facebook.litho.ComponentHost
    - - com.facebook.litho.LithoView

All Implemented Interfaces:

RenderCoreExtensionHost, RootHost, AnimatedRootHost, DisappearingHost
```
public class LithoView
extends ComponentHost
implements RootHost, AnimatedRootHost
```
A ViewGroup that can host the mounted state of a Component.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LithoView.LayoutManagerOverrideParams` LayoutParams that override the LayoutManager.
`static interface`	`LithoView.OnDirtyMountListener`
`static interface`	`LithoView.OnPostDrawListener`

Field Summary

Fields
Modifier and Type Field and Description

int mViewAttributeFlags

static java.lang.String SET_ALREADY_ATTACHED_COMPONENT_TREE

static java.lang.String ZERO_HEIGHT_LOG
- Fields inherited from class com.facebook.litho.ComponentHost
  PARTIAL_ALPHA_TEXTURE_TOO_BIG, TEXTURE_TOO_BIG, TEXTURE_ZERO_DIM

Fields
Modifier and Type	Field and Description
`int`	`mViewAttributeFlags`
`static java.lang.String`	`SET_ALREADY_ATTACHED_COMPONENT_TREE`
`static java.lang.String`	`ZERO_HEIGHT_LOG`

Constructor Summary

Constructors
Constructor and Description
`LithoView(ComponentContext context, AttributeSet attrs)`
`LithoView(Context context)`
`LithoView(Context context, AttributeSet attrs)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`componentTreeHasLifecycleProvider()`
`static LithoView`	`create(Context context, Component component)` Create a new `LithoView` instance and initialize it with the given `Component` root.
`static LithoView`	`create(Context context, Component component, LithoLifecycleProvider lifecycleProvider)`
`static LithoView`	`create(Context context, ComponentTree componentTree)` Create a new `LithoView` instance and initialize it with a custom `ComponentTree`.
`void`	`dispatchVisibilityEvent(java.lang.Class<?> visibilityEventType)` Deprecated.
`void`	`draw(Canvas canvas)`
`protected void`	`forceRelayout()`
`java.util.List<LithoView>`	`getChildLithoViewsFromCurrentlyMountedItems()`
`ComponentContext`	`getComponentContext()`
`ComponentTree`	`getComponentTree()`
`DynamicPropsManager`	`getDynamicPropsManager()`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getLayoutErrorMetadata(int width, int height)`
`MountDelegateTarget`	`getMountDelegateTarget()`
`Rect`	`getPreviousMountBounds()`
`boolean`	`isIncrementalMountEnabled()`
`void`	`notifyLithoViewGlobalPositionChanged()` Call this method when the LithoView's global position on screen has changed via manual offset.
`void`	`notifyVisibleBoundsChanged()` Notifies the host the its visible bounds may have potentially changed.
`void`	`notifyVisibleBoundsChanged(Rect visibleRect, boolean processVisibilityOutputs)` This allows inner RootHosts to trigger a mount on a custom visibleRect.
`void`	`offsetLeftAndRight(int offset)`
`void`	`offsetTopAndBottom(int offset)`
`protected void`	`onAttachedToWindow()`
`void`	`onAttachedToWindowForTest()` Along with `onDetachedFromWindowForTest()` below, makes the LithoView think it's attached/ detached in a unit test environment.
`protected void`	`onDetachedFromWindow()`
`void`	`onDetachedFromWindowForTest()`
`void`	`onFinishTemporaryDetach()`
`protected void`	`onMeasure(int widthMeasureSpec, int heightMeasureSpec)`
`void`	`onStartTemporaryDetach()`
`protected void`	`performLayout(boolean changed, int left, int top, int right, int bottom)`
`void`	`rebind()`
`void`	`registerUIDebugger(MountExtension extension)`
`void`	`release()` Deprecated.
`void`	`rerenderForAccessibility(boolean enabled)`
`void`	`resetMountStartupLoggingInfo()`
`void`	`setAnimatedHeight(int height)` Sets the height that the LithoView should take on the next measure pass and then requests a layout.
`void`	`setAnimatedWidth(int width)` Sets the width that the LithoView should take on the next measure pass and then requests a layout.
`void`	`setComponent(Component component)` Change the root component synchronously.
`void`	`setComponentAsync(Component component)` Change the root component measuring it on a background thread before updating the UI.
`void`	`setComponentAsyncWithoutReconciliation(Component component)` Deprecated. Use `setComponentAsync(Component)` if reconciliation can be enabled.
`void`	`setComponentTree(ComponentTree componentTree)`
`void`	`setComponentTree(ComponentTree componentTree, boolean unmountAllWhenComponentTreeSetToNull)`
`void`	`setComponentWithoutReconciliation(Component component)` Deprecated. Use `setComponent(Component)` if reconciliation can be enabled.
`void`	`setHasTransientState(boolean hasTransientState)`
`void`	`setInvalidStateLogParamsList(java.util.List<ComponentLogParams> logParamsList)` Register for particular invalid state logs.
`void`	`setMountStartupLoggingInfo(LithoStartupLogger startupLogger, java.lang.String startupLoggerAttribution, boolean[] firstMountCalled, boolean[] lastMountCalled, boolean isLastAdapterItem, boolean isOrientationVertical)`
`void`	`setOnDirtyMountListener(LithoView.OnDirtyMountListener onDirtyMountListener)`
`void`	`setOnPostDrawListener(LithoView.OnPostDrawListener onPostDrawListener)`
`void`	`setRenderState(RenderState renderState)`
`void`	`setSkipMountingIfNotVisible(boolean skipMountingIfNotVisible)` If true, calling `setVisibilityHint(boolean, boolean)` will delegate to `setVisibilityHint(boolean)` and skip mounting if the visibility hint was set to false.
`void`	`setTranslationX(float translationX)`
`void`	`setTranslationY(float translationY)`
`void`	`setVisibilityHint(boolean isVisible)` Deprecated.
`void`	`setVisibilityHint(boolean isVisible, boolean skipMountingIfNotVisible)` Deprecated.
`protected boolean`	`shouldAlwaysLayoutChildren()` Indicates if the children of this view should be laid regardless to a mount step being triggered on layout.
`protected boolean`	`shouldRequestLayout()`
`boolean`	`skipNotifyVisibleBoundsChangedCalls()`
`void`	`startTemporaryDetach()`
`boolean`	`subscribeComponentTreeToLifecycleProvider(LithoLifecycleProvider lifecycleProvider)` If this LithoView has a ComponentTree attached to it, set a LithoLifecycleProvider if it doesn't already have one.
`void`	`suppressMeasureComponentTree(boolean suppress)` If set to true, the onMeasure(..) call won't measure the ComponentTree with the given measure specs, but it will just use them as measured dimensions.
`java.lang.String`	`toString()`
`void`	`unbind()` To be called this when the LithoView is about to become inactive.
`void`	`unmountAllItems()` Deprecated.
`void`	`unregisterUIDebugger()`

Methods inherited from class com.facebook.litho.ComponentHost
addView, addView, addView, addViewForTest, addViewInLayout, attachViewToParent, dispatchDraw, dispatchHoverEvent, drawableStateChanged, finaliseDisappearingItem, getChildDrawingOrder, getClipChildren, getComponentTouchListener, getContentDescription, getContentDescriptions, getContentNames, getDrawables, getImageContent, getLinkedDrawablesForAnimation, getMountItemAt, getMountItemCount, getTag, getTextContent, hasOverlappingRendering, jumpDrawablesToCurrentState, mount, mount, moveItem, onInterceptTouchEvent, onLayout, onTouchEvent, performAccessibilityAction, refreshAccessibilityDelegatesIfNeeded, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestLayout, setAccessibilityDelegate, setAlpha, setClipChildren, setContentDescription, setInLayout, setTag, setViewTags, setVisibility, shouldDelayChildPressedState, startDisappearingMountItem, unmount, unmount, unsetInLayout, verifyDrawable

Methods inherited from class com.facebook.rendercore.Host
getDescriptionOfMountedItems, safelyUnmountAll

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO_HEIGHT_LOG
```
public static final java.lang.String ZERO_HEIGHT_LOG
```
    See Also:
    
    Constant Field Values
  - SET_ALREADY_ATTACHED_COMPONENT_TREE
```
public static final java.lang.String SET_ALREADY_ATTACHED_COMPONENT_TREE
```
    See Also:
    
    Constant Field Values
  - mViewAttributeFlags
```
public final int mViewAttributeFlags
```
- Constructor Detail
  - LithoView
```
public LithoView(Context context)
```
  - LithoView
```
public LithoView(Context context,
                 AttributeSet attrs)
```
  - LithoView
```
public LithoView(ComponentContext context,
                 AttributeSet attrs)
```
- Method Detail
  - create
```
public static LithoView create(Context context,
                               Component component)
```
    Create a new LithoView instance and initialize it with the given Component root.
    
    Parameters:
    
    context - Android Context.
    
    component - The root component to draw.
    
    Returns:
    
    LithoView able to render a Component hierarchy.
  - create
```
public static LithoView create(Context context,
                               Component component,
                               LithoLifecycleProvider lifecycleProvider)
```
  - create
```
public static LithoView create(Context context,
                               ComponentTree componentTree)
```
    Create a new LithoView instance and initialize it with a custom ComponentTree.
  - forceRelayout
```
protected void forceRelayout()
```
  - startTemporaryDetach
```
public void startTemporaryDetach()
```
  - onAttachedToWindow
```
protected void onAttachedToWindow()
```
  - onDetachedFromWindow
```
protected void onDetachedFromWindow()
```
  - onAttachedToWindowForTest
```
public void onAttachedToWindowForTest()
```
    Along with onDetachedFromWindowForTest() below, makes the LithoView think it's attached/ detached in a unit test environment. This also handles setting the same state for all LithoView children.
    Implementation Note: Ideally, we'd just attach the LithoView to a View hierarchy and let AOSP handle all this for us. The reason we haven't is because attaching to an Activity while also trying to make sure the full LithoView is always considered visible (for the purposes of visibility events and incremental mount) proved difficult - if interested, see summary on the blame diff for this comment for more info.
  - onDetachedFromWindowForTest
```
public void onDetachedFromWindowForTest()
```
  - onStartTemporaryDetach
```
public void onStartTemporaryDetach()
```
  - onFinishTemporaryDetach
```
public void onFinishTemporaryDetach()
```
  - suppressMeasureComponentTree
```
public void suppressMeasureComponentTree(boolean suppress)
```
    If set to true, the onMeasure(..) call won't measure the ComponentTree with the given measure specs, but it will just use them as measured dimensions.
  - setAnimatedWidth
```
public void setAnimatedWidth(int width)
```
    Sets the width that the LithoView should take on the next measure pass and then requests a layout. This should be called from animation-driving code on each frame to animate the size of the LithoView.
    
    Specified by:
    
    setAnimatedWidth in interface AnimatedRootHost
  - setAnimatedHeight
```
public void setAnimatedHeight(int height)
```
    Sets the height that the LithoView should take on the next measure pass and then requests a layout. This should be called from animation-driving code on each frame to animate the size of the LithoView.
    
    Specified by:
    
    setAnimatedHeight in interface AnimatedRootHost
  - onMeasure
```
protected void onMeasure(int widthMeasureSpec,
                         int heightMeasureSpec)
```
  - performLayout
```
protected void performLayout(boolean changed,
                             int left,
                             int top,
                             int right,
                             int bottom)
```
  - shouldAlwaysLayoutChildren
```
protected boolean shouldAlwaysLayoutChildren()
```
    Indicates if the children of this view should be laid regardless to a mount step being triggered on layout. This step can be important when some of the children in the hierarchy are changed (e.g. resized) but the parent wasn't.
    Since the framework doesn't expect its children to resize after being mounted, this should be used only for extreme cases where the underline views are complex and need this behavior.
    
    Returns:
    
    boolean Returns true if the children of this view should be laid out even when a mount step was not needed.
  - getComponentContext
```
public ComponentContext getComponentContext()
```
    Returns:
    
    ComponentContext associated with this LithoView. It's a wrapper on the Context originally used to create this LithoView itself.
  - shouldRequestLayout
```
protected boolean shouldRequestLayout()
```
    Overrides:
    
    shouldRequestLayout in class ComponentHost
  - getComponentTree
```
public ComponentTree getComponentTree()
```
  - setOnDirtyMountListener
```
public void setOnDirtyMountListener(LithoView.OnDirtyMountListener onDirtyMountListener)
```
  - setOnPostDrawListener
```
public void setOnPostDrawListener(LithoView.OnPostDrawListener onPostDrawListener)
```
  - setComponentTree
```
public void setComponentTree(ComponentTree componentTree)
```
  - setComponentTree
```
public void setComponentTree(ComponentTree componentTree,
                             boolean unmountAllWhenComponentTreeSetToNull)
```
  - skipNotifyVisibleBoundsChangedCalls
```
public boolean skipNotifyVisibleBoundsChangedCalls()
```
  - registerUIDebugger
```
public void registerUIDebugger(MountExtension extension)
```
  - unregisterUIDebugger
```
public void unregisterUIDebugger()
```
  - setComponent
```
public void setComponent(Component component)
```
    Change the root component synchronously.
  - setComponentWithoutReconciliation
```
@Deprecated
public void setComponentWithoutReconciliation(Component component)
```
    Deprecated. Use setComponent(Component) if reconciliation can be enabled.
    
    Change the root component synchronously. Creates a new component tree with reconciliation disabled if required. DO NOT USE this method; it was added only to avoid enabling reconciliation implicitly at all existing call sites of setComponent(Component).
    Use setComponent(Component) if the component hierarchy does not rely on side effects. For more details about reconciliation see the documentation @ https://fblitho.com/docs/codegen/state-for-specs/#updating-state-values
    To disable reconciliation create a new ComponentTree, and disable reconciliation explicitly using ComponentTree.Builder.isReconciliationEnabled(boolean). Set this ComponentTree on the LithoView using setComponentTree(ComponentTree).
  - setComponentAsync
```
public void setComponentAsync(Component component)
```
    Change the root component measuring it on a background thread before updating the UI. If this LithoView doesn't have a ComponentTree initialized, the root will be computed synchronously.
  - setComponentAsyncWithoutReconciliation
```
@Deprecated
public void setComponentAsyncWithoutReconciliation(Component component)
```
    Deprecated. Use setComponentAsync(Component) if reconciliation can be enabled.
    
    Change the root component asynchronously. Creates a new component tree with reconciliation disabled if required. DO NOT USE this method; it was added only to avoid enabling reconciliation implicitly at all existing call sites of setComponentAsync(Component).
    Use setComponentAsync(Component) if the component hierarchy does not rely on side effects. For more details about reconciliation see the documentation @ https://fblitho.com/docs/codegen/state-for-specs/#updating-state-values
    To disable reconciliation create a new ComponentTree, and disable reconciliation explicitly using ComponentTree.Builder.isReconciliationEnabled(boolean). Set this ComponentTree on the LithoView using setComponentTree(ComponentTree).
  - rebind
```
public void rebind()
```
  - unbind
```
public void unbind()
```
    To be called this when the LithoView is about to become inactive. This means that either the view is about to be recycled or moved off-screen.
  - setSkipMountingIfNotVisible
```
public void setSkipMountingIfNotVisible(boolean skipMountingIfNotVisible)
```
    If true, calling setVisibilityHint(boolean, boolean) will delegate to setVisibilityHint(boolean) and skip mounting if the visibility hint was set to false. You should not need this unless you don't have control over calling setVisibilityHint on the LithoView you own.
  - componentTreeHasLifecycleProvider
```
public boolean componentTreeHasLifecycleProvider()
```
    Returns:
    
    true if this LithoView has a ComponentTree attached and a LithoLifecycleProvider is set on it, false otherwise.
  - subscribeComponentTreeToLifecycleProvider
```
public boolean subscribeComponentTreeToLifecycleProvider(LithoLifecycleProvider lifecycleProvider)
```
    If this LithoView has a ComponentTree attached to it, set a LithoLifecycleProvider if it doesn't already have one.
    
    Returns:
    
    true if the LithoView's ComponentTree was subscribed as listener to the given LithoLifecycleProvider, false otherwise.
  - setVisibilityHint
```
@Deprecated
public void setVisibilityHint(boolean isVisible)
```
    Deprecated.
    
    Deprecated: Consider subscribing the LithoView to a LithoLifecycleOwner instead.
    Call this to tell the LithoView whether it is visible or not. In general, you shouldn't require this as the system will do this for you. However, when a new activity/fragment is added on top of the one hosting this view, the LithoView remains in the backstack but receives no callback to indicate that it is no longer visible.
    While the LithoView has the visibility hint set to false, it will be treated by the framework as not in the viewport, so no new mounting events will be processed until the visibility hint is set back to true.
    
    Parameters:
    
    isVisible - if true, this will find the current visible rect and process visibility outputs using it. If false, any invisible and unfocused events will be called.
  - setVisibilityHint
```
@Deprecated
public void setVisibilityHint(boolean isVisible,
                                          boolean skipMountingIfNotVisible)
```
    Deprecated.
    
    Marked as @Deprecated. setVisibilityHint(boolean) should be used instead, which by default does not process new mount events while the visibility hint is set to false (skipMountingIfNotVisible should be set to true). This method should only be used to maintain the contract with the usages of setVisibilityHint before `skipMountingIfNotVisible` was made to default to true. All usages should be audited and migrated to setVisibilityHint(boolean).
  - setHasTransientState
```
public void setHasTransientState(boolean hasTransientState)
```
  - offsetTopAndBottom
```
public void offsetTopAndBottom(int offset)
```
  - offsetLeftAndRight
```
public void offsetLeftAndRight(int offset)
```
  - setTranslationX
```
public void setTranslationX(float translationX)
```
  - setTranslationY
```
public void setTranslationY(float translationY)
```
  - draw
```
public void draw(Canvas canvas)
```
  - notifyLithoViewGlobalPositionChanged
```
public void notifyLithoViewGlobalPositionChanged()
```
    Call this method when the LithoView's global position on screen has changed via manual offset. For example, if one of this LithoView's parent's Left / Top / Bottom / Right fields has been manually changed, or via offsetTopAndBottom.
    Calls to this method are not needed if the LithoView's global position has changed due to layout, scroll or translation.
  - notifyVisibleBoundsChanged
```
public void notifyVisibleBoundsChanged(Rect visibleRect,
                                       boolean processVisibilityOutputs)
```
    Description copied from interface: AnimatedRootHost
    
    This allows inner RootHosts to trigger a mount on a custom visibleRect. We need this to force animated inner root hosts to be mounted for animation.
    
    Specified by:
    
    notifyVisibleBoundsChanged in interface AnimatedRootHost
  - notifyVisibleBoundsChanged
```
public void notifyVisibleBoundsChanged()
```
    Description copied from interface: RenderCoreExtensionHost
    
    Notifies the host the its visible bounds may have potentially changed.
    
    Specified by:
    
    notifyVisibleBoundsChanged in interface RenderCoreExtensionHost
  - isIncrementalMountEnabled
```
public boolean isIncrementalMountEnabled()
```
  - release
```
@Deprecated
public void release()
```
    Deprecated.
    
    Deprecated: Consider subscribing the LithoView to a LithoLifecycleOwner instead.
  - dispatchVisibilityEvent
```
@Deprecated
public void dispatchVisibilityEvent(java.lang.Class<?> visibilityEventType)
```
    Deprecated.
    
    Dispatch a visibility events to all the components hosted in this LithoView.
    Marked as @Deprecated to indicate this method is experimental and should not be widely used.
    NOTE: Can only be used when Incremental Mount is disabled! Call this method when the LithoView is considered eligible for the visibility event (i.e. only dispatch VisibleEvent when the LithoView is visible in its container).
    
    Parameters:
    
    visibilityEventType - The class type of the visibility event to dispatch. Supported: VisibleEvent.class, InvisibleEvent.class, FocusedVisibleEvent.class, UnfocusedVisibleEvent.class, FullImpressionVisibleEvent.class.
  - getChildLithoViewsFromCurrentlyMountedItems
```
public java.util.List<LithoView> getChildLithoViewsFromCurrentlyMountedItems()
```
  - unmountAllItems
```
@Deprecated
public void unmountAllItems()
```
    Deprecated.
    
    Deprecated: Consider subscribing the LithoView to a LithoLifecycleOwner instead.
  - getPreviousMountBounds
```
public Rect getPreviousMountBounds()
```
  - getMountDelegateTarget
```
public MountDelegateTarget getMountDelegateTarget()
```
  - getDynamicPropsManager
```
public DynamicPropsManager getDynamicPropsManager()
```
  - setMountStartupLoggingInfo
```
public void setMountStartupLoggingInfo(LithoStartupLogger startupLogger,
                                       java.lang.String startupLoggerAttribution,
                                       boolean[] firstMountCalled,
                                       boolean[] lastMountCalled,
                                       boolean isLastAdapterItem,
                                       boolean isOrientationVertical)
```
  - resetMountStartupLoggingInfo
```
public void resetMountStartupLoggingInfo()
```
  - setInvalidStateLogParamsList
```
public void setInvalidStateLogParamsList(java.util.List<ComponentLogParams> logParamsList)
```
    Register for particular invalid state logs.
  - rerenderForAccessibility
```
public void rerenderForAccessibility(boolean enabled)
```
  - toString
```
public java.lang.String toString()
```
  - setRenderState
```
public void setRenderState(RenderState renderState)
```
    Specified by:
    
    setRenderState in interface RootHost
  - getLayoutErrorMetadata
```
protected java.util.Map<java.lang.String,java.lang.Object> getLayoutErrorMetadata(int width,
                                                                                  int height)
```
    Overrides:
    
    getLayoutErrorMetadata in class ComponentHost

Class LithoView

Nested Class Summary

Field Summary

Fields inherited from class com.facebook.litho.ComponentHost

Constructor Summary

Method Summary

Methods inherited from class com.facebook.litho.ComponentHost

Methods inherited from class com.facebook.rendercore.Host

Methods inherited from class java.lang.Object

Field Detail

ZERO_HEIGHT_LOG

SET_ALREADY_ATTACHED_COMPONENT_TREE

mViewAttributeFlags

Constructor Detail

LithoView

LithoView

LithoView

Method Detail

create

create

create

forceRelayout

startTemporaryDetach

onAttachedToWindow

onDetachedFromWindow

onAttachedToWindowForTest

onDetachedFromWindowForTest

onStartTemporaryDetach

onFinishTemporaryDetach

suppressMeasureComponentTree

setAnimatedWidth

setAnimatedHeight

onMeasure

performLayout

shouldAlwaysLayoutChildren

getComponentContext

shouldRequestLayout

getComponentTree

setOnDirtyMountListener

setOnPostDrawListener

setComponentTree

setComponentTree

skipNotifyVisibleBoundsChangedCalls

registerUIDebugger

unregisterUIDebugger

setComponent

setComponentWithoutReconciliation

setComponentAsync

setComponentAsyncWithoutReconciliation

rebind

unbind

setSkipMountingIfNotVisible

componentTreeHasLifecycleProvider

subscribeComponentTreeToLifecycleProvider

setVisibilityHint

setVisibilityHint

setHasTransientState

offsetTopAndBottom

offsetLeftAndRight

setTranslationX

setTranslationY

draw

notifyLithoViewGlobalPositionChanged

notifyVisibleBoundsChanged

notifyVisibleBoundsChanged

isIncrementalMountEnabled

release

dispatchVisibilityEvent

getChildLithoViewsFromCurrentlyMountedItems

unmountAllItems

getPreviousMountBounds

getMountDelegateTarget

getDynamicPropsManager

setMountStartupLoggingInfo

resetMountStartupLoggingInfo

setInvalidStateLogParamsList

rerenderForAccessibility

toString

setRenderState

getLayoutErrorMetadata