LayoutElementBuilders.SpanImage.Builder

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

class LayoutElementBuilders.SpanImage.Builder

---

Builder for SpanImage.

Summary

Public constructors
Builder() Creates an instance of Builder.

Public functions
LayoutElementBuilders.SpanImage	build() Builds an instance with values accumulated in this Builder.
LayoutElementBuilders.SpanImage.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setAlignment(alignment: Int) Sets alignment of this image within the line height of the surrounding .
LayoutElementBuilders.SpanImage.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setAlignment(     alignment: LayoutElementBuilders.SpanVerticalAlignmentProp ) Sets alignment of this image within the line height of the surrounding .
LayoutElementBuilders.SpanImage.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setHeight(height: DimensionBuilders.DpProp) Sets the height of this image.
LayoutElementBuilders.SpanImage.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setModifiers(modifiers: ModifiersBuilders.SpanModifiers) Sets androidx.wear.protolayout.ModifiersBuilders.Modifiers for this element.
LayoutElementBuilders.SpanImage.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setResourceId(resourceId: String) Sets the resource_id of the image to render.
LayoutElementBuilders.SpanImage.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setResourceId(resourceId: TypeBuilders.StringProp) Sets the resource_id of the image to render.
LayoutElementBuilders.SpanImage.Builder	@RequiresSchemaVersion(major = 1, minor = 0) setWidth(width: DimensionBuilders.DpProp) Sets the width of this image.

Public constructors

Builder

Added in 1.0.0

Builder()

Creates an instance of Builder.

Public functions

build

Added in 1.0.0

fun build(): LayoutElementBuilders.SpanImage

Builds an instance with values accumulated in this Builder.

setAlignment

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
fun setAlignment(alignment: Int): LayoutElementBuilders.SpanImage.Builder

Sets alignment of this image within the line height of the surrounding . If undefined, defaults to SPAN_VERTICAL_ALIGN_BOTTOM.

setAlignment

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
fun setAlignment(
    alignment: LayoutElementBuilders.SpanVerticalAlignmentProp
): LayoutElementBuilders.SpanImage.Builder

Sets alignment of this image within the line height of the surrounding . If undefined, defaults to SPAN_VERTICAL_ALIGN_BOTTOM.

setHeight

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
fun setHeight(height: DimensionBuilders.DpProp): LayoutElementBuilders.SpanImage.Builder

Sets the height of this image. If not defined, the image will not be rendered.

Note that this field only supports static values.

setModifiers

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
fun setModifiers(modifiers: ModifiersBuilders.SpanModifiers): LayoutElementBuilders.SpanImage.Builder

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

setResourceId

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
fun setResourceId(resourceId: String): LayoutElementBuilders.SpanImage.Builder

Sets the resource_id of the image to render. This must exist in the supplied resource bundle.

setResourceId

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
fun setResourceId(resourceId: TypeBuilders.StringProp): LayoutElementBuilders.SpanImage.Builder

Sets the resource_id of the image to render. This must exist in the supplied resource bundle.

Note that this field only supports static values.

setWidth

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
fun setWidth(width: DimensionBuilders.DpProp): LayoutElementBuilders.SpanImage.Builder

Sets the width of this image. If not defined, the image will not be rendered.

Note that this field only supports static values.