com.facebook.litho.widget

Class Progress

java.lang.Object

com.facebook.litho.ComponentLifecycle

com.facebook.litho.Component

com.facebook.litho.widget.Progress

All Implemented Interfaces:

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

public final class Progress
extends Component

Renders an infinitely spinning progress bar.

See Also:

com.facebook.litho.widget.ProgressSpec

Optional Props

color

Tint color for the drawable.

Type:

int

indeterminateDrawable

Drawable to be shown to show progress.

Type:

android.graphics.drawable.Drawable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Progress.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
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 Progress.Builder	create(ComponentContext context)
static Progress.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
boolean	isPureRender()
Progress	makeShallowCopy()
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 progressBar) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onPrepare(ComponentContext c)
protected void	onUnmount(ComponentContext c, Object progressBar) Unload UI elements associated with this component.
protected int	poolSize()

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, callsShouldUpdateOnMount, createInitialState, createMountContent, dispatchErrorEvent, dispatchErrorEvent, dispatchOnEnteredRange, dispatchOnEvent, dispatchOnExitedRange, getEventTrigger, getEventTrigger, getExtraAccessibilityNodeAt, getExtraAccessibilityNodesCount, getTreePropsForChildren, hasAttachDetachCallback, hasChildLithoViews, hasState, implementsAccessibility, implementsExtraAccessibilityNodes, isLayoutSpecWithSizeSpecCheck, isMountSizeDependent, needsPreviousRenderData, newEventHandler, newEventTrigger, onAttached, onBind, onBoundsDefined, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onCreateTransition, onDetached, onError, onMeasureBaseline, onPopulateAccessibilityNode, onPopulateExtraAccessibilityNode, onShouldCreateLayoutWithNewSizeSpec, onUnbind, populateTreeProps, recordRenderData, resolve, shouldAlwaysRemeasure, shouldUpdate, 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 Progress makeShallowCopy()

Overrides:

makeShallowCopy in class Component

onLoadStyle

protected void onLoadStyle(ComponentContext c)

Overrides:

onLoadStyle in class ComponentLifecycle

onPrepare

protected void onPrepare(ComponentContext c)

Overrides:

onPrepare 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

onMount

protected void onMount(ComponentContext c,
                       Object progressBar)

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.

onUnmount

protected void onUnmount(ComponentContext c,
                         Object progressBar)

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.

progressBar - The Drawable or View mounted by this component.

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.

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.

isPureRender

public boolean isPureRender()

Overrides:

isPureRender in class ComponentLifecycle

create

public static Progress.Builder create(ComponentContext context)

create

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