core/androidx.core.text/PrecomputedTextCompat

PrecomputedTextCompat

open class PrecomputedTextCompat : Spannable(source)

A text which has the character metrics data. A text object that contains the character metrics data and can be used to improve the performance of text layout operations. When a PrecomputedTextCompat is created with a given CharSequence, it will measure the text metrics during the creation. This PrecomputedText instance can be set on android.widget.TextView or StaticLayout. Since the text layout information will be included in this instance, android.widget.TextView or StaticLayout will not have to recalculate this information. On API 29 or later, there is full PrecomputedText support by framework. From API 21 to API 27, PrecomputedTextCompat relies on internal text layout cache. PrecomputedTextCompat immediately computes the text layout in the constuctor to warm up the internal text layout cache. On API 20 or before, PrecomputedTextCompat does nothing. Note that any android.text.NoCopySpan attached to the original text won't be passed to PrecomputedText.

Types

class Params

The information required for building PrecomputedTextCompat.

Functions

open fun charAt(index: Int): Char

open fun create(@NonNull text: CharSequence, @NonNull params: PrecomputedTextCompat.Params): PrecomputedTextCompat

Create a new PrecomputedText which will pre-compute text measurement and glyph positioning information.

getParagraphCount

@IntRange(from = 0)

open fun getParagraphCount(): Int

Returns the count of paragraphs.

getParagraphEnd

@IntRange(from = 0)

open fun getParagraphEnd(@IntRange(from = 0) paraIndex: Int): Int

Returns the paragraph end offset of the text.

getParagraphStart

@IntRange(from = 0)

open fun getParagraphStart(@IntRange(from = 0) paraIndex: Int): Int

Returns the paragraph start offset of the text.

open fun getParams(): PrecomputedTextCompat.Params

Returns the parameters used to measure this text.

getPrecomputedText

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@RequiresApi(value = 28)

open fun getPrecomputedText(): PrecomputedText

Returns the underlying original text if the text is PrecomputedText.

open fun getSpanEnd(tag: Any): Int

open fun getSpanFlags(tag: Any): Int

open fun <T> getSpans(start: Int, end: Int, type: Class<T>): Array<T>

open fun getSpanStart(tag: Any): Int

open fun getTextFuture(@NonNull charSequence: CharSequence, @NonNull params: PrecomputedTextCompat.Params, @Nullable executor: Executor): Future<PrecomputedTextCompat>

Helper for PrecomputedText that returns a future to be used with setTextFuture.

open fun length(): Int

nextSpanTransition

open fun nextSpanTransition(start: Int, limit: Int, type: Class): Int

open fun removeSpan(what: Any)

open fun setSpan(what: Any, start: Int, end: Int, flags: Int)

open fun subSequence(start: Int, end: Int): CharSequence

open fun toString(): String