LayoutElementBuilders.Box

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

@RequiresSchemaVersion(major = 1, minor = 0)
class LayoutElementBuilders.Box : LayoutElementBuilders.LayoutElement

---

A container which stacks all of its children on top of one another. This also allows to add a background color, or to have a border around them with some padding.

Summary

Nested types
class LayoutElementBuilders.Box.Builder Builder for Box.

Public functions
(Mutable)List<LayoutElementBuilders.LayoutElement!>	getContents() Gets the child element(s) to wrap.
DimensionBuilders.ContainerDimension?	getHeight() Gets the height of this Box.
LayoutElementBuilders.HorizontalAlignmentProp?	getHorizontalAlignment() Gets the horizontal alignment of the element inside this Box.
ModifiersBuilders.Modifiers?	getModifiers() Gets androidx.wear.protolayout.ModifiersBuilders.Modifiers for this element.
LayoutElementBuilders.VerticalAlignmentProp?	getVerticalAlignment() Gets the vertical alignment of the element inside this Box.
DimensionBuilders.ContainerDimension?	getWidth() Gets the width of this Box.
String	toString()

Public functions

getContents

Added in 1.0.0

fun getContents(): (Mutable)List<LayoutElementBuilders.LayoutElement!>

Gets the child element(s) to wrap.

getHeight

Added in 1.0.0

fun getHeight(): DimensionBuilders.ContainerDimension?

Gets the height of this Box. If not defined, this will size itself to fit all of its children (i.e. a WrappedDimension).

getHorizontalAlignment

Added in 1.0.0

fun getHorizontalAlignment(): LayoutElementBuilders.HorizontalAlignmentProp?

Gets the horizontal alignment of the element inside this Box. If not defined, defaults to HORIZONTAL_ALIGN_CENTER.

getModifiers

Added in 1.0.0

fun getModifiers(): ModifiersBuilders.Modifiers?

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

getVerticalAlignment

Added in 1.0.0

fun getVerticalAlignment(): LayoutElementBuilders.VerticalAlignmentProp?

Gets the vertical alignment of the element inside this Box. If not defined, defaults to VERTICAL_ALIGN_CENTER.

getWidth

Added in 1.0.0

fun getWidth(): DimensionBuilders.ContainerDimension?

Gets the width of this Box. If not defined, this will size itself to fit all of its children (i.e. a WrappedDimension).

toString

fun toString(): String