LayoutElementBuilders.Spannable.Builder

Added in 1.0.0
Deprecated in 1.2.0

class LayoutElementBuilders.Spannable.Builder : LayoutElementBuilders.LayoutElement.Builder


Builder for Spannable.

Summary

Public constructors

Public functions

LayoutElementBuilders.Spannable.Builder

Adds one item to the Span elements that form this Spannable.

LayoutElementBuilders.Spannable

Builds an instance with values accumulated in this Builder.

LayoutElementBuilders.Spannable.Builder

Sets the explicit height between lines of text.

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

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

LayoutElementBuilders.Spannable.Builder

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

LayoutElementBuilders.Spannable.Builder

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

LayoutElementBuilders.Spannable.Builder
setMultilineAlignment(multilineAlignment: Int)

Sets alignment of the Spannable content within its bounds.

LayoutElementBuilders.Spannable.Builder

Sets alignment of the Spannable content within its bounds.

LayoutElementBuilders.Spannable.Builder
setOverflow(overflow: Int)

Sets how to handle content which overflows the bound of the Spannable element.

LayoutElementBuilders.Spannable.Builder

Sets how to handle content which overflows the bound of the Spannable element.

Public constructors

Builder

Added in 1.0.0
Deprecated in 1.2.0
Builder()

Public functions

addSpan

Added in 1.0.0
Deprecated in 1.2.0
fun addSpan(span: LayoutElementBuilders.Span): LayoutElementBuilders.Spannable.Builder

Adds one item to the Span elements that form this Spannable.

build

Added in 1.4.0-alpha01
Deprecated in 1.4.0-alpha01
fun build(): LayoutElementBuilders.Spannable

Builds an instance with values accumulated in this Builder.

setLineHeight

Added in 1.0.0
Deprecated in 1.2.0
fun setLineHeight(lineHeight: DimensionBuilders.SpProp): LayoutElementBuilders.Spannable.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.Spannable.Builder

Sets the maximum number of lines that can be represented by the Spannable element. If not defined, the Spannable 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.Spannable.Builder

Sets the maximum number of lines that can be represented by the Spannable element. If not defined, the Spannable 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.Spannable.Builder

Sets alignment of the Spannable content within its bounds. Note that a element will size itself to wrap its contents, so this option is meaningless for single-line content (for that, use alignment of the outer container). For multi-line content, however, this will set the alignment of lines relative to the Spannable 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.HorizontalAlignmentProp
): LayoutElementBuilders.Spannable.Builder

Sets alignment of the Spannable content within its bounds. Note that a element will size itself to wrap its contents, so this option is meaningless for single-line content (for that, use alignment of the outer container). For multi-line content, however, this will set the alignment of lines relative to the Spannable 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.Spannable.Builder

Sets how to handle content which overflows the bound of the Spannable element. A Spannable 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 content, the content 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.Spannable.Builder

Sets how to handle content which overflows the bound of the Spannable element. A Spannable 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 content, the content which cannot fit inside its container will be truncated. If not defined, defaults to TEXT_OVERFLOW_TRUNCATE.