com.facebook.litho.widget

Class CardClip

java.lang.Object

com.facebook.litho.ComponentLifecycle

com.facebook.litho.Component

com.facebook.litho.widget.CardClip

All Implemented Interfaces:

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

public final class CardClip
extends Component

A component that paints rounded edges to mimic a clipping operation on the component being rendered below it. Used in CardSpec.

See Also:

com.facebook.litho.widget.CardClipSpec

Optional Props

clippingColor

Color for corner clipping.

Type:

int

cornerRadius

Radius for corner clipping.

Type:

float

disableClipBottomLeft

If set, opt out of clipping the bottom-left corner

Type:

boolean

disableClipBottomRight

If set, opt out of clipping the bottom-right corner

Type:

boolean

disableClipTopLeft

If set, opt out of clipping the top-left corner

Type:

boolean

disableClipTopRight

If set, opt out of clipping the top-right corner

Type:

boolean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CardClip.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	canPreallocate()
static CardClip.Builder	create(ComponentContext context)
static CardClip.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()
protected Object	onCreateMountContent(Context c) Create the object that will be mounted in the LithoView.
protected void	onMount(ComponentContext c, Object cardClipDrawable) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onUnmount(ComponentContext c, Object cardClipDrawable) Unload UI elements associated with this component.
protected int	poolSize()

Methods inherited from class com.facebook.litho.Component

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

Methods inherited from class com.facebook.litho.ComponentLifecycle

acceptTriggerEvent, applyPreviousRenderData, callsShouldUpdateOnMount, canMeasure, 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, onLoadStyle, onMeasure, onMeasureBaseline, onPopulateAccessibilityNode, onPopulateExtraAccessibilityNode, onPrepare, 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

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 cardClipDrawable)

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 cardClipDrawable)

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.

cardClipDrawable - The Drawable or View mounted by 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 CardClip.Builder create(ComponentContext context)

create

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