LayoutString

Artifact: androidx.wear.protolayout:protolayout

Added in 1.3.0

Kotlin |Java

class LayoutString

Static or dynamic string value for layout fields.

This can be used on layout string fields with data binding support.

Summary

Public constructors
`LayoutString(staticValue: String)` Creates an instance for a static String value.
`@RequiresSchemaVersion(major = 1, minor = 600) LayoutString( staticValue: String, dynamicValue: DynamicBuilders.DynamicString )` Creates an instance for a `DynamicString` value with a static value fallback.
`@RequiresSchemaVersion(major = 1, minor = 200) LayoutString( staticValue: String, dynamicValue: DynamicBuilders.DynamicString, layoutConstraint: TypeBuilders.StringLayoutConstraint )` Creates an instance for a `DynamicString` value with a static value fallback and a set of layout constraints for the dynamic value.

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`DynamicBuilders.DynamicString?`	`dynamicValue` The dynamic value.
`TypeBuilders.StringLayoutConstraint?`	`layoutConstraint` When `dynamicValue` is used, `layoutConstraint` ensures that the text element has a known fixed size during the layout pass, independently of the actual `dynamicValue` String.
`String`	`staticValue` The static value.

Public constructors

LayoutString

Added in 1.3.0

LayoutString(staticValue: String)

Creates an instance for a static String value.

LayoutString

Added in 1.4.0-alpha03

@RequiresSchemaVersion(major = 1, minor = 600)
LayoutString(
    staticValue: String,
    dynamicValue: DynamicBuilders.DynamicString
)

Creates an instance for a DynamicString value with a static value fallback. The text element will size itself to the content of the dynamicValue, as no layoutConstraint is specified.

Parameters
`staticValue: String`	the static value that can be used when the `dynamicValue` can't be resolved.
`dynamicValue: DynamicBuilders.DynamicString`	the dynamic value. If this value can be resolved, the `staticValue` won't be used.

LayoutString

Added in 1.3.0

@RequiresSchemaVersion(major = 1, minor = 200)
LayoutString(
    staticValue: String,
    dynamicValue: DynamicBuilders.DynamicString,
    layoutConstraint: TypeBuilders.StringLayoutConstraint
)

Creates an instance for a DynamicString value with a static value fallback and a set of layout constraints for the dynamic value.

Parameters
`staticValue: String`	the static value that can be used when the `dynamicValue` can't be resolved.
`dynamicValue: DynamicBuilders.DynamicString`	the dynamic value. If this value can be resolved, the `staticValue` won't be used.
`layoutConstraint: TypeBuilders.StringLayoutConstraint`	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.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

dynamicValue

Added in 1.3.0

val dynamicValue: DynamicBuilders.DynamicString?

The dynamic value. If this can't be resolved staticValue will be used during rendering.

layoutConstraint

Added in 1.3.0

val layoutConstraint: TypeBuilders.StringLayoutConstraint?

When dynamicValue is used, layoutConstraint ensures that the text element has a known fixed size during the layout pass, independently of the actual dynamicValue String. If not set, the text element will size itself to the content of the dynamicValue.

staticValue

Added in 1.3.0

val staticValue: String

The static value. If dynamicValue is not null this will be used as the default value for when dynamicValue can't be resolved.