litho-widget/com.facebook.litho.widget/TextComponentSpec

TextComponentSpec

@MountSpec(isPureRender = true, hasIntrinsicSize = true, poolSize = 30, canPreallocate = true, events = [TextOffsetOnTouchEvent::class])

object TextComponentSpec

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

Properties

breakStrategy

val breakStrategy: Int

clipToBounds

val clipToBounds: Boolean = true

DEFAULT_COLOR

const val DEFAULT_COLOR: Int = 0

DEFAULT_TEXT_COLOR_STATE_LIST_COLORS

val DEFAULT_TEXT_COLOR_STATE_LIST_COLORS: IntArray

DEFAULT_TEXT_COLOR_STATE_LIST_STATES

val DEFAULT_TEXT_COLOR_STATE_LIST_STATES: Array<IntArray>

DEFAULT_TEXT_SIZE_SP

@Dimension(unit = 2)

val DEFAULT_TEXT_SIZE_SP: Int = 14

DEFAULT_TYPEFACE

val DEFAULT_TYPEFACE: Typeface

glyphWarming

val glyphWarming: Boolean = false

highlightEndOffset

val highlightEndOffset: Int

highlightStartOffset

val highlightStartOffset: Int

hyphenationFrequency

val hyphenationFrequency: Int

justificationMode

val justificationMode: Int

lineHeight

val lineHeight: Float

val linkColor: Int

val maxEms: Int

val maxLines: Int

val maxTextWidth: Int

minEms

val minEms: Int

minLines

val minLines: Int

minTextWidth

val minTextWidth: Int

outlineColor

val outlineColor: Int = 0

outlineWidth

val outlineWidth: Float = 0.0f

shadowColor

val shadowColor: Int

shouldIncludeFontPadding

val shouldIncludeFontPadding: Boolean = true

spacingMultiplier

val spacingMultiplier: Float = 1.0f

textColor

val textColor: Int

textColorStateList

val textColorStateList: ColorStateList

textSize

val textSize: Int

textStyle

val textStyle: Int

typeface

val typeface: Typeface

UNSET

const val UNSET: Int

verticalGravity

val verticalGravity: VerticalGravity

Functions

getExtraAccessibilityNodeAt

fun getExtraAccessibilityNodeAt(c: ComponentContext?, x: Int, y: Int, text: CharSequence?, textLayout: Layout, clickableSpans: Array<ClickableSpan?>): Int

getExtraAccessibilityNodesCount

fun getExtraAccessibilityNodesCount(c: ComponentContext?, accessibleClickableSpans: Boolean, clickableSpans: Array<ClickableSpan?>?): Int

getTextAlignment

fun getTextAlignment(alignment: Layout.Alignment?, textAlignment: TextAlignment?): TextAlignment

onBindTextColor

fun onBindTextColor(textDrawable: TextDrawable, dynamicTextColor: Int?)

onBoundsDefined

fun onBoundsDefined(c: ComponentContext, layout: ComponentLayout, text: CharSequence?, ellipsize: TextUtils.TruncateAt?, shouldIncludeFontPadding: Boolean, maxLines: Int, minEms: Int, maxEms: Int, minTextWidth: Int, maxTextWidth: Int, shadowRadius: Float, shadowDx: Float, shadowDy: Float, shadowColor: Int, isSingleLine: Boolean, textColor: Int, textColorStateList: ColorStateList?, linkColor: Int, textSize: Int, extraSpacing: Float, spacingMultiplier: Float, letterSpacing: Float, verticalGravity: VerticalGravity?, textStyle: Int, typeface: Typeface?, textAlignment: Layout.Alignment?, alignment: TextAlignment?, breakStrategy: Int, hyphenationFrequency: Int, glyphWarming: Boolean, textDirection: TextDirectionHeuristicCompat?, customEllipsisText: CharSequence?, lineHeight: Float, minimallyWide: Boolean, measureLayout: Layout?, measuredWidth: Int?, measuredHeight: Int?, fullWidth: Int?, processedText: Output<CharSequence?>, textLayout: Output<Layout?>, textLayoutTranslationX: Output<Float?>, textLayoutTranslationY: Output<Float?>, clickableSpans: Output<Array<ClickableSpan?>?>, imageSpans: Output<Array<ImageSpan?>?>, isExplicitlyTruncated: Output<Boolean>)

onCreateMountContent

fun onCreateMountContent(c: Context?): TextDrawable

onLoadStyle

fun onLoadStyle(c: ComponentContext, ellipsize: Output<TextUtils.TruncateAt>?, extraSpacing: Output<Float>?, shouldIncludeFontPadding: Output<Boolean>?, spacingMultiplier: Output<Float>?, minLines: Output<Int>?, maxLines: Output<Int>?, minEms: Output<Int>?, maxEms: Output<Int>?, minTextWidth: Output<Int>?, maxTextWidth: Output<Int>?, isSingleLine: Output<Boolean>?, text: Output<CharSequence>?, textColorStateList: Output<ColorStateList>?, linkColor: Output<Int>?, highlightColor: Output<Int>?, textSize: Output<Int>?, alignment: Output<TextAlignment>?, breakStrategy: Output<Int>?, hyphenationFrequency: Output<Int>?, justificationMode: Output<Int>?, textStyle: Output<Int>?, shadowRadius: Output<Float>?, shadowDx: Output<Float>?, shadowDy: Output<Float>?, shadowColor: Output<Int>?, verticalGravity: Output<VerticalGravity>?, typeface: Output<Typeface>?)

onMeasure

fun onMeasure(context: ComponentContext, layout: ComponentLayout, widthSpec: Int, heightSpec: Int, size: Size, text: CharSequence?, ellipsize: TextUtils.TruncateAt?, shouldIncludeFontPadding: Boolean, minLines: Int, maxLines: Int, minEms: Int, maxEms: Int, minTextWidth: Int, maxTextWidth: Int, shadowRadius: Float, shadowDx: Float, shadowDy: Float, shadowColor: Int, isSingleLine: Boolean, textColor: Int, textColorStateList: ColorStateList?, linkColor: Int, textSize: Int, extraSpacing: Float, spacingMultiplier: Float, letterSpacing: Float, textStyle: Int, typeface: Typeface?, textAlignment: Layout.Alignment?, alignment: TextAlignment?, breakStrategy: Int, hyphenationFrequency: Int, justificationMode: Int, glyphWarming: Boolean, textDirection: TextDirectionHeuristicCompat?, minimallyWide: Boolean, minimallyWideThreshold: Int, lineHeight: Float, measureLayout: Output<Layout?>, measuredWidth: Output<Int?>, measuredHeight: Output<Int?>, fullWidth: Output<Int?>)

onMeasureIntrinsicHeight

fun onMeasureIntrinsicHeight(c: ComponentContext, layout: ComponentLayout, widthSpec: Int, heightSpec: Int, text: CharSequence?, ellipsize: TextUtils.TruncateAt?, shouldIncludeFontPadding: Boolean, maxLines: Int, minEms: Int, maxEms: Int, minTextWidth: Int, maxTextWidth: Int, shadowRadius: Float, shadowDx: Float, shadowDy: Float, shadowColor: Int, isSingleLine: Boolean, textColor: Int, textColorStateList: ColorStateList?, linkColor: Int, textSize: Int, extraSpacing: Float, spacingMultiplier: Float, letterSpacing: Float, textStyle: Int, typeface: Typeface?, textAlignment: Layout.Alignment?, alignment: TextAlignment?, breakStrategy: Int, hyphenationFrequency: Int, justificationMode: Int, textDirection: TextDirectionHeuristicCompat?, lineHeight: Float): Int

Min-content height: the natural single-line height (measured unbounded).

onMeasureIntrinsicWidth

fun onMeasureIntrinsicWidth(c: ComponentContext, layout: ComponentLayout, widthSpec: Int, heightSpec: Int, text: CharSequence?, ellipsize: TextUtils.TruncateAt?, shouldIncludeFontPadding: Boolean, maxLines: Int, minEms: Int, maxEms: Int, minTextWidth: Int, maxTextWidth: Int, shadowRadius: Float, shadowDx: Float, shadowDy: Float, shadowColor: Int, isSingleLine: Boolean, textColor: Int, textColorStateList: ColorStateList?, linkColor: Int, textSize: Int, extraSpacing: Float, spacingMultiplier: Float, letterSpacing: Float, textStyle: Int, typeface: Typeface?, textAlignment: Layout.Alignment?, alignment: TextAlignment?, breakStrategy: Int, hyphenationFrequency: Int, justificationMode: Int, textDirection: TextDirectionHeuristicCompat?, lineHeight: Float): Int

Min-content width: the longest-word width (measured unbounded).

onMount

fun onMount(c: ComponentContext, textDrawable: TextDrawable, text: CharSequence?, textColor: Int, highlightColor: Int, outlineWidth: Float, outlineColor: Int, textColorStateList: ColorStateList?, textOffsetOnTouchHandler: EventHandler<*>?, highlightStartOffset: Int, highlightEndOffset: Int, clickableSpanExpandedOffset: Float, clipToBounds: Boolean, spanListener: ClickableSpanListener?, touchableSpanListener: TouchableSpanListener?, processedText: CharSequence?, textLayout: Layout?, textLayoutTranslationX: Float?, textLayoutTranslationY: Float?, clickableSpans: Array<ClickableSpan?>?, imageSpans: Array<ImageSpan?>?, isExplicitlyTruncated: Boolean)

onPerformActionForVirtualView

fun onPerformActionForVirtualView(c: ComponentContext?, host: View?, accessibilityNode: AccessibilityNodeInfoCompat?, virtualViewId: Int, action: Int, arguments: Bundle?, clickableSpans: Array<ClickableSpan>): Boolean

onPopulateAccessibilityNode

fun onPopulateAccessibilityNode(c: ComponentContext?, host: View?, node: AccessibilityNodeInfoCompat, text: CharSequence?, isSingleLine: Boolean)

onPopulateExtraAccessibilityNode

fun onPopulateExtraAccessibilityNode(c: ComponentContext?, node: AccessibilityNodeInfoCompat, extraNodeIndex: Int, componentBoundsLeft: Int, componentBoundsTop: Int, text: CharSequence?, textLayout: Layout, clickableSpans: Array<ClickableSpan?>)

onUnmount

fun onUnmount(c: ComponentContext?, textDrawable: TextDrawable, text: CharSequence?)

onVirtualViewKeyboardFocusChanged

fun onVirtualViewKeyboardFocusChanged(c: ComponentContext?, host: View, accessibilityNode: AccessibilityNodeInfoCompat?, virtualViewId: Int, hasFocus: Boolean, clickableSpans: Array<ClickableSpan?>)

resolveWidth

@VisibleForTesting

@JvmStatic

fun resolveWidth(widthSpec: Int, layout: Layout, minimallyWide: Boolean, minimallyWideThreshold: Int): Int

truncateText

@VisibleForTesting

@JvmStatic

fun truncateText(text: CharSequence, customEllipsisText: CharSequence, newLayout: Layout, ellipsisTextLayout: Layout, ellipsizedLineNumber: Int, layoutWidth: Float, isAlignedLeft: Boolean, isRtl: Boolean): CharSequence

Truncates text which is too long and appends the given custom ellipsis CharSequence to the end of the visible text.