LayoutElementBuilders.Column

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

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

---

A column of elements. Each child element will be laid out vertically, one after another (i.e. stacking down). This element will size itself to the smallest size required to hold all of its children (e.g. if it contains three elements sized 10x10, 20x20 and 30x30, the resulting column will be 30x60).

If specified, horizontal_alignment can be used to control the gravity inside the container, affecting the horizontal placement of children whose width are smaller than the resulting column width.

Summary

Nested types
class LayoutElementBuilders.Column.Builder Builder for Column.

Public functions
(Mutable)List<LayoutElementBuilders.LayoutElement!>	getContents() Gets the list of child elements to place inside this Column.
DimensionBuilders.ContainerDimension?	getHeight() Gets the height of this column.
LayoutElementBuilders.HorizontalAlignmentProp?	getHorizontalAlignment() Gets the horizontal alignment of elements inside this column, if they are narrower than the resulting width of the column.
ModifiersBuilders.Modifiers?	getModifiers() Gets androidx.wear.protolayout.ModifiersBuilders.Modifiers for this element.
DimensionBuilders.ContainerDimension?	getWidth() Gets the width of this column.
String	toString()

Public functions

getContents

Added in 1.0.0

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

Gets the list of child elements to place inside this Column.

getHeight

Added in 1.0.0

fun getHeight(): DimensionBuilders.ContainerDimension?

Gets the height of this column. 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 elements inside this column, if they are narrower than the resulting width of the column. 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.

getWidth

Added in 1.0.0

fun getWidth(): DimensionBuilders.ContainerDimension?

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

toString

fun toString(): String