LayoutElementBuilders

Artifact: androidx.wear.protolayout:protolayout

Added in 1.0.0

Kotlin |Java

public final class LayoutElementBuilders

Builders for composable layout elements that can be combined together to create renderable UI layouts.

Summary

Nested types
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Arc implements LayoutElementBuilders.LayoutElement` An arc container.
`public final class LayoutElementBuilders.Arc.Builder` Builder for `Arc`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.ArcAdapter implements LayoutElementBuilders.ArcLayoutElement` A container that allows a standard `LayoutElement` to be added to an `Arc`.
`public final class LayoutElementBuilders.ArcAdapter.Builder` Builder for `ArcAdapter`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.ArcAnchorTypeProp` An extensible `ArcAnchorType` property.
`public final class LayoutElementBuilders.ArcAnchorTypeProp.Builder` Builder for `ArcAnchorTypeProp`
`@RequiresSchemaVersion(major = 1, minor = 300) public final class LayoutElementBuilders.ArcDirectionProp` An extensible `ArcDirection` property that can be set to any curved element to control the drawing direction.
`public final class LayoutElementBuilders.ArcDirectionProp.Builder` Builder for `ArcDirectionProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public interface LayoutElementBuilders.ArcLayoutElement` Interface defining the root of all elements that can be used in an `Arc`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.ArcLine implements LayoutElementBuilders.ArcLayoutElement` A line that can be used in an `Arc` and renders as a round progress bar.
`public final class LayoutElementBuilders.ArcLine.Builder` Builder for `ArcLine`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.ArcSpacer implements LayoutElementBuilders.ArcLayoutElement` A simple spacer used to provide padding between adjacent elements in an `Arc`.
`public final class LayoutElementBuilders.ArcSpacer.Builder` Builder for `ArcSpacer`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.ArcText implements LayoutElementBuilders.ArcLayoutElement` A text element that can be used in an `Arc`.
`public final class LayoutElementBuilders.ArcText.Builder` Builder for `ArcText`.
`@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.
`public final class LayoutElementBuilders.Box.Builder` Builder for `Box`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.ColorFilter` Filtering parameters used for images.
`public final class LayoutElementBuilders.ColorFilter.Builder` Builder for `ColorFilter`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Column implements LayoutElementBuilders.LayoutElement` A column of elements.
`public final class LayoutElementBuilders.Column.Builder` Builder for `Column`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.ContentScaleModeProp` An extensible `ContentScaleMode` property.
`public final class LayoutElementBuilders.ContentScaleModeProp.Builder` Builder for `ContentScaleModeProp`
`@RequiresSchemaVersion(major = 1, minor = 200) @ExperimentalProtoLayoutExtensionApi public final class LayoutElementBuilders.ExtensionLayoutElement implements LayoutElementBuilders.LayoutElement` A layout element which can be defined by a renderer extension.
`public final class LayoutElementBuilders.ExtensionLayoutElement.Builder` Builder for `ExtensionLayoutElement`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.FontStyle` The styling of a font (e.g. font size, and metrics).
`public final class LayoutElementBuilders.FontStyle.Builder` Builder for `FontStyle`
`public final class LayoutElementBuilders.FontStyles` This class is deprecated. Use `androidx.wear.protolayout.material.Typography` on Material (highly recommended) or make your own .
`@RequiresSchemaVersion(major = 1, minor = 0) @ProtoLayoutExperimental public final class LayoutElementBuilders.FontVariantProp` An extensible `FontVariant` property.
`public final class LayoutElementBuilders.FontVariantProp.Builder` Builder for `FontVariantProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.FontWeightProp` An extensible `FontWeight` property.
`public final class LayoutElementBuilders.FontWeightProp.Builder` Builder for `FontWeightProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.HorizontalAlignmentProp` An extensible `HorizontalAlignment` property.
`public final class LayoutElementBuilders.HorizontalAlignmentProp.Builder` Builder for `HorizontalAlignmentProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Image implements LayoutElementBuilders.LayoutElement` An image.
`public final class LayoutElementBuilders.Image.Builder` Builder for `Image`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Layout` A complete layout.
`public final class LayoutElementBuilders.Layout.Builder` Builder for `Layout`
`@RequiresSchemaVersion(major = 1, minor = 0) public interface LayoutElementBuilders.LayoutElement` Interface defining the root of all layout elements.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Row implements LayoutElementBuilders.LayoutElement` A row of elements.
`public final class LayoutElementBuilders.Row.Builder` Builder for `Row`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Spacer implements LayoutElementBuilders.LayoutElement` A simple spacer, typically used to provide padding between adjacent elements.
`public final class LayoutElementBuilders.Spacer.Builder` Builder for `Spacer`.
`@RequiresSchemaVersion(major = 1, minor = 0) public interface LayoutElementBuilders.Span` Interface defining a single `Span`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.SpanImage implements LayoutElementBuilders.Span` An image which can be added to a `Span`.
`public final class LayoutElementBuilders.SpanImage.Builder` Builder for `SpanImage`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.SpanText implements LayoutElementBuilders.Span` A portion of text which can be added to a `Span`.
`public final class LayoutElementBuilders.SpanText.Builder` Builder for `SpanText`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.SpanVerticalAlignmentProp` An extensible `SpanVerticalAlignment` property.
`public final class LayoutElementBuilders.SpanVerticalAlignmentProp.Builder` Builder for `SpanVerticalAlignmentProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Spannable implements LayoutElementBuilders.LayoutElement` A container of `Span` elements.
`public final class LayoutElementBuilders.Spannable.Builder` Builder for `Spannable`.
`@RequiresSchemaVersion(major = 1, minor = 200) public final class LayoutElementBuilders.StrokeCapProp` An extensible `StrokeCap` property.
`public final class LayoutElementBuilders.StrokeCapProp.Builder` Builder for `StrokeCapProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.Text implements LayoutElementBuilders.LayoutElement` A text string.
`public final class LayoutElementBuilders.Text.Builder` Builder for `Text`.
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.TextAlignmentProp` An extensible `TextAlignment` property.
`public final class LayoutElementBuilders.TextAlignmentProp.Builder` Builder for `TextAlignmentProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.TextOverflowProp` An extensible `TextOverflow` property.
`public final class LayoutElementBuilders.TextOverflowProp.Builder` Builder for `TextOverflowProp`
`@RequiresSchemaVersion(major = 1, minor = 0) public final class LayoutElementBuilders.VerticalAlignmentProp` An extensible `VerticalAlignment` property.
`public final class LayoutElementBuilders.VerticalAlignmentProp.Builder` Builder for `VerticalAlignmentProp`

Constants
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) ANGULAR_ALIGNMENT_CENTER = 2` Align to the center of the container.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) ANGULAR_ALIGNMENT_END = 3` Align to the end of the container.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) ANGULAR_ALIGNMENT_START = 1` Align to the start of the container.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) ANGULAR_ALIGNMENT_UNDEFINED = 0` Angular alignment is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) ARC_ANCHOR_CENTER = 2` Anchor at the center of the elements.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) ARC_ANCHOR_END = 3` Anchor at the end of the elements.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) ARC_ANCHOR_START = 1` Anchor at the start of the elements.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) ARC_ANCHOR_UNDEFINED = 0` Anchor position is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) CONTENT_SCALE_MODE_CROP = 2` Content will be resized proportionally so it completely fills its bounds, and anything outside of the bounds will be cropped.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) CONTENT_SCALE_MODE_FILL_BOUNDS = 3` Content will be resized to fill its bounds, without taking into account the aspect ratio.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) CONTENT_SCALE_MODE_FIT = 1` Content will be scaled to fit inside its bounds, proportionally.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) CONTENT_SCALE_MODE_UNDEFINED = 0` Content scaling is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) FONT_VARIANT_BODY = 2` Font variant suited for body text.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) FONT_VARIANT_TITLE = 1` Font variant suited for title text.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) FONT_VARIANT_UNDEFINED = 0` Font variant is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) FONT_WEIGHT_BOLD = 700` Bold font weight.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) @ProtoLayoutExperimental FONT_WEIGHT_MEDIUM = 500` Medium font weight.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) FONT_WEIGHT_NORMAL = 400` Normal font weight.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) FONT_WEIGHT_UNDEFINED = 0` Font weight is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) HORIZONTAL_ALIGN_CENTER = 2` Horizontally align to center.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) HORIZONTAL_ALIGN_END = 5` Horizontally align to the content end (right in LTR layouts, left in RTL layouts).
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) HORIZONTAL_ALIGN_LEFT = 1` Horizontally align to the left.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) HORIZONTAL_ALIGN_RIGHT = 3` Horizontally align to the right.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) HORIZONTAL_ALIGN_START = 4` Horizontally align to the content start (left in LTR layouts, right in RTL layouts).
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) HORIZONTAL_ALIGN_UNDEFINED = 0` Horizontal alignment is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) SPAN_VERTICAL_ALIGN_BOTTOM = 1` Align to the bottom of the line (descent of the largest text in this line).
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) SPAN_VERTICAL_ALIGN_TEXT_BASELINE = 2` Align to the baseline of the text.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) SPAN_VERTICAL_ALIGN_UNDEFINED = 0` Alignment is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) STROKE_CAP_BUTT = 1` Begin and end contours with a flat edge and no extension.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) STROKE_CAP_ROUND = 2` Begin and end contours with a semi-circle extension.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) STROKE_CAP_SQUARE = 3` Begin and end contours with a half square extension.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) STROKE_CAP_UNDEFINED = 0` `StrokeCap` is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) TEXT_ALIGN_CENTER = 2` Align to the center of the `androidx.wear.protolayout.LayoutElementBuilders.Text` element.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) TEXT_ALIGN_END = 3` Align to the "end" of the `androidx.wear.protolayout.LayoutElementBuilders.Text` element (right in LTR layouts, left in RTL layouts).
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) TEXT_ALIGN_START = 1` Align to the "start" of the `androidx.wear.protolayout.LayoutElementBuilders.Text` element (left in LTR layouts, right in RTL layouts).
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) TEXT_ALIGN_UNDEFINED = 0` Alignment is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 300) TEXT_OVERFLOW_ELLIPSIZE = 4` Truncate the text to fit in the `Text` element's parent bounds, but add an ellipsis (i.e. ...) to the end of the text if it has been truncated.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) TEXT_OVERFLOW_ELLIPSIZE_END = 2` This field is deprecated. Use `TEXT_OVERFLOW_ELLIPSIZE` instead.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental TEXT_OVERFLOW_MARQUEE = 3` Enable marquee animation for texts that don't fit inside the `Text` element.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) TEXT_OVERFLOW_TRUNCATE = 1` Truncate the text to fit inside of the `Text` element's bounds.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) TEXT_OVERFLOW_UNDEFINED = 0` Overflow behavior is undefined.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) VERTICAL_ALIGN_BOTTOM = 3` Vertically align to the bottom.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) VERTICAL_ALIGN_CENTER = 2` Vertically align to center.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) VERTICAL_ALIGN_TOP = 1` Vertically align to the top.
`static final int`	`@RequiresSchemaVersion(major = 1, minor = 0) VERTICAL_ALIGN_UNDEFINED = 0` Vertical alignment is undefined.

Constants

ANGULAR_ALIGNMENT_CENTER

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int ANGULAR_ALIGNMENT_CENTER = 2

Align to the center of the container. As an example, if the container starts at 90 degrees, and has 180 degrees of sweep, and the contained element has 90 degrees of sweep, the element would draw between 135 and 225 degrees.

ANGULAR_ALIGNMENT_END

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int ANGULAR_ALIGNMENT_END = 3

Align to the end of the container. As an example, if the container starts at 90 degrees and has 180 degrees of sweep, and the contained element has 90 degrees of sweep, the element would draw between 180 and 270 degrees.

ANGULAR_ALIGNMENT_START

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int ANGULAR_ALIGNMENT_START = 1

Align to the start of the container. As an example, if the container starts at 90 degrees and has 180 degrees of sweep, the element within would draw from 90 degrees, clockwise.

ANGULAR_ALIGNMENT_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int ANGULAR_ALIGNMENT_UNDEFINED = 0

Angular alignment is undefined.

ARC_ANCHOR_CENTER

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int ARC_ANCHOR_CENTER = 2

Anchor at the center of the elements. This will cause the center of the whole set of elements added to an arc to be pinned at the given anchor_angle.

ARC_ANCHOR_END

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int ARC_ANCHOR_END = 3

Anchor at the end of the elements. This will cause the set of elements inside the arc to end at the specified anchor_angle, i.e. all elements should be to the left of anchor_angle.

ARC_ANCHOR_START

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int ARC_ANCHOR_START = 1

Anchor at the start of the elements. This will cause elements added to an arc to begin at the given anchor_angle, and sweep around to the right.

ARC_ANCHOR_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int ARC_ANCHOR_UNDEFINED = 0

Anchor position is undefined.

CONTENT_SCALE_MODE_CROP

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int CONTENT_SCALE_MODE_CROP = 2

Content will be resized proportionally so it completely fills its bounds, and anything outside of the bounds will be cropped. As an example, if a 10x5 image was going to be drawn inside a 50x50 Image element, the image resource would be drawn as a 100x50 image, centered within its bounds (and with 25px cropped from both the left and right sides).

CONTENT_SCALE_MODE_FILL_BOUNDS

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int CONTENT_SCALE_MODE_FILL_BOUNDS = 3

Content will be resized to fill its bounds, without taking into account the aspect ratio. If a 10x5 image was going to be drawn inside a 50x50 Image element, the image would be drawn as a 50x50 image, stretched vertically.

CONTENT_SCALE_MODE_FIT

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int CONTENT_SCALE_MODE_FIT = 1

Content will be scaled to fit inside its bounds, proportionally. As an example, If a 10x5 image was going to be drawn inside a 50x50 Image element, the actual image resource would be drawn as a 50x25 image, centered within the 50x50 bounds.

CONTENT_SCALE_MODE_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int CONTENT_SCALE_MODE_UNDEFINED = 0

Content scaling is undefined.

FONT_VARIANT_BODY

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int FONT_VARIANT_BODY = 2

Font variant suited for body text.

FONT_VARIANT_TITLE

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int FONT_VARIANT_TITLE = 1

Font variant suited for title text.

FONT_VARIANT_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int FONT_VARIANT_UNDEFINED = 0

Font variant is undefined.

FONT_WEIGHT_BOLD

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int FONT_WEIGHT_BOLD = 700

Bold font weight.

FONT_WEIGHT_MEDIUM

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
@ProtoLayoutExperimental
public static final int FONT_WEIGHT_MEDIUM = 500

Medium font weight.

FONT_WEIGHT_NORMAL

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int FONT_WEIGHT_NORMAL = 400

Normal font weight.

FONT_WEIGHT_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int FONT_WEIGHT_UNDEFINED = 0

Font weight is undefined.

HORIZONTAL_ALIGN_CENTER

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int HORIZONTAL_ALIGN_CENTER = 2

Horizontally align to center.

HORIZONTAL_ALIGN_END

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int HORIZONTAL_ALIGN_END = 5

Horizontally align to the content end (right in LTR layouts, left in RTL layouts).

HORIZONTAL_ALIGN_LEFT

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int HORIZONTAL_ALIGN_LEFT = 1

Horizontally align to the left.

HORIZONTAL_ALIGN_RIGHT

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int HORIZONTAL_ALIGN_RIGHT = 3

Horizontally align to the right.

HORIZONTAL_ALIGN_START

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int HORIZONTAL_ALIGN_START = 4

Horizontally align to the content start (left in LTR layouts, right in RTL layouts).

HORIZONTAL_ALIGN_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int HORIZONTAL_ALIGN_UNDEFINED = 0

Horizontal alignment is undefined.

SPAN_VERTICAL_ALIGN_BOTTOM

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int SPAN_VERTICAL_ALIGN_BOTTOM = 1

Align to the bottom of the line (descent of the largest text in this line). If there is no text in the line containing this image, this will align to the bottom of the line, where the line height is defined as the height of the largest image in the line.

SPAN_VERTICAL_ALIGN_TEXT_BASELINE

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int SPAN_VERTICAL_ALIGN_TEXT_BASELINE = 2

Align to the baseline of the text. Note that if the line in the Spannable which contains this image does not contain any text, the effects of using this alignment are undefined.

SPAN_VERTICAL_ALIGN_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int SPAN_VERTICAL_ALIGN_UNDEFINED = 0

Alignment is undefined.

STROKE_CAP_BUTT

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int STROKE_CAP_BUTT = 1

Begin and end contours with a flat edge and no extension.

STROKE_CAP_ROUND

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int STROKE_CAP_ROUND = 2

Begin and end contours with a semi-circle extension. The extension size is proportional to the thickness of the path.

STROKE_CAP_SQUARE

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int STROKE_CAP_SQUARE = 3

Begin and end contours with a half square extension. The extension size is proportional to the thickness of the path.

STROKE_CAP_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
public static final int STROKE_CAP_UNDEFINED = 0

StrokeCap is undefined.

TEXT_ALIGN_CENTER

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int TEXT_ALIGN_CENTER = 2

Align to the center of the androidx.wear.protolayout.LayoutElementBuilders.Text element.

TEXT_ALIGN_END

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int TEXT_ALIGN_END = 3

Align to the "end" of the androidx.wear.protolayout.LayoutElementBuilders.Text element (right in LTR layouts, left in RTL layouts).

TEXT_ALIGN_START

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int TEXT_ALIGN_START = 1

Align to the "start" of the androidx.wear.protolayout.LayoutElementBuilders.Text element (left in LTR layouts, right in RTL layouts).

TEXT_ALIGN_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int TEXT_ALIGN_UNDEFINED = 0

Alignment is undefined.

TEXT_OVERFLOW_ELLIPSIZE

Added in 1.1.0

@RequiresSchemaVersion(major = 1, minor = 300)
public static final int TEXT_OVERFLOW_ELLIPSIZE = 4

Truncate the text to fit in the Text element's parent bounds, but add an ellipsis (i.e. ...) to the end of the text if it has been truncated.

Note that, when this is used, the parent of the Text element this corresponds to shouldn't have its width and height set to wrapped, as it can lead to unexpected results.

TEXT_OVERFLOW_ELLIPSIZE_END

Added in 1.0.0

Deprecated in 1.1.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int TEXT_OVERFLOW_ELLIPSIZE_END = 2

Truncate the text at the last line defined by setMaxLines in Text to fit in the Text element's bounds, but add an ellipsis (i.e. ...) to the end of the text if it has been truncated. Note that this will not add an ellipsis if the number of lines that fits into the available space is less than the setMaxLines in Text.

TEXT_OVERFLOW_MARQUEE

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
public static final int TEXT_OVERFLOW_MARQUEE = 3

Enable marquee animation for texts that don't fit inside the Text element. This is only applicable for single line texts; if the text has multiple lines, the behavior is equivalent to TEXT_OVERFLOW_TRUNCATE.

TEXT_OVERFLOW_TRUNCATE

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int TEXT_OVERFLOW_TRUNCATE = 1

Truncate the text to fit inside of the Text element's bounds. If text is truncated, it will be truncated on a word boundary.

TEXT_OVERFLOW_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int TEXT_OVERFLOW_UNDEFINED = 0

Overflow behavior is undefined.

VERTICAL_ALIGN_BOTTOM

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int VERTICAL_ALIGN_BOTTOM = 3

Vertically align to the bottom.

VERTICAL_ALIGN_CENTER

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int VERTICAL_ALIGN_CENTER = 2

Vertically align to center.

VERTICAL_ALIGN_TOP

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int VERTICAL_ALIGN_TOP = 1

Vertically align to the top.

VERTICAL_ALIGN_UNDEFINED

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 0)
public static final int VERTICAL_ALIGN_UNDEFINED = 0

Vertical alignment is undefined.

LayoutElementBuilders

Summary

Nested types

Constants

Constants

ANGULAR_ALIGNMENT_CENTER

ANGULAR_ALIGNMENT_END

ANGULAR_ALIGNMENT_START

ANGULAR_ALIGNMENT_UNDEFINED

ARC_ANCHOR_CENTER

ARC_ANCHOR_END

ARC_ANCHOR_START

ARC_ANCHOR_UNDEFINED

CONTENT_SCALE_MODE_CROP

CONTENT_SCALE_MODE_FILL_BOUNDS

CONTENT_SCALE_MODE_FIT

CONTENT_SCALE_MODE_UNDEFINED

FONT_VARIANT_BODY

FONT_VARIANT_TITLE

FONT_VARIANT_UNDEFINED

FONT_WEIGHT_BOLD

FONT_WEIGHT_MEDIUM

FONT_WEIGHT_NORMAL

FONT_WEIGHT_UNDEFINED

HORIZONTAL_ALIGN_CENTER

HORIZONTAL_ALIGN_END

HORIZONTAL_ALIGN_LEFT

HORIZONTAL_ALIGN_RIGHT

HORIZONTAL_ALIGN_START

HORIZONTAL_ALIGN_UNDEFINED

SPAN_VERTICAL_ALIGN_BOTTOM

SPAN_VERTICAL_ALIGN_TEXT_BASELINE

SPAN_VERTICAL_ALIGN_UNDEFINED

STROKE_CAP_BUTT

STROKE_CAP_ROUND

STROKE_CAP_SQUARE

STROKE_CAP_UNDEFINED

TEXT_ALIGN_CENTER

TEXT_ALIGN_END

TEXT_ALIGN_START

TEXT_ALIGN_UNDEFINED

TEXT_OVERFLOW_ELLIPSIZE

TEXT_OVERFLOW_ELLIPSIZE_END

TEXT_OVERFLOW_MARQUEE

TEXT_OVERFLOW_TRUNCATE

TEXT_OVERFLOW_UNDEFINED

VERTICAL_ALIGN_BOTTOM

VERTICAL_ALIGN_CENTER

VERTICAL_ALIGN_TOP

VERTICAL_ALIGN_UNDEFINED