LayoutElementBuilders

Added in 1.0.0
Deprecated in 1.2.0

public final class LayoutElementBuilders


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

Summary

Nested types

An arc container.

Builder for Arc.

A container that allows a standard LayoutElement to be added to an Arc.

Builder for ArcAdapter.

An extensible ArcAnchorType property.

Builder for ArcAnchorTypeProp

Interface defining the root of all elements that can be used in an Arc.

Builder to create ArcLayoutElement objects.

A line that can be used in an Arc and renders as a round progress bar.

Builder for ArcLine.

A simple spacer used to provide padding between adjacent elements in an Arc.

Builder for ArcSpacer.

A text element that can be used in an Arc.

Builder for ArcText.

A container which stacks all of its children on top of one another.

Builder for Box.

Filtering parameters used for images.

Builder for ColorFilter

A column of elements.

Builder for Column.

An extensible ContentScaleMode property.

Builder for ContentScaleModeProp

The styling of a font (e.g. font size, and metrics).

Builder for FontStyle

Font styles, currently set up to match Wear's font styling.

An extensible FontVariant property.

Builder for FontVariantProp

An extensible FontWeight property.

Builder for FontWeightProp

An extensible HorizontalAlignment property.

Builder for HorizontalAlignmentProp

An image.

Builder for Image.

public final class LayoutElementBuilders.Layout

A complete layout.

Builder for Layout

Interface defining the root of all layout elements.

Builder to create LayoutElement objects.

A row of elements.

Builder for Row.

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

Builder for Spacer.

Interface defining a single Span.

Builder to create Span objects.

An image which can be added to a Span.

Builder for SpanImage.

A portion of text which can be added to a Span.

Builder for SpanText.

An extensible SpanVerticalAlignment property.

Builder for SpanVerticalAlignmentProp

A container of Span elements.

Builder for Spannable.

A text string.

Builder for Text.

An extensible TextAlignment property.

Builder for TextAlignmentProp

An extensible TextOverflow property.

Builder for TextOverflowProp

An extensible VerticalAlignment property.

Builder for VerticalAlignmentProp

Constants

static final int

Anchor at the center of the elements.

static final int

Anchor at the end of the elements.

static final int

Anchor at the start of the elements.

static final int

Anchor position is undefined.

static final int

Content will be resized proportionally so it completely fills its bounds, and anything outside of the bounds will be cropped.

static final int

Content will be resized to fill its bounds, without taking into account the aspect ratio.

static final int

Content will be scaled to fit inside its bounds, proportionally.

static final int

Content scaling is undefined.

static final int

Font variant suited for body text.

static final int

Font variant suited for title text.

static final int

Font variant is undefined.

static final int

Bold font weight.

static final int

Medium font weight.

static final int

Normal font weight.

static final int

Font weight is undefined.

static final int

Horizontally align to center.

static final int

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

static final int

Horizontally align to the left.

static final int

Horizontally align to the right.

static final int

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

static final int

Horizontal alignment is undefined.

static final int

Align to the bottom of the line (descent of the largest text in this line).

static final int

Align to the baseline of the text.

static final int

Alignment is undefined.

static final int

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

static final int

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

static final int

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

static final int

Alignment is undefined.

static final int

Truncate the 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.

static final int

Truncate the text to fit inside of the Text element's bounds.

static final int

Overflow behavior is undefined.

static final int

Vertically align to the bottom.

static final int

Vertically align to center.

static final int

Vertically align to the top.

static final int

Vertical alignment is undefined.

Constants

ARC_ANCHOR_CENTER

Added in 1.0.0
Deprecated in 1.2.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
Deprecated in 1.2.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
Deprecated in 1.2.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
Deprecated in 1.2.0
public static final int ARC_ANCHOR_UNDEFINED = 0

Anchor position is undefined.

CONTENT_SCALE_MODE_CROP

Added in 1.0.0
Deprecated in 1.2.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
Deprecated in 1.2.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
Deprecated in 1.2.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
Deprecated in 1.2.0
public static final int CONTENT_SCALE_MODE_UNDEFINED = 0

Content scaling is undefined.

FONT_VARIANT_BODY

Added in 1.0.0
Deprecated in 1.2.0
public static final int FONT_VARIANT_BODY = 2

Font variant suited for body text.

FONT_VARIANT_TITLE

Added in 1.0.0
Deprecated in 1.2.0
public static final int FONT_VARIANT_TITLE = 1

Font variant suited for title text.

FONT_VARIANT_UNDEFINED

Added in 1.0.0
Deprecated in 1.2.0
public static final int FONT_VARIANT_UNDEFINED = 0

Font variant is undefined.

FONT_WEIGHT_BOLD

Added in 1.0.0
Deprecated in 1.2.0
public static final int FONT_WEIGHT_BOLD = 700

Bold font weight.

FONT_WEIGHT_MEDIUM

Added in 1.0.0
Deprecated in 1.2.0
@TilesExperimental
public static final int FONT_WEIGHT_MEDIUM = 500

Medium font weight.

FONT_WEIGHT_NORMAL

Added in 1.0.0
Deprecated in 1.2.0
public static final int FONT_WEIGHT_NORMAL = 400

Normal font weight.

FONT_WEIGHT_UNDEFINED

Added in 1.0.0
Deprecated in 1.2.0
public static final int FONT_WEIGHT_UNDEFINED = 0

Font weight is undefined.

HORIZONTAL_ALIGN_CENTER

Added in 1.0.0
Deprecated in 1.2.0
public static final int HORIZONTAL_ALIGN_CENTER = 2

Horizontally align to center.

HORIZONTAL_ALIGN_END

Added in 1.0.0
Deprecated in 1.2.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
Deprecated in 1.2.0
public static final int HORIZONTAL_ALIGN_LEFT = 1

Horizontally align to the left.

HORIZONTAL_ALIGN_RIGHT

Added in 1.0.0
Deprecated in 1.2.0
public static final int HORIZONTAL_ALIGN_RIGHT = 3

Horizontally align to the right.

HORIZONTAL_ALIGN_START

Added in 1.0.0
Deprecated in 1.2.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
Deprecated in 1.2.0
public static final int HORIZONTAL_ALIGN_UNDEFINED = 0

Horizontal alignment is undefined.

SPAN_VERTICAL_ALIGN_BOTTOM

Added in 1.0.0
Deprecated in 1.2.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
Deprecated in 1.2.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
Deprecated in 1.2.0
public static final int SPAN_VERTICAL_ALIGN_UNDEFINED = 0

Alignment is undefined.

TEXT_ALIGN_CENTER

Added in 1.0.0
Deprecated in 1.2.0
public static final int TEXT_ALIGN_CENTER = 2

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

TEXT_ALIGN_END

Added in 1.0.0
Deprecated in 1.2.0
public static final int TEXT_ALIGN_END = 3

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

TEXT_ALIGN_START

Added in 1.0.0
Deprecated in 1.2.0
public static final int TEXT_ALIGN_START = 1

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

TEXT_ALIGN_UNDEFINED

Added in 1.0.0
Deprecated in 1.2.0
public static final int TEXT_ALIGN_UNDEFINED = 0

Alignment is undefined.

TEXT_OVERFLOW_ELLIPSIZE_END

Added in 1.0.0
Deprecated in 1.2.0
public static final int TEXT_OVERFLOW_ELLIPSIZE_END = 2

Truncate the 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.

TEXT_OVERFLOW_TRUNCATE

Added in 1.0.0
Deprecated in 1.2.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
Deprecated in 1.2.0
public static final int TEXT_OVERFLOW_UNDEFINED = 0

Overflow behavior is undefined.

VERTICAL_ALIGN_BOTTOM

Added in 1.0.0
Deprecated in 1.2.0
public static final int VERTICAL_ALIGN_BOTTOM = 3

Vertically align to the bottom.

VERTICAL_ALIGN_CENTER

Added in 1.0.0
Deprecated in 1.2.0
public static final int VERTICAL_ALIGN_CENTER = 2

Vertically align to center.

VERTICAL_ALIGN_TOP

Added in 1.0.0
Deprecated in 1.2.0
public static final int VERTICAL_ALIGN_TOP = 1

Vertically align to the top.

VERTICAL_ALIGN_UNDEFINED

Added in 1.0.0
Deprecated in 1.2.0
public static final int VERTICAL_ALIGN_UNDEFINED = 0

Vertical alignment is undefined.