com.facebook.litho.widget

Class Image

java.lang.Object

com.facebook.litho.ComponentLifecycle

com.facebook.litho.Component

com.facebook.litho.widget.Image

All Implemented Interfaces:

Equivalence<Component>, EventDispatcher, EventTriggerTarget, HasEventDispatcher, HasEventTrigger, Cloneable

public final class Image
extends Component

A component that is able to display drawable resources. It takes a drawable resource ID as prop.

See Also:

com.facebook.litho.widget.ImageSpec

Required Props

drawable

Drawable to display.

Type:

android.graphics.drawable.Drawable

Optional Props

scaleType

Scale type for the drawable within the container.

Type:

android.widget.ImageView.ScaleType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Image.Builder

Nested classes/interfaces inherited from class com.facebook.litho.Component

Component.ContainerBuilder<T extends Component.ContainerBuilder<T>>

Nested classes/interfaces inherited from class com.facebook.litho.ComponentLifecycle

ComponentLifecycle.MountType, ComponentLifecycle.RenderData, ComponentLifecycle.TransitionContainer

Method Summary

Modifier and Type	Method and Description
boolean	callsShouldUpdateOnMount()
protected boolean	canMeasure() Whether this ComponentLifecycle is able to measure itself according to specific size constraints.
protected boolean	canPreallocate()
protected void	copyInterStageImpl(Component component)
static Image.Builder	create(ComponentContext context)
static Image.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes)
ComponentLifecycle.MountType	getMountType() This indicates the type of the Object that will be returned by ComponentLifecycle.mount(com.facebook.litho.ComponentContext, java.lang.Object).
boolean	isEquivalentTo(Component other) Compares this component to a different one to check if they are the same
protected boolean	isMountSizeDependent()
boolean	isPureRender()
Image	makeShallowCopy()
protected void	onBind(ComponentContext c, Object mountedDrawable)
protected void	onBoundsDefined(ComponentContext c, ComponentLayout layout) Called after the layout calculation is finished and the given ComponentLayout has its bounds defined.
protected Object	onCreateMountContent(Context c) Create the object that will be mounted in the LithoView.
protected void	onLoadStyle(ComponentContext c)
protected void	onMeasure(ComponentContext c, ComponentLayout layout, int widthSpec, int heightSpec, Size size)
protected void	onMount(ComponentContext c, Object matrixDrawable) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onUnmount(ComponentContext c, Object convertDrawable) Unload UI elements associated with this component.
protected int	poolSize()
protected boolean	shouldUpdate(Component _prevAbstractImpl, Component _nextAbstractImpl) Whether the component needs updating.

Methods inherited from class com.facebook.litho.Component

bindDynamicProp, canResolve, clearCachedLayout, getCommonProps, getDynamicProps, getEventDispatcher, getHandle, getId, getKey, getScopedContext, getSimpleName, getSimpleNameDelegate, getStateContainer, hasBackgroundSet, hasClickHandlerSet, measure, measureMightNotCacheInternalNode, recordEventTrigger, registerWorkingRange, retrieveValue, setScopedContext, updateInternalChildState, willRender

Methods inherited from class com.facebook.litho.ComponentLifecycle

acceptTriggerEvent, applyPreviousRenderData, createInitialState, createMountContent, dispatchErrorEvent, dispatchErrorEvent, dispatchOnEnteredRange, dispatchOnEvent, dispatchOnExitedRange, getEventTrigger, getEventTrigger, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getTreePropsForChildren, hasAttachDetachCallback, hasChildLithoViews, hasState, implementsAccessibility, implementsExtraAccessibilityNodes, isLayoutSpecWithSizeSpecCheck, needsPreviousRenderData, newEventHandler, newEventTrigger, onAttached, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onCreateTransition, onDetached, onError, onMeasureBaseline, onPopulateAccessibilityNode, onPopulateExtraAccessibilityNode, onPrepare, onShouldCreateLayoutWithNewSizeSpec, onUnbind, populateTreeProps, recordRenderData, resolve, shouldAlwaysRemeasure, shouldUseGlobalPool, transferState

Methods inherited from class java.lang.Object

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

Method Detail

isEquivalentTo

public boolean isEquivalentTo(Component other)

Description copied from class: Component

Compares this component to a different one to check if they are the same

This is used to be able to skip rendering a component again. We avoid using the Object.equals(Object) so we can optimize the code better over time since we don't have to adhere to the contract required for a equals method.

Specified by:

isEquivalentTo in interface Equivalence<Component>

Overrides:

isEquivalentTo in class Component

Parameters:

other - the component to compare to

Returns:

true if the components are of the same type and have the same props

copyInterStageImpl

protected void copyInterStageImpl(Component component)

Overrides:

copyInterStageImpl in class Component

makeShallowCopy

public Image makeShallowCopy()

Overrides:

makeShallowCopy in class Component

onLoadStyle

protected void onLoadStyle(ComponentContext c)

Overrides:

onLoadStyle in class ComponentLifecycle

onMeasure

protected void onMeasure(ComponentContext c,
                         ComponentLayout layout,
                         int widthSpec,
                         int heightSpec,
                         Size size)

Overrides:

onMeasure in class ComponentLifecycle

canMeasure

protected boolean canMeasure()

Description copied from class: ComponentLifecycle

Whether this ComponentLifecycle is able to measure itself according to specific size constraints.

Overrides:

canMeasure in class ComponentLifecycle

onBoundsDefined

protected void onBoundsDefined(ComponentContext c,
                               ComponentLayout layout)

Description copied from class: ComponentLifecycle

Called after the layout calculation is finished and the given ComponentLayout has its bounds defined. You can use ComponentLayout.getX(), ComponentLayout.getY(), ComponentLayout.getWidth(), and ComponentLayout.getHeight() to get the size and position of the component in the layout tree.

Overrides:

onBoundsDefined in class ComponentLifecycle

Parameters:

c - The Context used by this component.

layout - The ComponentLayout with defined position and size.

onCreateMountContent

protected Object onCreateMountContent(Context c)

Description copied from class: ComponentLifecycle

Create the object that will be mounted in the LithoView.

Overrides:

onCreateMountContent in class ComponentLifecycle

Parameters:

c - The Context to be used to create the content.

Returns:

an Object that can be mounted for this component.

onMount

protected void onMount(ComponentContext c,
                       Object matrixDrawable)

Description copied from class: ComponentLifecycle

Deploy all UI elements representing the final bounds defined in the given ComponentLayout. Return either a Drawable or a View or null to be mounted.

Overrides:

onMount in class ComponentLifecycle

Parameters:

c - The ComponentContext to mount the component into.

onBind

protected void onBind(ComponentContext c,
                      Object mountedDrawable)

Overrides:

onBind in class ComponentLifecycle

onUnmount

protected void onUnmount(ComponentContext c,
                         Object convertDrawable)

Description copied from class: ComponentLifecycle

Unload UI elements associated with this component.

Overrides:

onUnmount in class ComponentLifecycle

Parameters:

c - The Context for this mount operation.

convertDrawable - The Drawable or View mounted by this component.

shouldUpdate

protected boolean shouldUpdate(Component _prevAbstractImpl,
                               Component _nextAbstractImpl)

Description copied from class: ComponentLifecycle

Whether the component needs updating.

For layout components, the framework will verify that none of the children of the component need updating, and that both components have the same number of children. Therefore this method just needs to determine any changes to the top-level component that would cause it to need to be updated (for example, a click handler was added).

For mount specs, the framework does nothing extra and this method alone determines whether the component is updated or not.

Overrides:

shouldUpdate in class ComponentLifecycle

Parameters:

_prevAbstractImpl - the previous component to compare against.

_nextAbstractImpl - the component that is now in use.

Returns:

true if the component needs an update, false otherwise.

getMountType

public ComponentLifecycle.MountType getMountType()

Description copied from class: ComponentLifecycle

This indicates the type of the Object that will be returned by ComponentLifecycle.mount(com.facebook.litho.ComponentContext, java.lang.Object).

Overrides:

getMountType in class ComponentLifecycle

Returns:

one of ComponentLifecycle.MountType

poolSize

protected int poolSize()

Overrides:

poolSize in class ComponentLifecycle

canPreallocate

protected boolean canPreallocate()

Overrides:

canPreallocate in class ComponentLifecycle

Returns:

true if this component can be preallocated.

isMountSizeDependent

protected boolean isMountSizeDependent()

Overrides:

isMountSizeDependent in class ComponentLifecycle

Returns:

true if Mount uses @FromMeasure or @FromOnBoundsDefined parameters.

callsShouldUpdateOnMount

public boolean callsShouldUpdateOnMount()

Overrides:

callsShouldUpdateOnMount in class ComponentLifecycle

isPureRender

public boolean isPureRender()

Overrides:

isPureRender in class ComponentLifecycle

create

public static Image.Builder create(ComponentContext context)

create

public static Image.Builder create(ComponentContext context,
                                   int defStyleAttr,
                                   int defStyleRes)