MultiParagraph

class MultiParagraph(
    val intrinsics: MultiParagraphIntrinsics,
    constraints: Constraints,
    val maxLines: Int = DefaultMaxLines,
    overflow: TextOverflow = TextOverflow.Clip,
)

Lays out and renders multiple paragraphs at once. Unlike Paragraph, supports multiple ParagraphStyles in a given text.

Parameters

Secondary Constructors

constructor(
    intrinsics: MultiParagraphIntrinsics,
    constraints: Constraints,
    maxLines: Int = DefaultMaxLines,
    ellipsis: Boolean = false,
) : this(
    intrinsics = intrinsics,
    constraints = constraints,
    maxLines = maxLines,
    overflow = if (ellipsis) TextOverflow.Ellipsis else TextOverflow.Clip,
)

Lays out and renders multiple paragraphs at once. Unlike Paragraph, supports multiple ParagraphStyles in a given text.

Parameters

constructor(
    intrinsics: MultiParagraphIntrinsics,
    maxLines: Int = DefaultMaxLines,
    ellipsis: Boolean = false,
    width: Float,
) : this(
    intrinsics,
    Constraints(maxWidth = width.ceilToInt()),
    maxLines,
    if (ellipsis) TextOverflow.Ellipsis else TextOverflow.Clip,
)

Lays out and renders multiple paragraphs at once. Unlike Paragraph, supports multiple ParagraphStyles in a given text.

Parameters

constructor(
    annotatedString: AnnotatedString,
    style: TextStyle,
    placeholders: List<AnnotatedString.Range<Placeholder>> = listOf(),
    maxLines: Int = Int.MAX_VALUE,
    ellipsis: Boolean = false,
    width: Float,
    density: Density,
    resourceLoader: Font.ResourceLoader,
) : this(
    intrinsics =
        MultiParagraphIntrinsics(
            annotatedString = annotatedString,
            style = style,
            placeholders = placeholders,
            density = density,
            fontFamilyResolver = createFontFamilyResolver(resourceLoader),
        ),
    maxLines = maxLines,
    overflow = if (ellipsis) TextOverflow.Ellipsis else TextOverflow.Clip,
    constraints = Constraints(maxWidth = width.ceilToInt()),
)

Lays out a given annotatedString with the given constraints. Unlike a Paragraph, MultiParagraph can handle a text what has multiple paragraph styles.

Parameters

constructor(
    annotatedString: AnnotatedString,
    style: TextStyle,
    width: Float,
    density: Density,
    fontFamilyResolver: FontFamily.Resolver,
    placeholders: List<AnnotatedString.Range<Placeholder>> = listOf(),
    maxLines: Int = Int.MAX_VALUE,
    ellipsis: Boolean = false,
) : this(
    intrinsics =
        MultiParagraphIntrinsics(
            annotatedString = annotatedString,
            style = style,
            placeholders = placeholders,
            density = density,
            fontFamilyResolver = fontFamilyResolver,
        ),
    maxLines = maxLines,
    overflow = if (ellipsis) TextOverflow.Ellipsis else TextOverflow.Clip,
    constraints = Constraints(maxWidth = width.ceilToInt()),
)

Lays out a given annotatedString with the given constraints. Unlike a Paragraph, MultiParagraph can handle a text what has multiple paragraph styles.

Parameters

constructor(
    annotatedString: AnnotatedString,
    style: TextStyle,
    constraints: Constraints,
    density: Density,
    fontFamilyResolver: FontFamily.Resolver,
    placeholders: List<AnnotatedString.Range<Placeholder>> = listOf(),
    maxLines: Int = Int.MAX_VALUE,
    ellipsis: Boolean = false,
) : this(
    intrinsics =
        MultiParagraphIntrinsics(
            annotatedString = annotatedString,
            style = style,
            placeholders = placeholders,
            density = density,
            fontFamilyResolver = fontFamilyResolver,
        ),
    maxLines = maxLines,
    overflow = if (ellipsis) TextOverflow.Ellipsis else TextOverflow.Clip,
    constraints = constraints,
)

Lays out a given annotatedString with the given constraints. Unlike a Paragraph, MultiParagraph can handle a text what has multiple paragraph styles.

Parameters

constructor(
    annotatedString: AnnotatedString,
    style: TextStyle,
    constraints: Constraints,
    density: Density,
    fontFamilyResolver: FontFamily.Resolver,
    placeholders: List<AnnotatedString.Range<Placeholder>> = listOf(),
    maxLines: Int = Int.MAX_VALUE,
    overflow: TextOverflow = TextOverflow.Clip,
) : this(
    intrinsics =
        MultiParagraphIntrinsics(
            annotatedString = annotatedString,
            style = style,
            placeholders = placeholders,
            density = density,
            fontFamilyResolver = fontFamilyResolver,
        ),
    maxLines = maxLines,
    overflow = overflow,
    constraints = constraints,
)

Lays out a given annotatedString with the given constraints. Unlike a Paragraph, MultiParagraph can handle a text what has multiple paragraph styles.

Parameters

Properties

val minIntrinsicWidth: Float

The width for text if all soft wrap opportunities were taken.

val maxIntrinsicWidth: Float

Returns the smallest width beyond which increasing the width never decreases the height.

val didExceedMaxLines: Boolean

True if there is more vertical content, but the text was truncated, either because we reached maxLines lines of text or because the maxLines was null, ellipsis was not null, and one of the lines exceeded the width constraint.

val width: Float

The amount of horizontal space this paragraph occupies.

val height: Float

The amount of vertical space this paragraph occupies.

Valid only after layout has been called.

val firstBaseline: Float

The distance from the top of the paragraph to the alphabetic baseline of the first line, in logical pixels.

val lastBaseline: Float

The distance from the top of the paragraph to the alphabetic baseline of the first line, in logical pixels.

val lineCount: Int

The total number of lines in the text.

val placeholderRects: List<Rect?>

The bounding boxes reserved for the input placeholders in this MultiParagraph. Their locations are relative to this MultiParagraph's coordinate. The order of this list corresponds to that of input placeholders. Notice that Rect in placeholderRects is nullable. When Rect is null, it indicates that the corresponding Placeholder is ellipsized.

Functions

fun paint(
        canvas: Canvas,
        color: Color = Color.Unspecified,
        shadow: Shadow? = null,
        decoration: TextDecoration? = null,
    )

Paint the paragraphs to canvas.

fun paint(
        canvas: Canvas,
        color: Color = Color.Unspecified,
        shadow: Shadow? = null,
        decoration: TextDecoration? = null,
        drawStyle: DrawStyle? = null,
        blendMode: BlendMode = DrawScope.DefaultBlendMode,
    )

Paint the paragraphs to canvas.

fun paint(
        canvas: Canvas,
        brush: Brush,
        alpha: Float = Float.NaN,
        shadow: Shadow? = null,
        decoration: TextDecoration? = null,
        drawStyle: DrawStyle? = null,
        blendMode: BlendMode = DrawScope.DefaultBlendMode,
    )

Paint the paragraphs to canvas.

fun getPathForRange(start: Int, end: Int): Path

Returns path that enclose the given text range.

fun getLineForVerticalPosition(vertical: Float): Int

Returns line number closest to the given graphical vertical position. If you ask for a vertical position before 0, you get 0; if you ask for a vertical position beyond the last line, you get the last line.

fun getOffsetForPosition(position: Offset): Int

Returns the character offset closest to the given graphical position.

fun getRangeForRect(
        rect: Rect,
        granularity: TextGranularity,
        inclusionStrategy: TextInclusionStrategy,
    ): TextRange

Find the range of text which is inside the specified rect. This method will break text into small text segments based on the given granularity such as character or word. It also support different inclusionStrategy, which determines when a small text segments is considered as inside the rect. Note that the word/character breaking is both operating system and language dependent. In the certain cases, the text may be break into smaller segments than the specified the granularity. If a text segment spans multiple lines or multiple directional runs (e.g. a hyphenated word), the text segment is divided into pieces at the line and run breaks, then the text segment is considered to be inside the area if any of its pieces are inside the area.

Parameters

Returns

fun getBoundingBox(offset: Int): Rect

Returns the bounding box as Rect of the character for given character offset. Rect includes the top, bottom, left and right of a character.

fun fillBoundingBoxes(
        range: TextRange,
        array: FloatArray,
        @IntRange(from = 0) arrayStart: Int,
    ): FloatArray

Fills the bounding boxes for characters provided in the range into array. The array is filled starting from arrayStart (inclusive). The coordinates are in local text layout coordinates.

The returned information consists of left/right of a character; line top and bottom for the same character.

For the grapheme consists of multiple code points, e.g. ligatures, combining marks, the first character has the total width and the remaining are returned as zero-width.

The array divided into segments of four where each index in that segment represents left, top, right, bottom of the character.

The size of the provided array should be greater or equal than the four times * TextRange length.

The final order of characters in the array is from TextRange.min to TextRange.max.

Parameters

fun getHorizontalPosition(offset: Int, usePrimaryDirection: Boolean): Float

Compute the horizontal position where a newly inserted character at offset would be.

If the inserted character at offset is within a LTR/RTL run, the returned position will be the left(right) edge of the character.

For example:   Paragraph's direction is LTR.   Text in logic order:               L0 L1 L2 R3 R4 R5   Text in visual order:              L0 L1 L2 R5 R4 R3       position of the offset(2):          |       position of the offset(4):                   |

However, when the offset is at the BiDi transition offset, there will be two possible visual positions, which depends on the direction of the inserted character.

For example:   Paragraph's direction is LTR.   Text in logic order:               L0 L1 L2 R3 R4 R5   Text in visual order:              L0 L1 L2 R5 R4 R3       position of the offset(3):             |           (The inserted character is LTR)                                                       |  (The inserted character is RTL)

In this case, usePrimaryDirection will be used to resolve the ambiguity. If true, the inserted character's direction is assumed to be the same as Paragraph's direction. Otherwise, the inserted character's direction is assumed to be the opposite of the Paragraph's direction.

For example:   Paragraph's direction is LTR.   Text in logic order:               L0 L1 L2 R3 R4 R5   Text in visual order:              L0 L1 L2 R5 R4 R3       position of the offset(3):             |           (usePrimaryDirection is true)                                                       |  (usePrimaryDirection is false)

This method is useful to compute cursor position.

Parameters

Returns

fun getParagraphDirection(offset: Int): ResolvedTextDirection

Get the text direction of the paragraph containing the given offset.

fun getBidiRunDirection(offset: Int): ResolvedTextDirection

Get the text direction of the character at the given offset.

fun getWordBoundary(offset: Int): TextRange

Returns the TextRange of the word at the given character offset. Characters not part of a word, such as spaces, symbols, and punctuation, have word breaks on both sides. In such cases, this method will return TextRange(offset, offset+1). Word boundaries are defined more precisely in Unicode Standard Annex #29 http://www.unicode.org/reports/tr29/#Word_Boundaries

fun getCursorRect(offset: Int): Rect

Returns rectangle of the cursor area.

fun getLineForOffset(offset: Int): Int

Returns the line number on which the specified text offset appears. If you ask for a position before 0, you get 0; if you ask for a position beyond the end of the text, you get the last line.

fun getLineLeft(lineIndex: Int): Float

Returns the left x Coordinate of the given line.

fun getLineRight(lineIndex: Int): Float

Returns the right x Coordinate of the given line.

fun getLineTop(lineIndex: Int): Float

Returns the top y coordinate of the given line.

fun getLineBaseline(lineIndex: Int): Float

Returns the distance from the top of the MultiParagraph to the alphabetic baseline of the given line.

fun getLineBottom(lineIndex: Int): Float

Returns the bottom y coordinate of the given line.

fun getLineHeight(lineIndex: Int): Float

Returns the height of the given line.

fun getLineWidth(lineIndex: Int): Float

Returns the width of the given line.

fun getLineStart(lineIndex: Int): Int

Returns the start offset of the given line, inclusive.

fun getLineEnd(lineIndex: Int, visibleEnd: Boolean = false): Int

Returns the end offset of the given line

Characters being ellipsized are treated as invisible characters. So that if visibleEnd is false, it will return line end including the ellipsized characters and vice verse.

Parameters

Returns

fun isLineEllipsized(lineIndex: Int): Boolean

Returns true if the given line is ellipsized, otherwise returns false.

Parameters

Returns