LayoutElementBuilders.Text.Builder

Added in 1.0.0
Deprecated in 1.2.0

class LayoutElementBuilders.Text.Builder : LayoutElementBuilders.LayoutElement.Builder


Builder for Text.

Summary

Public constructors

Public functions

LayoutElementBuilders.Text

Builds an instance with values accumulated in this Builder.

LayoutElementBuilders.Text.Builder

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

LayoutElementBuilders.Text.Builder

Sets the explicit height between lines of text.

LayoutElementBuilders.Text.Builder
setMaxLines(maxLines: @IntRange(from = 1) Int)

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

LayoutElementBuilders.Text.Builder

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

LayoutElementBuilders.Text.Builder

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

LayoutElementBuilders.Text.Builder
setMultilineAlignment(multilineAlignment: Int)

Sets alignment of the text within its bounds.

LayoutElementBuilders.Text.Builder

Sets alignment of the text within its bounds.

LayoutElementBuilders.Text.Builder
setOverflow(overflow: Int)

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

LayoutElementBuilders.Text.Builder

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

LayoutElementBuilders.Text.Builder
setText(text: String)

Sets the text to render.

LayoutElementBuilders.Text.Builder

Sets the text to render.

Public constructors

Builder

Added in 1.0.0
Deprecated in 1.2.0
Builder()

Public functions

build

Added in 1.5.0-alpha03
Deprecated in 1.5.0-alpha03
fun build(): LayoutElementBuilders.Text

Builds an instance with values accumulated in this Builder.

setFontStyle

Added in 1.0.0
Deprecated in 1.2.0
fun setFontStyle(fontStyle: LayoutElementBuilders.FontStyle): LayoutElementBuilders.Text.Builder

Sets the style of font to use (size, bold etc). If not specified, defaults to the platform's default body font.

setLineHeight

Added in 1.0.0
Deprecated in 1.2.0
fun setLineHeight(lineHeight: DimensionBuilders.SpProp): LayoutElementBuilders.Text.Builder

Sets 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.

setMaxLines

Added in 1.0.0
Deprecated in 1.2.0
fun setMaxLines(maxLines: @IntRange(from = 1) Int): LayoutElementBuilders.Text.Builder

Sets 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.

setMaxLines

Added in 1.0.0
Deprecated in 1.2.0
fun setMaxLines(maxLines: TypeBuilders.Int32Prop): LayoutElementBuilders.Text.Builder

Sets 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.

setMultilineAlignment

Added in 1.0.0
Deprecated in 1.2.0
fun setMultilineAlignment(multilineAlignment: Int): LayoutElementBuilders.Text.Builder

Sets 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.

setMultilineAlignment

Added in 1.0.0
Deprecated in 1.2.0
fun setMultilineAlignment(
    multilineAlignment: LayoutElementBuilders.TextAlignmentProp
): LayoutElementBuilders.Text.Builder

Sets 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.

setOverflow

Added in 1.0.0
Deprecated in 1.2.0
fun setOverflow(overflow: Int): LayoutElementBuilders.Text.Builder

Sets how to handle text which overflows the bound of the Text element. A Text 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.

setOverflow

Added in 1.0.0
Deprecated in 1.2.0
fun setOverflow(overflow: LayoutElementBuilders.TextOverflowProp): LayoutElementBuilders.Text.Builder

Sets how to handle text which overflows the bound of the Text element. A Text 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.

setText

Added in 1.0.0
Deprecated in 1.2.0
fun setText(text: String): LayoutElementBuilders.Text.Builder

Sets the text to render.

setText

Added in 1.0.0
Deprecated in 1.2.0
fun setText(text: TypeBuilders.StringProp): LayoutElementBuilders.Text.Builder

Sets the text to render.