# LayoutElementBuilders.Text.Builder

Artifact: [androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout) [View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/LayoutElementBuilders.java+class:androidx.wear.protolayout.LayoutElementBuilders.Text.Builder) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

*** ** * ** ***


```
public final class LayoutElementBuilders.Text.Builder
```

<br />

*** ** * ** ***

Builder for `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#Builder()()` Creates an instance of `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder`. |

| ### Public methods |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#build()()` Builds an instance with values accumulated in this Builder. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setFontStyle(androidx.wear.protolayout.LayoutElementBuilders.FontStyle)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.FontStyle fontStyle)` Sets the style of font to use (size, bold etc). |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setLayoutConstraintsForDynamicText(androidx.wear.protolayout.TypeBuilders.StringLayoutConstraint)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint stringLayoutConstraint )` Sets the bounding constraints for the layout affected by the dynamic value from `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setText(androidx.wear.protolayout.TypeBuilders.StringProp)`}. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setLineHeight(androidx.wear.protolayout.DimensionBuilders.SpProp)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/DimensionBuilders.SpProp lineHeight)` Sets the explicit height between lines of text. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) @https://developer.android.com/reference/androidx/wear/protolayout/expression/ProtoLayoutExperimental https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setMarqueeIterations(int)(@https://developer.android.com/reference/androidx/annotation/IntRange(from = "-1") int marqueeIterations)` Sets the number of times to repeat the Marquee animation. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setMaxLines(int)(@https://developer.android.com/reference/androidx/annotation/IntRange(from = 1) int maxLines)` Sets the maximum number of lines that can be represented by the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setMaxLines(androidx.wear.protolayout.TypeBuilders.Int32Prop)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.Int32Prop maxLines)` Sets the maximum number of lines that can be represented by the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setModifiers(androidx.wear.protolayout.ModifiersBuilders.Modifiers)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/ModifiersBuilders.Modifiers modifiers)` Sets `https://developer.android.com/reference/androidx/wear/protolayout/ModifiersBuilders.Modifiers` for this element. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setMultilineAlignment(int)(int multilineAlignment)` Sets alignment of the text within its bounds. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setMultilineAlignment(androidx.wear.protolayout.LayoutElementBuilders.TextAlignmentProp)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.TextAlignmentProp multilineAlignment )` Sets alignment of the text within its bounds. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setOverflow(int)(int overflow)` Sets how to handle text which overflows the bound of the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setOverflow(androidx.wear.protolayout.LayoutElementBuilders.TextOverflowProp)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.TextOverflowProp overflow)` Sets how to handle text which overflows the bound of the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setText(java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html text)` Sets the static text to render. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 0) https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setText(androidx.wear.protolayout.TypeBuilders.StringProp)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringProp text)` Sets the text to render. |

## Public constructors

### Builder

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
public Builder()
```

Creates an instance of `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder`.

## Public methods

### build

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
public @NonNull LayoutElementBuilders.Text build()
```

Builds an instance with values accumulated in this Builder.

### setFontStyle

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setFontStyle(@NonNull LayoutElementBuilders.FontStyle fontStyle)
```

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

### setLayoutConstraintsForDynamicText

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
public @NonNull LayoutElementBuilders.Text.Builder setLayoutConstraintsForDynamicText(
    @NonNull TypeBuilders.StringLayoutConstraint stringLayoutConstraint
)
```

Sets the bounding constraints for the layout affected by the dynamic value from `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text.Builder#setText(androidx.wear.protolayout.TypeBuilders.StringProp)`}.

### setLineHeight

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setLineHeight(@NonNull DimensionBuilders.SpProp lineHeight)
```

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.

### setMarqueeIterations

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
public @NonNull LayoutElementBuilders.Text.Builder setMarqueeIterations(@IntRange(from = "-1") int marqueeIterations)
```

Sets the number of times to repeat the Marquee animation. Only applies when overflow is TEXT_OVERFLOW_MARQUEE. Set to -1 to repeat indefinitely. Defaults to repeat indefinitely.

### setMaxLines

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
public @NonNull LayoutElementBuilders.Text.Builder setMaxLines(@IntRange(from = 1) int maxLines)
```

Sets the maximum number of lines that can be represented by the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. If not defined, the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element will be treated as a single-line element.

### setMaxLines

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setMaxLines(@NonNull TypeBuilders.Int32Prop maxLines)
```

Sets the maximum number of lines that can be represented by the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. If not defined, the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element will be treated as a single-line element.

### setModifiers

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setModifiers(@NonNull ModifiersBuilders.Modifiers modifiers)
```

Sets `https://developer.android.com/reference/androidx/wear/protolayout/ModifiersBuilders.Modifiers` for this element.

### setMultilineAlignment

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setMultilineAlignment(int multilineAlignment)
```

Sets alignment of the text within its bounds. Note that a `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.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 `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element bounds. If not defined, defaults to TEXT_ALIGN_CENTER.

### setMultilineAlignment

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setMultilineAlignment(
    @NonNull LayoutElementBuilders.TextAlignmentProp multilineAlignment
)
```

Sets alignment of the text within its bounds. Note that a `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.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 `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element bounds. If not defined, defaults to TEXT_ALIGN_CENTER.

### setOverflow

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setOverflow(int overflow)
```

Sets how to handle text which overflows the bound of the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. A `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.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](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setOverflow(@NonNull LayoutElementBuilders.TextOverflowProp overflow)
```

Sets how to handle text which overflows the bound of the `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Text` element. A `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.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](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setText(@NonNull String text)
```

Sets the static text to render.

### setText

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

```
@RequiresSchemaVersion(major = 1, minor = 0)
public @NonNull LayoutElementBuilders.Text.Builder setText(@NonNull TypeBuilders.StringProp text)
```

Sets the text to render.

While this field is statically accessible from 1.0, it's only bindable since version 1.2 and renderers supporting version 1.2 will use the dynamic value (if set).