{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

TextLayoutInput

public final class TextLayoutInput


The data class which holds the set of parameters of the text layout computation.

Summary

Public constructors

TextLayoutInput(
    @NonNull AnnotatedString text,
    @NonNull TextStyle style,
    @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>> placeholders,
    int maxLines,
    boolean softWrap,
    @NonNull TextOverflow overflow,
    @NonNull Density density,
    @NonNull LayoutDirection layoutDirection,
    @NonNull FontFamily.Resolver fontFamilyResolver,
    @NonNull Constraints constraints
)
TextLayoutInput(
    @NonNull AnnotatedString text,
    @NonNull TextStyle style,
    @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>> placeholders,
    int maxLines,
    boolean softWrap,
    @NonNull TextOverflow overflow,
    @NonNull Density density,
    @NonNull LayoutDirection layoutDirection,
    @NonNull Font.ResourceLoader resourceLoader,
    @NonNull Constraints constraints
)

This method is deprecated. Font.ResourceLoader is replaced with FontFamily.Resolver

Public methods

final @NonNull TextLayoutInput
copy(
    @NonNull AnnotatedString text,
    @NonNull TextStyle style,
    @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>> placeholders,
    int maxLines,
    boolean softWrap,
    @NonNull TextOverflow overflow,
    @NonNull Density density,
    @NonNull LayoutDirection layoutDirection,
    @NonNull Font.ResourceLoader resourceLoader,
    @NonNull Constraints constraints
)

This method is deprecated. Font.ResourceLoader is deprecated

boolean
equals(Object other)
final @NonNull Constraints

The minimum width provided while calculating this text layout.

final @NonNull Density

The density param used for computing this text layout.

final @NonNull FontFamily.Resolver

The font resolver used for computing this text layout.

final @NonNull LayoutDirection

The layout direction used for computing this text layout.

final int

The maxLines param used for computing this text layout.

final @NonNull TextOverflow

The overflow param used for computing this text layout

final @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>>

A list of Placeholders inserted into text layout that reserves space to embed icons or custom emojis.

final @NonNull Font.ResourceLoader
final boolean

The maxLines param used for computing this text layout.

final @NonNull TextStyle

The text layout used for computing this text layout.

final @NonNull AnnotatedString

The text used for computing text layout.

int
@NonNull String

Public constructors

TextLayoutInput

public TextLayoutInput(
    @NonNull AnnotatedString text,
    @NonNull TextStyle style,
    @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>> placeholders,
    int maxLines,
    boolean softWrap,
    @NonNull TextOverflow overflow,
    @NonNull Density density,
    @NonNull LayoutDirection layoutDirection,
    @NonNull FontFamily.Resolver fontFamilyResolver,
    @NonNull Constraints constraints
)

TextLayoutInput

public TextLayoutInput(
    @NonNull AnnotatedString text,
    @NonNull TextStyle style,
    @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>> placeholders,
    int maxLines,
    boolean softWrap,
    @NonNull TextOverflow overflow,
    @NonNull Density density,
    @NonNull LayoutDirection layoutDirection,
    @NonNull Font.ResourceLoader resourceLoader,
    @NonNull Constraints constraints
)

Public methods

copy

public final @NonNull TextLayoutInput copy(
    @NonNull AnnotatedString text,
    @NonNull TextStyle style,
    @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>> placeholders,
    int maxLines,
    boolean softWrap,
    @NonNull TextOverflow overflow,
    @NonNull Density density,
    @NonNull LayoutDirection layoutDirection,
    @NonNull Font.ResourceLoader resourceLoader,
    @NonNull Constraints constraints
)

equals

public boolean equals(Object other)

getConstraints

public final @NonNull Constraints getConstraints()

The minimum width provided while calculating this text layout.

getDensity

public final @NonNull Density getDensity()

The density param used for computing this text layout.

getFontFamilyResolver

public final @NonNull FontFamily.Resolver getFontFamilyResolver()

The font resolver used for computing this text layout.

getLayoutDirection

public final @NonNull LayoutDirection getLayoutDirection()

The layout direction used for computing this text layout.

getMaxLines

public final int getMaxLines()

The maxLines param used for computing this text layout.

getOverflow

public final @NonNull TextOverflow getOverflow()

The overflow param used for computing this text layout

getPlaceholders

public final @NonNull List<@NonNull AnnotatedString.Range<@NonNull Placeholder>> getPlaceholders()

A list of Placeholders inserted into text layout that reserves space to embed icons or custom emojis. A list of bounding boxes will be returned in TextLayoutResult.placeholderRects that corresponds to this input.

getResourceLoader

public final @NonNull Font.ResourceLoader getResourceLoader()

getSoftWrap

public final boolean getSoftWrap()

The maxLines param used for computing this text layout.

getStyle

public final @NonNull TextStyle getStyle()

The text layout used for computing this text layout.

getText

public final @NonNull AnnotatedString getText()

The text used for computing text layout.

hashCode

public int hashCode()

toString

public @NonNull String toString()