LayoutElementBuilders.Text

Added in 1.0.0
Deprecated in 1.2.0

class LayoutElementBuilders.Text : LayoutElementBuilders.LayoutElement


A text string.

Summary

Public functions

LayoutElementBuilders.FontStyle?

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

DimensionBuilders.SpProp?

Gets the explicit height between lines of text.

TypeBuilders.Int32Prop?

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

ModifiersBuilders.Modifiers?

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

LayoutElementBuilders.TextAlignmentProp?

Gets alignment of the text within its bounds.

LayoutElementBuilders.TextOverflowProp?

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

TypeBuilders.StringProp?

Gets the text to render.

Public functions

getFontStyle

Added in 1.0.0
Deprecated in 1.2.0
fun getFontStyle(): LayoutElementBuilders.FontStyle?

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

Added in 1.0.0
Deprecated in 1.2.0
fun getLineHeight(): DimensionBuilders.SpProp?

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

Added in 1.0.0
Deprecated in 1.2.0
fun getMaxLines(): TypeBuilders.Int32Prop?

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

Added in 1.0.0
Deprecated in 1.2.0
fun getModifiers(): ModifiersBuilders.Modifiers?

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

getMultilineAlignment

Added in 1.0.0
Deprecated in 1.2.0
fun getMultilineAlignment(): LayoutElementBuilders.TextAlignmentProp?

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

Added in 1.0.0
Deprecated in 1.2.0
fun getOverflow(): LayoutElementBuilders.TextOverflowProp?

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

Added in 1.0.0
Deprecated in 1.2.0
fun getText(): TypeBuilders.StringProp?

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