LayoutElementBuilders.Box

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

@RequiresSchemaVersion(major = 1, minor = 0)
public final class LayoutElementBuilders.Box implements 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
public final class LayoutElementBuilders.Box.Builder Builder for Box.

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

Public methods

getContents

Added in 1.0.0

public @NonNull List<LayoutElementBuilders.LayoutElement> getContents()

Gets the child element(s) to wrap.

getHeight

Added in 1.0.0

public @Nullable DimensionBuilders.ContainerDimension getHeight()

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

public @Nullable LayoutElementBuilders.HorizontalAlignmentProp getHorizontalAlignment()

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

getModifiers

Added in 1.0.0

public @Nullable ModifiersBuilders.Modifiers getModifiers()

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

getVerticalAlignment

Added in 1.0.0

public @Nullable LayoutElementBuilders.VerticalAlignmentProp getVerticalAlignment()

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

getWidth

Added in 1.0.0

public @Nullable DimensionBuilders.ContainerDimension getWidth()

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

toString

public @NonNull String toString()