ModifiersBuilders.Background

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

@RequiresSchemaVersion(major = 1, minor = 0)
public final class ModifiersBuilders.Background

---

A modifier to apply a background to an element.

Summary

Nested types
public final class ModifiersBuilders.Background.Builder Builder for Background

Public methods
@Nullable ColorBuilders.ColorProp	getColor() Gets the background color for this element.
@Nullable ModifiersBuilders.Corner	getCorner() Gets the corner properties of this element.
@NonNull String	toString()

Public methods

getColor

Added in 1.0.0

public @Nullable ColorBuilders.ColorProp getColor()

Gets the background color for this element. If not defined, defaults to being transparent.

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).

getCorner

Added in 1.0.0

public @Nullable ModifiersBuilders.Corner getCorner()

Gets the corner properties of this element. This only affects the drawing of this element if it has a background color or border. If not defined, defaults to having a square corner.

toString

public @NonNull String toString()