LayoutElementBuilders.Spacer

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

@RequiresSchemaVersion(major = 1, minor = 0)
public final class LayoutElementBuilders.Spacer implements LayoutElementBuilders.LayoutElement

---

A simple spacer, typically used to provide padding between adjacent elements.

Summary

Nested types
public final class LayoutElementBuilders.Spacer.Builder Builder for Spacer.

Public methods
@Nullable DimensionBuilders.SpacerDimension	getHeight() Gets the height of this spacer.
@Nullable DimensionBuilders.VerticalLayoutConstraint	getLayoutConstraintsForDynamicHeight() Gets the bounding constraints for the layout affected by the dynamic value from getHeight.
@Nullable DimensionBuilders.HorizontalLayoutConstraint	getLayoutConstraintsForDynamicWidth() Gets the bounding constraints for the layout affected by the dynamic value from getWidth.
@Nullable ModifiersBuilders.Modifiers	getModifiers() Gets androidx.wear.protolayout.ModifiersBuilders.Modifiers for this element.
@Nullable DimensionBuilders.SpacerDimension	getWidth() Gets the width of this Spacer.
@NonNull String	toString()

Public methods

getHeight

Added in 1.0.0

public @Nullable DimensionBuilders.SpacerDimension getHeight()

Gets the height of this spacer. If not defined, defaults to 0.

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

When using a dynamic value, make sure to specify the bounding constraints for the affected layout element through setLayoutConstraintsForDynamicWidth(HorizontalLayoutConstraint) otherwise build() fails.

getLayoutConstraintsForDynamicHeight

Added in 1.0.0

public @Nullable DimensionBuilders.VerticalLayoutConstraint getLayoutConstraintsForDynamicHeight()

Gets the bounding constraints for the layout affected by the dynamic value from getHeight.

getLayoutConstraintsForDynamicWidth

Added in 1.0.0

public @Nullable DimensionBuilders.HorizontalLayoutConstraint getLayoutConstraintsForDynamicWidth()

Gets the bounding constraints for the layout affected by the dynamic value from getWidth.

getModifiers

Added in 1.0.0

public @Nullable ModifiersBuilders.Modifiers getModifiers()

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

getWidth

Added in 1.0.0

public @Nullable DimensionBuilders.SpacerDimension getWidth()

Gets the width of this Spacer. When this is added as the direct child of an Arc, this must be specified as an angular dimension, otherwise a linear dimension must be used. If not defined, defaults to 0.

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

When using a dynamic value, make sure to specify the bounding constraints for the affected layout element through setLayoutConstraintsForDynamicWidth(HorizontalLayoutConstraint) otherwise build() fails.

toString

public @NonNull String toString()