com.facebook.litho.testing.helper

Class ComponentTestHelper

java.lang.Object

com.facebook.litho.testing.helper.ComponentTestHelper

public final class ComponentTestHelper
extends Object

Helper class to simplify testing of components.

Allows simple and short creation of views that are created and mounted in a similar way to how they are in real apps.

Method Summary

Modifier and Type	Method and Description
static LithoView	dispatchOnFocusedVisibleEvent(ComponentContext context, EventHandler onFocusedVisibleHandler, Component component) Deprecated.
static LithoView	dispatchOnInvisibleEvent(ComponentContext context, EventHandler onInvisibleHandler, Component component) Deprecated.
static LithoView	dispatchOnVisibleEvent(ComponentContext context, EventHandler onVisibleHandler, Component component) Deprecated.
static Looper	getDefaultLayoutThreadLooper() Access the default layout thread looper for testing purposes only.
static ShadowLooper	getDefaultLayoutThreadShadowLooper() Access the shadow of the default layout thread looper for testing purposes only.
static <T extends Component> Component	getSubComponent(Component.Builder component, Class<T> componentClass) Deprecated. Use ComponentAssert#extractingSubComponents() instead.
static List<SubComponent>	getSubComponents(Component.Builder component) Deprecated. Use ComponentAssert#extractingSubComponents() instead.
static List<SubComponent>	getSubComponents(Component.Builder component, int widthSpec, int heightSpec) Deprecated. Use ComponentAssert#extractingSubComponents() instead.
static List<SubComponent>	getSubComponents(ComponentContext context, Component component) Deprecated. Use ComponentAssert#extractingSubComponents() instead.
static List<SubComponent>	getSubComponents(ComponentContext context, Component component, int widthSpec, int heightSpec) Deprecated. Use ComponentAssert#extractingSubComponents() instead.
static void	measureAndLayout(View view) Measure and layout a component view.
static LithoView	mountComponent(Component.Builder component) Mount a component into a component view.
static LithoView	mountComponent(Component.Builder component, boolean incrementalMountEnabled, boolean visibilityProcessingEnabled) Mount a component into a component view.
static LithoView	mountComponent(ComponentContext context, Component component) Mount a component into a component view.
static LithoView	mountComponent(ComponentContext context, Component component, boolean incrementalMountEnabled, boolean visibilityProcessingEnabled) Mount a component into a component view.
static LithoView	mountComponent(ComponentContext context, Component component, int width, int height) Mount a component into a component view.
static LithoView	mountComponent(ComponentContext context, LithoView lithoView, Component component) Mount a component into a component view.
static LithoView	mountComponent(ComponentContext context, LithoView lithoView, Component component, boolean incrementalMountEnabled, boolean visibilityProcessingEnabled, int width, int height) Mount a component into a component view.
static LithoView	mountComponent(ComponentContext context, LithoView lithoView, Component component, int width, int height) Mount a component into a component view.
static LithoView	mountComponent(LithoView lithoView, ComponentTree componentTree) Mount a component tree into a component view.
static LithoView	mountComponent(LithoView lithoView, ComponentTree componentTree, Component component) Set a root component to a component tree, and mount it into a component view.
static LithoView	mountComponent(LithoView lithoView, ComponentTree componentTree, int widthSpec, int heightSpec) Mount a component tree into a component view.
static void	setTreeProp(ComponentContext context, Class propClass, Object prop) Sets a TreeProp that will be visible to all Components which are created from the given Context (unless a child overwrites its).
static boolean	triggerVisibilityEvent(LithoView lithoView, Class<?> visibilityClass) Triggers a Litho visibility event
static void	unbindComponent(LithoView lithoView) Unbinds a component tree from a component view.
static void	unmountComponent(LithoView lithoView) Unmounts a component tree from a component view.

Methods inherited from class java.lang.Object

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

Method Detail

mountComponent

public static LithoView mountComponent(Component.Builder component)

Mount a component into a component view.

Parameters:

component - The component builder to mount

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(Component.Builder component,
                                       boolean incrementalMountEnabled,
                                       boolean visibilityProcessingEnabled)

Mount a component into a component view.

Parameters:

component - The component builder to mount

incrementalMountEnabled - States whether incremental mount is enabled

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(ComponentContext context,
                                       Component component)

Mount a component into a component view.

Parameters:

context - A components context

component - The component to mount

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(ComponentContext context,
                                       Component component,
                                       boolean incrementalMountEnabled,
                                       boolean visibilityProcessingEnabled)

Mount a component into a component view.

Parameters:

context - A components context

component - The component to mount

incrementalMountEnabled - States whether incremental mount is enabled

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(ComponentContext context,
                                       Component component,
                                       int width,
                                       int height)

Mount a component into a component view.

Parameters:

context - A components context

component - The component to mount

width - The width of the resulting view

height - The height of the resulting view

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(ComponentContext context,
                                       LithoView lithoView,
                                       Component component)

Mount a component into a component view.

Parameters:

context - A components context

lithoView - The view to mount the component into

component - The component to mount

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(ComponentContext context,
                                       LithoView lithoView,
                                       Component component,
                                       int width,
                                       int height)

Mount a component into a component view.

Parameters:

context - A components context

lithoView - The view to mount the component into

component - The component to mount

width - The width of the resulting view

height - The height of the resulting view

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(ComponentContext context,
                                       LithoView lithoView,
                                       Component component,
                                       boolean incrementalMountEnabled,
                                       boolean visibilityProcessingEnabled,
                                       int width,
                                       int height)

Mount a component into a component view.

Parameters:

context - A components context

lithoView - The view to mount the component into

component - The component to mount

incrementalMountEnabled - States whether incremental mount is enabled

width - The width of the resulting view

height - The height of the resulting view

Returns:

A LithoView with the component mounted in it.

mountComponent

public static LithoView mountComponent(LithoView lithoView,
                                       ComponentTree componentTree)

Mount a component tree into a component view.

Parameters:

lithoView - The view to mount the component tree into

componentTree - The component tree to mount

Returns:

A LithoView with the component tree mounted in it.

mountComponent

public static LithoView mountComponent(LithoView lithoView,
                                       ComponentTree componentTree,
                                       Component component)

Set a root component to a component tree, and mount it into a component view.

Parameters:

lithoView - The view to mount the component tree into

componentTree - The component tree to mount

component - The root component

Returns:

A LithoView with the component tree mounted in it.

mountComponent

public static LithoView mountComponent(LithoView lithoView,
                                       ComponentTree componentTree,
                                       int widthSpec,
                                       int heightSpec)

Mount a component tree into a component view.

Parameters:

lithoView - The view to mount the component tree into

componentTree - The component tree to mount

widthSpec - The width spec used to measure the resulting view

heightSpec - The height spec used to measure the resulting view

Returns:

A LithoView with the component tree mounted in it.

unmountComponent

public static void unmountComponent(LithoView lithoView)

Unmounts a component tree from a component view.

Parameters:

lithoView - the view to unmount

unbindComponent

public static void unbindComponent(LithoView lithoView)

Unbinds a component tree from a component view.

Parameters:

lithoView - The view to unbind.

getSubComponents

@Deprecated
public static List<SubComponent> getSubComponents(Component.Builder component)

Deprecated. Use ComponentAssert#extractingSubComponents() instead.

Get the subcomponents of a component

Parameters:

component - The component builder which to get the subcomponents of

Returns:

The subcomponents of the given component

getSubComponents

@Deprecated
public static List<SubComponent> getSubComponents(ComponentContext context,
                                                              Component component)

Deprecated. Use ComponentAssert#extractingSubComponents() instead.

Get the subcomponents of a component

Parameters:

context - A components context

component - The component which to get the subcomponents of

Returns:

The subcomponents of the given component

getSubComponents

@Deprecated
public static List<SubComponent> getSubComponents(Component.Builder component,
                                                              int widthSpec,
                                                              int heightSpec)

Deprecated. Use ComponentAssert#extractingSubComponents() instead.

Get the subcomponents of a component

Parameters:

component - The component which to get the subcomponents of

widthSpec - The width to measure the component with

heightSpec - The height to measure the component with

Returns:

The subcomponents of the given component

getSubComponents

@Deprecated
public static List<SubComponent> getSubComponents(ComponentContext context,
                                                              Component component,
                                                              int widthSpec,
                                                              int heightSpec)

Deprecated. Use ComponentAssert#extractingSubComponents() instead.

Get the subcomponents of a component

Parameters:

context - A components context

component - The component which to get the subcomponents of

widthSpec - The width to measure the component with

heightSpec - The height to measure the component with

Returns:

The subcomponents of the given component

getSubComponent

@Deprecated
public static <T extends Component> Component getSubComponent(Component.Builder component,
                                                                          Class<T> componentClass)

Deprecated. Use ComponentAssert#extractingSubComponents() instead.

Returns the first subComponent of type class.

Parameters:

component - The component builder which to get the subcomponent from

componentClass - the class type of the requested sub component

Returns:

The first instance of subComponent of type Class or null if none is present.

measureAndLayout

public static void measureAndLayout(View view)

Measure and layout a component view.

Parameters:

view - The component view to measure and layout

dispatchOnVisibleEvent

@Deprecated
public static LithoView dispatchOnVisibleEvent(ComponentContext context,
                                                           EventHandler onVisibleHandler,
                                                           Component component)

Deprecated.

Mounts the component & triggers the visibility event. Requires that the component supports incremental mounting.

VisibleEvent

DEPRECATED: Prefer using triggerVisibilityEvent(LithoView, Class) instead

Parameters:

context - A components context

onVisibleHandler - SpecificComponent.onVisible(component)

component - The component builder which to get the subcomponent from

Returns:

A LithoView with the component mounted in it.

dispatchOnFocusedVisibleEvent

@Deprecated
public static LithoView dispatchOnFocusedVisibleEvent(ComponentContext context,
                                                                  EventHandler onFocusedVisibleHandler,
                                                                  Component component)

Deprecated.

Mounts the component & triggers the focused visibility event. Requires that the component supports incremental mounting.

FocusedVisibleEvent

DEPRECATED: Prefer using triggerVisibilityEvent(LithoView, Class) instead

Parameters:

context - A components context

onFocusedVisibleHandler - SpecificComponent.onFocusedVisible(component)

component - The component builder which to get the subcomponent from

Returns:

A LithoView with the component mounted in it.

dispatchOnInvisibleEvent

@Deprecated
public static LithoView dispatchOnInvisibleEvent(ComponentContext context,
                                                             EventHandler onInvisibleHandler,
                                                             Component component)

Deprecated.

Mounts the component & triggers the invisible event. Requires that the component supports incremental mounting.

InvisibleEvent

DEPRECATED: Prefer using triggerVisibilityEvent(LithoView, Class) instead

Parameters:

context - A components context

onInvisibleHandler - SpecificComponent.onInvisible(component)

component - The component builder which to get the subcomponent from

Returns:

A LithoView with the component mounted in it.

triggerVisibilityEvent

public static boolean triggerVisibilityEvent(LithoView lithoView,
                                             Class<?> visibilityClass)

Triggers a Litho visibility event

The event needs to be one of VisibleEvent, InvisibleEvent, FocusedVisibleEvent, UnfocusedVisibleEvent, or FullImpressionVisibleEvent.

Parameters:

lithoView - the view to invoke the event on its component tree

visibilityClass - the type of the event to invoke

Returns:

true if a handler for this event type was found

setTreeProp

public static void setTreeProp(ComponentContext context,
                               Class propClass,
                               Object prop)

Sets a TreeProp that will be visible to all Components which are created from the given Context (unless a child overwrites its).

getDefaultLayoutThreadLooper

public static Looper getDefaultLayoutThreadLooper()

Access the default layout thread looper for testing purposes only.

getDefaultLayoutThreadShadowLooper

public static ShadowLooper getDefaultLayoutThreadShadowLooper()

Access the shadow of the default layout thread looper for testing purposes only.