com.facebook.litho.testing.subcomponents

Class InspectableComponent

java.lang.Object

com.facebook.litho.testing.subcomponents.InspectableComponent

public class InspectableComponent
extends java.lang.Object

Wraps a DebugComponent exposing only information that are safe to use for test assertions.

Method Summary

Modifier and Type	Method and Description
Drawable	getBackground()
Rect	getBounds()
Rect	getBoundsInLithoView()
java.util.List<InspectableComponent>	getChildComponents() Get the list of components composed by this component.
EventHandler	getClickHandler()
Component	getComponent()
java.lang.Class	getComponentClass()
ComponentHost	getComponentHost()
java.lang.Object	getComponentTag()
java.lang.String	getComponentTestKey() Returns this component's testKey or null if none is set.
java.lang.CharSequence	getContentDescription()
boolean	getFocusable()
Drawable	getForeground()
java.lang.String	getId()
java.lang.Integer	getImportantForAccessibility()
java.lang.String	getKey()
LithoView	getLithoView()
Drawable	getMountedDrawable()
View	getMountedView()
java.lang.String	getName()
InspectableComponent	getNestedInstance(Component component) Obtain an instance of a Component nested inside the given inspectable Component.
static InspectableComponent	getRootInstance(LithoView view)
java.lang.String	getSimpleName()
StateContainer	getStateContainer()
java.lang.String	getTestKey()
java.lang.String	getTextContent()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getRootInstance

public static InspectableComponent getRootInstance(LithoView view)

Returns:

The root InspectableComponent of a LithoView.

getNestedInstance

public InspectableComponent getNestedInstance(Component component)

Obtain an instance of a Component nested inside the given inspectable Component.

getName

public java.lang.String getName()

Returns:

A canonical name for this component. Suitable to present to the user.

getSimpleName

public java.lang.String getSimpleName()

Returns:

A simpler canonical name for this component. Suitable to present to the user.

getComponentClass

public java.lang.Class getComponentClass()

Returns:

The class of the underlying Component.

getChildComponents

public java.util.List<InspectableComponent> getChildComponents()

Get the list of components composed by this component. This will not include any Views that are mounted by this component as those are not components. Use this#getMountedView for that.

Returns:

A list of child components.

getMountedView

public View getMountedView()

Returns:

A mounted view or null if this component does not mount a view.

getMountedDrawable

public Drawable getMountedDrawable()

Returns:

A mounted drawable or null if this component does not mount a drawable.

getLithoView

public LithoView getLithoView()

Returns:

The litho view hosting this component.

getBoundsInLithoView

public Rect getBoundsInLithoView()

Returns:

The bounds of this component relative to its hosting LithoView.

getBounds

public Rect getBounds()

Returns:

The bounds of this component relative to its parent.

getTestKey

public java.lang.String getTestKey()

Returns:

This component's testKey or null if none is set.

getComponentTestKey

public java.lang.String getComponentTestKey()

Returns this component's testKey or null if none is set.

Unlike getTestKey(), this function can return a test key set on any Component, including container Components which resolve into LayoutNodes.

getComponentTag

public java.lang.Object getComponentTag()

Returns:

This component's componentTag or null if none is set.

getTextContent

public java.lang.String getTextContent()

Returns:

The text content of the component wrapped by the debug component, or null if no TextContent/TextView are found.

getComponentHost

public ComponentHost getComponentHost()

Returns:

The ComponentHost that wraps this component or null if one cannot be found.

getKey

public java.lang.String getKey()

Returns:

This component's key or null if none is set.

getComponent

public Component getComponent()

Returns:

The Component instance this debug component wraps.

getForeground

public Drawable getForeground()

Returns:

The foreground drawable asscociated with this debug component. May be null.

getBackground

public Drawable getBackground()

Returns:

The background drawable asscociated with this debug component. May be null.

getImportantForAccessibility

public java.lang.Integer getImportantForAccessibility()

Returns:

The int value of the importantForAccessibility property on this debug component.

getFocusable

public boolean getFocusable()

Returns:

The boolean value of the focusable property on this debug component.

getContentDescription

public java.lang.CharSequence getContentDescription()

Returns:

The content description CharSequence on this debug component. May be null.

getStateContainer

public StateContainer getStateContainer()

getId

public java.lang.String getId()

getClickHandler

public EventHandler getClickHandler()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object