LayoutElementBuilders.Text

public final class LayoutElementBuilders.Text implements LayoutElementBuilders.LayoutElement


A text string.

Summary

Nested types

LayoutElementBuilders.Text.Builder

Builder for Text.

Public methods

static @NonNull LayoutElementBuilders.Text.Builder

Returns a new Builder.

@Nullable LayoutElementBuilders.FontStyle

Gets the style of font to use (size, bold etc).

@Nullable DimensionBuilders.SpProp

Gets the explicit height between lines of text.

@Nullable TypeBuilders.Int32Prop

Gets the maximum number of lines that can be represented by the Text element.

@Nullable ModifiersBuilders.Modifiers

Gets androidx.wear.tiles.ModifiersBuilders.Modifiers for this element.

@Nullable LayoutElementBuilders.TextAlignmentProp

Gets alignment of the text within its bounds.

@Nullable LayoutElementBuilders.TextOverflowProp

Gets how to handle text which overflows the bound of the Text element.

@Nullable TypeBuilders.StringProp

Gets the text to render.

Public methods

builder

@NonNull
public static LayoutElementBuilders.Text.Builder builder()

Returns a new Builder.

getFontStyle

@Nullable
@NonNull
public LayoutElementBuilders.FontStyle getFontStyle()

Gets the style of font to use (size, bold etc). If not specified, defaults to the platform's default body font. Intended for testing purposes only.

getLineHeight

@Nullable
@NonNull
public DimensionBuilders.SpProp getLineHeight()

Gets the explicit height between lines of text. This is equivalent to the vertical distance between subsequent baselines. If not specified, defaults the font's recommended interline spacing. Intended for testing purposes only.

getMaxLines

@Nullable
@NonNull
public TypeBuilders.Int32Prop getMaxLines()

Gets the maximum number of lines that can be represented by the Text element. If not defined, the Text element will be treated as a single-line element. Intended for testing purposes only.

getModifiers

@Nullable
@NonNull
public ModifiersBuilders.Modifiers getModifiers()

Gets androidx.wear.tiles.ModifiersBuilders.Modifiers for this element. Intended for testing purposes only.

getMultilineAlignment

@Nullable
@NonNull
public LayoutElementBuilders.TextAlignmentProp getMultilineAlignment()

Gets alignment of the text within its bounds. Note that a Text element will size itself to wrap its contents, so this option is meaningless for single-line text (for that, use alignment of the outer container). For multi-line text, however, this will set the alignment of lines relative to the Text element bounds. If not defined, defaults to TEXT_ALIGN_CENTER. Intended for testing purposes only.

getOverflow

@Nullable
@NonNull
public LayoutElementBuilders.TextOverflowProp getOverflow()

Gets how to handle text which overflows the bound of the Text element. A element will grow as large as possible inside its parent container (while still respecting max_lines); if it cannot grow large enough to render all of its text, the text which cannot fit inside its container will be truncated. If not defined, defaults to TEXT_OVERFLOW_TRUNCATE. Intended for testing purposes only.

getText

@Nullable
@NonNull
public TypeBuilders.StringProp getText()

Gets the text to render. Intended for testing purposes only.