com.facebook.litho.widget

Class Text

java.lang.Object

com.facebook.litho.Component

com.facebook.litho.SpecGeneratedComponent

com.facebook.litho.widget.Text

All Implemented Interfaces:

Equivalence<Component>, EventDispatcher, EventTriggerTarget, HasEventDispatcher, HasEventTrigger, ContentAllocator, java.lang.Cloneable

public final class Text
extends SpecGeneratedComponent

Component to render text. See text-widget for more details.

Example Text usage:

 final SpannableStringBuilder spannable = new SpannableStringBuilder();
 spannable.setSpan(new StyleSpan(Typeface.BOLD), start, end, Spannable.SPAN_INCLUSIVE_INCLUSIVE);
 Text.create(c)
    .text(spannable) // String can be used
    .textSizeDip(20)
    .maxLines(3)
    .ellipsize(TextUtils.TruncateAt.END)
    .textColor(Color.BLACK)
    .build()
 

See Also:

com.facebook.litho.widget.TextSpec

Required Props

text

Text to display.

Type:

java.lang.CharSequence

Optional Props

accessibleClickableSpans

Whether the text can contain accessible clickable spans.

Type:

boolean

alignment

Type:

com.facebook.litho.widget.TextAlignment

breakStrategy

Break strategy to use for multi-line text.

Type:

int

clickableSpanExpandedOffset

Click offset amount to determine how far off the ClickableSpan bounds user can click to be able to trigger ClickableSpan's click action. This could be useful in a densely lined text with links like 'Continue reading ...' in NewsFeed to be able to click that easily.

Type:

float

clipToBounds

If the text should be clipped inside component bounds. Default: {@code true}

Type:

boolean

customEllipsisText

Text used to replace the standard Android ... ellipsis at the end of truncated lines. Warning: specifying this prop causes measurement to run twice. This can have a serious performance cost, especially on older devices!

Type:

java.lang.CharSequence

dynamicTextColor

Type:

java.lang.Integer

ellipsize

If set, specifies the position of the text to be ellipsized.

Type:

android.text.TextUtils.TruncateAt

extraSpacing

Extra spacing between the lines of text.

Type:

float

glyphWarming

If set, pre-renders the text to an off-screen Canvas to boost performance.

Type:

boolean

highlightColor

Color for an optional highlight of the text.

Type:

int

highlightEndOffset

End offset for an optional highlight of the text.

Type:

int

highlightStartOffset

Start offset for an optional highlight of the text.

Type:

int

hyphenationFrequency

How frequently to hyphenate text.

Type:

int

isSingleLine

If set, makes the text to be rendered in a single line.

Type:

boolean

justificationMode

How to justify the text. See {@link android.text.Layout}

Type:

int

letterSpacing

Text letter-spacing. Typical values for slight expansion will be around 0.05 ems. Negative values tighten text.

Type:

float

lineHeight

Controls the line height of text (the amount of vertical space reserved for each line of text).

Type:

float

linkColor

Color for links in the text.

Type:

int

maxEms

Makes the text to be max ems wide.

Type:

int

maxLines

Maximum number of lines to show.

Type:

int

maxTextWidth

Makes the text to be max pixels wide.

Type:

int

minEms

Makes the text to be mim ems wide.

Type:

int

minLines

Minimum number of lines to show.

Type:

int

minTextWidth

Makes the text to be min pixels wide.

Type:

int

minimallyWide

If set, multi-line text width is determined by the widest line, rather than the overall layout width. This can eliminate empty space in word-wrapped text with line breaks preceding lengthy words or spans.

Type:

boolean

minimallyWideThreshold

If set, {@code minimallyWide} logic will not run for text whose minimal width is smaller than its normal width by less than the threshold.

Type:

int

shadowColor

Color for the shadow underneath the text.

Type:

int

shadowDx

Horizontal offset of the shadow.

Type:

float

shadowDy

Vertical offset of the shadow.

Type:

float

shadowRadius

Blur radius of the shadow.

Type:

float

shouldIncludeFontPadding

If set, uses extra padding for ascenders and descenders.

Type:

boolean

spacingMultiplier

Extra spacing between the lines of text, as a multiplier.

Type:

float

spanListener

Listener to override click and/or longclick actions of spannables extracted from text. This can be used to avoid memory leaks if the click/long click actions require a context, since spannables are stored statically in memory.

Type:

com.facebook.litho.widget.ClickableSpanListener

textAlignment

Alignment of the text within its container.

Type:

android.text.Layout.Alignment

textColor

Color of the text.

Type:

int

textColorStateList

ColorStateList of the text.

Type:

android.content.res.ColorStateList

textDirection

Heuristic to use to determine the direction of the text.

Type:

androidx.core.text.TextDirectionHeuristicCompat

textOffsetOnTouchHandler

A handler for touch events that need to know their character offset into the text. Will only fire on ACTION_DOWN events that occur at an index within the text.

Type:

com.facebook.litho.EventHandler

textSize

Size of the text.

Type:

int

textStyle

Style for the font (e.g. {@link Typeface.BOLD}). See the @Style interface in {@link Typeface} for supported attributes.

Type:

int

touchableSpanListener

Listener to listen for touch down actions of spannables extracted from text. This can be used to avoid memory leaks if the touch down actions require a context, since spannables are stored statically in memory.

Type:

com.facebook.litho.widget.TouchableSpanListener

typeface

Typeface for the text.

Type:

android.graphics.Typeface

verticalGravity

Vertical gravity for the text within its container.

Type:

com.facebook.litho.widget.VerticalGravity

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Text.Builder

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

SpecGeneratedComponent.TransitionContainer

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

Component.ContainerBuilder<T extends Component.ContainerBuilder<T>>, Component.MountType, Component.RenderData

Method Summary

Modifier and Type	Method and Description
protected void	bindDynamicProp(int dynamicPropIndex, java.lang.Object value, java.lang.Object mountedContent)
protected boolean	canMeasure() Whether this Component is able to measure itself according to specific size constraints.
boolean	canPreallocate() This API informs the framework to fill the content pool for this Mountable ahead of time.
protected void	copyInterStageImpl(InterStagePropsContainer copyIntoInterStagePropsContainer, InterStagePropsContainer copyFromInterStagePropsContainer)
static Text.Builder	create(ComponentContext context)
static Text.Builder	create(ComponentContext context, int defStyleAttr, int defStyleRes)
protected com.facebook.litho.widget.Text.TextInterStagePropsContainer	createInterStagePropsContainer()
protected DynamicValue[]	getDynamicProps()
protected int	getExtraAccessibilityNodeAt(ComponentContext c, int x, int y, InterStagePropsContainer _3) Get extra accessibility node id at a given point within the component.
protected int	getExtraAccessibilityNodesCount(ComponentContext c, InterStagePropsContainer _1) The number of extra accessibility nodes that this component wishes to provides to the accessibility system.
Component.MountType	getMountType() This indicates the type of the Object that will be returned by com.facebook.litho.Component#mount.
static EventHandler<TextOffsetOnTouchEvent>	getTextOffsetOnTouchEventHandler(ComponentContext context)
boolean	implementsAccessibility() Whether this component will populate any accessibility nodes or events that are passed to it.
boolean	implementsExtraAccessibilityNodes() Whether this component will expose any virtual views to the accessibility framework
boolean	isEquivalentProps(Component other, boolean shouldCompareCommonProps) Determine if this component has equivalent props to a given component.
protected boolean	isMountSizeDependent()
boolean	isPureRender()
Text	makeShallowCopy()
protected void	onBoundsDefined(ComponentContext c, ComponentLayout layout, InterStagePropsContainer _2) Called after the layout calculation is finished and the given ComponentLayout has its bounds defined.
protected java.lang.Object	onCreateMountContent(Context c) Create the object that will be mounted in the LithoView.
protected void	onLoadStyle(ComponentContext c)
protected void	onMeasure(ComponentContext context, ComponentLayout layout, int widthSpec, int heightSpec, Size size, InterStagePropsContainer _5)
protected void	onMount(ComponentContext c, java.lang.Object textDrawable, InterStagePropsContainer _2) Deploy all UI elements representing the final bounds defined in the given ComponentLayout.
protected void	onPopulateAccessibilityNode(ComponentContext c, View host, AccessibilityNodeInfoCompat node, InterStagePropsContainer _3) Populate an accessibility node with information about the component.
protected void	onPopulateExtraAccessibilityNode(ComponentContext c, AccessibilityNodeInfoCompat node, int extraNodeIndex, int componentBoundsLeft, int componentBoundsTop, InterStagePropsContainer _5) Populate an extra accessibility node.
protected void	onUnmount(ComponentContext c, java.lang.Object textDrawable, InterStagePropsContainer _2) Unload UI elements associated with this component.
int	poolSize() This API informs the framework about the size of the content pool.

Methods inherited from class com.facebook.litho.SpecGeneratedComponent

acceptTriggerEvent, acceptTriggerEventImpl, applyPreviousRenderData, copyPrepareInterStageImpl, createContent, createInitialState, createPoolableContent, createPrepareInterStagePropsContainer, createRecyclingPool, createStateContainer, dispatchOnEnteredRange, dispatchOnExitedRange, getInterStagePropsContainer, getPoolableContentType, getPrepareInterStagePropsContainer, getSimpleName, getSimpleNameDelegate, getTreePropsForChildren, hasAttachDetachCallback, hasOwnErrorHandler, hasState, isRecyclingDisabled, needsPreviousRenderData, onAttached, onBind, onCreateLayout, onCreateLayoutWithSizeSpec, onCreateMountContentPool, onDetached, onError, onMeasureBaseline, onPrepare, onUnbind, populateTreeProps, prepare, recordEventTrigger, recordRenderData, render, shouldAlwaysRemeasure, usesLocalStateContainer

Methods inherited from class com.facebook.litho.Component

clone, createMountContent, dispatchErrorEvent, dispatchOnEvent, dispatchOnEventImpl, equals, excludeFromIncrementalMount, getCommonProps, getErrorHandler, getEventDispatcher, getEventTrigger, getEventTrigger, getHandle, getTreePropFromParent, getTypeId, hasChildLithoViews, hasClickHandlerSet, hashCode, implementsShouldUpdate, isEqualivalentTreeProps, isEquivalentCommonProps, isEquivalentTo, isEquivalentTo, isLayoutSpecWithSizeSpec, isPureRender, measure, measure, measureMightNotCacheInternalNode, newEventHandler, newEventTrigger, newEventTrigger, onCreateTransition, registerWorkingRange, resolve, retrieveValue, shouldUpdate, toString, transferState, willRender

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createInterStagePropsContainer

protected com.facebook.litho.widget.Text.TextInterStagePropsContainer createInterStagePropsContainer()

Overrides:

createInterStagePropsContainer in class SpecGeneratedComponent

isEquivalentProps

public boolean isEquivalentProps(Component other,
                                 boolean shouldCompareCommonProps)

Description copied from class: Component

Determine if this component has equivalent props to a given component. This method does not compare common props.

Overrides:

isEquivalentProps in class Component

Parameters:

other - the component to compare to

Returns:

true if the components have equivalent props

copyInterStageImpl

protected void copyInterStageImpl(InterStagePropsContainer copyIntoInterStagePropsContainer,
                                  InterStagePropsContainer copyFromInterStagePropsContainer)

Overrides:

copyInterStageImpl in class SpecGeneratedComponent

makeShallowCopy

public Text makeShallowCopy()

Overrides:

makeShallowCopy in class Component

getDynamicProps

protected DynamicValue[] getDynamicProps()

Overrides:

getDynamicProps in class Component

bindDynamicProp

protected void bindDynamicProp(int dynamicPropIndex,
                               java.lang.Object value,
                               java.lang.Object mountedContent)

Overrides:

bindDynamicProp in class SpecGeneratedComponent

onLoadStyle

protected void onLoadStyle(ComponentContext c)

Overrides:

onLoadStyle in class Component

onMeasure

protected void onMeasure(ComponentContext context,
                         ComponentLayout layout,
                         int widthSpec,
                         int heightSpec,
                         Size size,
                         InterStagePropsContainer _5)

Overrides:

onMeasure in class SpecGeneratedComponent

canMeasure

protected boolean canMeasure()

Description copied from class: Component

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

Overrides:

canMeasure in class Component

onBoundsDefined

protected void onBoundsDefined(ComponentContext c,
                               ComponentLayout layout,
                               InterStagePropsContainer _2)

Description copied from class: SpecGeneratedComponent

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 SpecGeneratedComponent

Parameters:

c - The Context used by this component.

layout - The ComponentLayout with defined position and size.

onCreateMountContent

protected java.lang.Object onCreateMountContent(Context c)

Description copied from class: Component

Create the object that will be mounted in the LithoView.

Overrides:

onCreateMountContent in class Component

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,
                       java.lang.Object textDrawable,
                       InterStagePropsContainer _2)

Description copied from class: SpecGeneratedComponent

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 SpecGeneratedComponent

Parameters:

c - The ComponentContext to mount the component into.

onUnmount

protected void onUnmount(ComponentContext c,
                         java.lang.Object textDrawable,
                         InterStagePropsContainer _2)

Description copied from class: SpecGeneratedComponent

Unload UI elements associated with this component.

Overrides:

onUnmount in class SpecGeneratedComponent

Parameters:

c - The Context for this mount operation.

textDrawable - The Drawable or View mounted by this component.

onPopulateAccessibilityNode

protected void onPopulateAccessibilityNode(ComponentContext c,
                                           View host,
                                           AccessibilityNodeInfoCompat node,
                                           InterStagePropsContainer _3)

Description copied from class: Component

Populate an accessibility node with information about the component.

Overrides:

onPopulateAccessibilityNode in class Component

node - node to populate

implementsAccessibility

public boolean implementsAccessibility()

Description copied from class: SpecGeneratedComponent

Whether this component will populate any accessibility nodes or events that are passed to it.

Overrides:

implementsAccessibility in class SpecGeneratedComponent

Returns:

true if the component implements accessibility info

getExtraAccessibilityNodesCount

protected int getExtraAccessibilityNodesCount(ComponentContext c,
                                              InterStagePropsContainer _1)

Description copied from class: SpecGeneratedComponent

The number of extra accessibility nodes that this component wishes to provides to the accessibility system.

Overrides:

getExtraAccessibilityNodesCount in class SpecGeneratedComponent

Returns:

the number of extra nodes

onPopulateExtraAccessibilityNode

protected void onPopulateExtraAccessibilityNode(ComponentContext c,
                                                AccessibilityNodeInfoCompat node,
                                                int extraNodeIndex,
                                                int componentBoundsLeft,
                                                int componentBoundsTop,
                                                InterStagePropsContainer _5)

Description copied from class: Component

Populate an extra accessibility node.

Overrides:

onPopulateExtraAccessibilityNode in class Component

node - node to populate

extraNodeIndex - index of extra node

componentBoundsLeft - left bound of the mounted component

componentBoundsTop - top bound of the mounted component

implementsExtraAccessibilityNodes

public boolean implementsExtraAccessibilityNodes()

Description copied from class: SpecGeneratedComponent

Whether this component will expose any virtual views to the accessibility framework

Overrides:

implementsExtraAccessibilityNodes in class SpecGeneratedComponent

Returns:

true if the component exposes extra accessibility nodes

getExtraAccessibilityNodeAt

protected int getExtraAccessibilityNodeAt(ComponentContext c,
                                          int x,
                                          int y,
                                          InterStagePropsContainer _3)

Description copied from class: SpecGeneratedComponent

Get extra accessibility node id at a given point within the component.

Overrides:

getExtraAccessibilityNodeAt in class SpecGeneratedComponent

x - x co-ordinate within the mounted component

y - y co-ordinate within the mounted component

Returns:

the extra virtual view id if one is found, otherwise ExploreByTouchHelper#INVALID_ID

getMountType

public Component.MountType getMountType()

Description copied from class: Component

This indicates the type of the Object that will be returned by com.facebook.litho.Component#mount.

Overrides:

getMountType in class Component

Returns:

one of Component.MountType

poolSize

public int poolSize()

Description copied from interface: ContentAllocator

This API informs the framework about the size of the content pool. The default is 3.

Experimental. Currently for Litho team internal use only.

Specified by:

poolSize in interface ContentAllocator

Overrides:

poolSize in class SpecGeneratedComponent

canPreallocate

public boolean canPreallocate()

Description copied from interface: ContentAllocator

This API informs the framework to fill the content pool for this Mountable ahead of time. The default value is false, i.e. content is not pre-allocated. Pre-allocation of the content can improve performance in some circumstances where creating the content is expensive.

Specified by:

canPreallocate in interface ContentAllocator

Overrides:

canPreallocate in class SpecGeneratedComponent

Returns:

true if this component can be preallocated.

isMountSizeDependent

protected boolean isMountSizeDependent()

Overrides:

isMountSizeDependent in class SpecGeneratedComponent

Returns:

true if Mount uses @FromMeasure or @FromOnBoundsDefined parameters.

isPureRender

public boolean isPureRender()

Overrides:

isPureRender in class Component

getTextOffsetOnTouchEventHandler

public static EventHandler<TextOffsetOnTouchEvent> getTextOffsetOnTouchEventHandler(ComponentContext context)

create

public static Text.Builder create(ComponentContext context)

create

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