# LayoutStringUtil

Added in 1.3.0

*** ** * ** ***


```
public final class LayoutStringUtil
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutStringUtil#(kotlin.String).asLayoutConstraint(kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html receiver, int alignment)` Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` from a String. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` | `https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutStringUtil#(kotlin.String).createLayoutString()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html receiver)` Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` from a String. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 600) https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutStringUtil#(androidx.wear.protolayout.expression.DynamicBuilders.DynamicString).createLayoutString(kotlin.String)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html staticValue )` Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutStringUtil#(androidx.wear.protolayout.expression.DynamicBuilders.DynamicString).createLayoutString(kotlin.String,androidx.wear.protolayout.TypeBuilders.StringLayoutConstraint)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html staticValue, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint layoutConstraint )` Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` | `@https://developer.android.com/reference/androidx/wear/protolayout/expression/RequiresSchemaVersion(major = 1, minor = 200) https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutStringUtil#stringLayoutConstraint(kotlin.String,kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html longestPattern, int alignment)` Specifies layout constraints for to use for layout measurement in presence of dynamic values. |

## Public methods

### asLayoutConstraint

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/types/LayoutString.kt+function:asLayoutConstraint) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
public static final @NonNull TypeBuilders.StringLayoutConstraint asLayoutConstraint(@NonNull String receiver, int alignment)
```

Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint` from a String. `this` will be used as `longestPattern`.

| Parameters |
|---|---|
| `int alignment` | the alignment of the actual text within the space reserved by `longestPattern` |

### createLayoutString

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/types/LayoutString.kt+symbol:layoutString) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
public static final @NonNull LayoutString createLayoutString(@NonNull String receiver)
```

Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` from a String.

### createLayoutString

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/types/LayoutString.kt+function:asLayoutString) Added in [1.4.2](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.4.2)

```
@RequiresSchemaVersion(major = 1, minor = 600)
public static final @NonNull LayoutString createLayoutString(
    @NonNull DynamicBuilders.DynamicString receiver,
    @NonNull String staticValue
)
```

Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html staticValue` | the static value that can be used when the `dynamicValue` can't be resolved. |

### createLayoutString

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/types/LayoutString.kt+function:asLayoutString) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
public static final @NonNull LayoutString createLayoutString(
    @NonNull DynamicBuilders.DynamicString receiver,
    @NonNull String staticValue,
    @NonNull TypeBuilders.StringLayoutConstraint layoutConstraint
)
```

Extension for creating a `https://developer.android.com/reference/androidx/wear/protolayout/types/LayoutString` from a `https://developer.android.com/reference/androidx/wear/protolayout/expression/DynamicBuilders.DynamicString`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html staticValue` | the static value that can be used when the `dynamicValue` can't be resolved. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringLayoutConstraint layoutConstraint` | used to correctly measure layout Text element size and align text to ensure that the layout is of a known size during the layout pass regardless of the `dynamicValue` String. |

### stringLayoutConstraint

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/types/LayoutString.kt+function:stringLayoutConstraint) Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.3.0)

```
@RequiresSchemaVersion(major = 1, minor = 200)
public static final @NonNull TypeBuilders.StringLayoutConstraint stringLayoutConstraint(@NonNull String longestPattern, int alignment)
```

Specifies layout constraints for to use for layout measurement in presence of dynamic values.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html longestPattern` | the text string to use as the pattern for the (graphically) longest text that can be laid out. Used to ensure that the layout is of a known size during the layout pass. |
| `int alignment` | the alignment of the actual text within the space reserved by `longestPattern` |