androidx.wear.protolayout

Allows creating layouts and expressions that can be rendered or evaluated at a remote host.

Interfaces

ActionBuilders.Action

Interface defining an action that can be used by a layout element.

ActionBuilders.AndroidExtra

Interface defining an item that can be included in the extras of an intent that will be sent to an Android activity.

ColorBuilders.Brush

Interface defining a Brush describes how something is drawn on screen.

DimensionBuilders.ContainerDimension

Interface defining a dimension that can be applied to a container.

DimensionBuilders.ExtensionDimension

Interface defining a dimension that can be applied to a element.

DimensionBuilders.ImageDimension

Interface defining a dimension that can be applied to an image.

DimensionBuilders.PivotDimension

Interface defining a dimension that can be applied to a pivot location for scale and rotate transformations.

DimensionBuilders.SpacerDimension

Interface defining a dimension that can be applied to a spacer.

LayoutElementBuilders.ArcLayoutElement

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

LayoutElementBuilders.LayoutElement

Interface defining the root of all layout elements.

LayoutElementBuilders.Span

Interface defining a single Span.

ModifiersBuilders.SlideBound

Interface defining the boundary that a Slide animation will use for start/end.

TriggerBuilders.Trigger

Interface defining the triggers that can be fired.

Classes

ActionBuilders

Builders for actions that can be performed when a user interacts with layout elements.

ActionBuilders.AndroidActivity

A launch action to send an intent to an Android activity.

ActionBuilders.AndroidActivity.Builder

Builder for AndroidActivity

ActionBuilders.AndroidBooleanExtra

A boolean value that can be added to an Android intent's extras.

ActionBuilders.AndroidBooleanExtra.Builder

Builder for AndroidBooleanExtra.

ActionBuilders.AndroidDoubleExtra

A double value that can be added to an Android intent's extras.

ActionBuilders.AndroidDoubleExtra.Builder

Builder for AndroidDoubleExtra.

ActionBuilders.AndroidIntExtra

An integer value that can be added to an Android intent's extras.

ActionBuilders.AndroidIntExtra.Builder

Builder for AndroidIntExtra.

ActionBuilders.AndroidLongExtra

A long value that can be added to an Android intent's extras.

ActionBuilders.AndroidLongExtra.Builder

Builder for AndroidLongExtra.

ActionBuilders.AndroidStringExtra

A string value that can be added to an Android intent's extras.

ActionBuilders.AndroidStringExtra.Builder

Builder for AndroidStringExtra.

ActionBuilders.LaunchAction

An action used to launch another activity on the system.

ActionBuilders.LaunchAction.Builder

Builder for LaunchAction.

ActionBuilders.LoadAction

An action used to load (or reload) the layout contents.

ActionBuilders.LoadAction.Builder

Builder for LoadAction.

ColorBuilders

Builders for color utilities for layout elements.

ColorBuilders.ColorProp

A property defining a color.

ColorBuilders.ColorProp.Builder

Builder for ColorProp

ColorBuilders.ColorStop

A color and an offset, determining a color position in a gradient.

ColorBuilders.ColorStop.Builder

Builder for ColorStop

ColorBuilders.SweepGradient

A sweep gradient with the given colors dispersed around its center with offsets defined in each color stop.

ColorBuilders.SweepGradient.Builder

Builder for SweepGradient.

DeviceParametersBuilders

Builders for request messages used to fetch layouts and resources.

DeviceParametersBuilders.Capabilities

Capabilities describing the features that the renderer supports.

DeviceParametersBuilders.Capabilities.Builder

Builder for Capabilities

DeviceParametersBuilders.DeviceParameters

Parameters describing the device requesting a layout update.

DeviceParametersBuilders.DeviceParameters.Builder

Builder for DeviceParameters

DimensionBuilders

Builders for dimensions for layout elements.

DimensionBuilders.AngularLayoutConstraint

A type for specifying layout constraints when using DegreesProp on a data bindable layout element.

DimensionBuilders.AngularLayoutConstraint.Builder

Builder for AngularLayoutConstraint.

DimensionBuilders.BoundingBoxRatio

Provide a length measurement proportional to the element's bounding box.

DimensionBuilders.BoundingBoxRatio.Builder

Builder for BoundingBoxRatio.

DimensionBuilders.DegreesProp

A type for angular dimensions, measured in degrees.

DimensionBuilders.DegreesProp.Builder

Builder for DegreesProp

DimensionBuilders.DpProp

A type for linear dimensions, measured in dp.

DimensionBuilders.DpProp.Builder

Builder for DpProp.

DimensionBuilders.EmProp

A type for font spacing, measured in em.

DimensionBuilders.EmProp.Builder

Builder for EmProp

DimensionBuilders.ExpandedDimensionProp

A type for a dimension that fills all the space it can (i.e. MATCH_PARENT in Android parlance).

DimensionBuilders.ExpandedDimensionProp.Builder

Builder for ExpandedDimensionProp.

DimensionBuilders.HorizontalLayoutConstraint

A type for specifying horizontal layout constraints when using DpProp on a data bindable layout element.

DimensionBuilders.HorizontalLayoutConstraint.Builder

Builder for HorizontalLayoutConstraint.

DimensionBuilders.ProportionalDimensionProp

A type for a dimension that scales itself proportionally to another dimension such that the aspect ratio defined by the given width and height values is preserved.

DimensionBuilders.ProportionalDimensionProp.Builder

Builder for ProportionalDimensionProp.

DimensionBuilders.SpProp

A type for font sizes, measured in sp.

DimensionBuilders.SpProp.Builder

Builder for SpProp

DimensionBuilders.VerticalLayoutConstraint

A type for specifying vertical layout constraints when using DpProp on a data bindable layout element.

DimensionBuilders.VerticalLayoutConstraint.Builder

Builder for VerticalLayoutConstraint.

DimensionBuilders.WrappedDimensionProp

A type for a dimension that sizes itself to the size of its children (i.e. WRAP_CONTENT in Android parlance).

DimensionBuilders.WrappedDimensionProp.Builder

Builder for WrappedDimensionProp.

LayoutElementBuilders

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

LayoutElementBuilders.Arc

An arc container.

LayoutElementBuilders.Arc.Builder

Builder for Arc.

LayoutElementBuilders.ArcAdapter

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

LayoutElementBuilders.ArcAdapter.Builder

Builder for ArcAdapter.

LayoutElementBuilders.ArcAnchorTypeProp

An extensible ArcAnchorType property.

LayoutElementBuilders.ArcAnchorTypeProp.Builder

Builder for ArcAnchorTypeProp

LayoutElementBuilders.ArcDirectionProp

An extensible ArcDirection property that can be set to any curved element to control the drawing direction.

LayoutElementBuilders.ArcDirectionProp.Builder

Builder for ArcDirectionProp

LayoutElementBuilders.ArcLine

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

LayoutElementBuilders.ArcLine.Builder

Builder for ArcLine.

LayoutElementBuilders.ArcSpacer

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

LayoutElementBuilders.ArcSpacer.Builder

Builder for ArcSpacer.

LayoutElementBuilders.ArcText

A text element that can be used in an Arc.

LayoutElementBuilders.ArcText.Builder

Builder for ArcText.

LayoutElementBuilders.Box

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

LayoutElementBuilders.Box.Builder

Builder for Box.

LayoutElementBuilders.ColorFilter

Filtering parameters used for images.

LayoutElementBuilders.ColorFilter.Builder

Builder for ColorFilter

LayoutElementBuilders.Column

A column of elements.

LayoutElementBuilders.Column.Builder

Builder for Column.

LayoutElementBuilders.ContentScaleModeProp

An extensible ContentScaleMode property.

LayoutElementBuilders.ContentScaleModeProp.Builder

Builder for ContentScaleModeProp

LayoutElementBuilders.ExtensionLayoutElement

A layout element which can be defined by a renderer extension.

LayoutElementBuilders.ExtensionLayoutElement.Builder

Builder for ExtensionLayoutElement.

LayoutElementBuilders.FontStyle

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

LayoutElementBuilders.FontStyle.Builder

Builder for FontStyle

LayoutElementBuilders.FontStyles

This class is deprecated.

Use androidx.wear.protolayout.material.Typography on Material (highly recommended) or make your own .

LayoutElementBuilders.FontVariantProp

An extensible FontVariant property.

LayoutElementBuilders.FontVariantProp.Builder

Builder for FontVariantProp

LayoutElementBuilders.FontWeightProp

An extensible FontWeight property.

LayoutElementBuilders.FontWeightProp.Builder

Builder for FontWeightProp

LayoutElementBuilders.HorizontalAlignmentProp

An extensible HorizontalAlignment property.

LayoutElementBuilders.HorizontalAlignmentProp.Builder

Builder for HorizontalAlignmentProp

LayoutElementBuilders.Image

An image.

LayoutElementBuilders.Image.Builder

Builder for Image.

LayoutElementBuilders.Layout

A complete layout.

LayoutElementBuilders.Layout.Builder

Builder for Layout

LayoutElementBuilders.Row

A row of elements.

LayoutElementBuilders.Row.Builder

Builder for Row.

LayoutElementBuilders.Spacer

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

LayoutElementBuilders.Spacer.Builder

Builder for Spacer.

LayoutElementBuilders.SpanImage

An image which can be added to a Span.

LayoutElementBuilders.SpanImage.Builder

Builder for SpanImage.

LayoutElementBuilders.SpanText

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

LayoutElementBuilders.SpanText.Builder

Builder for SpanText.

LayoutElementBuilders.SpanVerticalAlignmentProp

An extensible SpanVerticalAlignment property.

LayoutElementBuilders.SpanVerticalAlignmentProp.Builder

Builder for SpanVerticalAlignmentProp

LayoutElementBuilders.Spannable

A container of Span elements.

LayoutElementBuilders.Spannable.Builder

Builder for Spannable.

LayoutElementBuilders.StrokeCapProp

An extensible StrokeCap property.

LayoutElementBuilders.StrokeCapProp.Builder

Builder for StrokeCapProp

LayoutElementBuilders.Text

A text string.

LayoutElementBuilders.Text.Builder

Builder for Text.

LayoutElementBuilders.TextAlignmentProp

An extensible TextAlignment property.

LayoutElementBuilders.TextAlignmentProp.Builder

Builder for TextAlignmentProp

LayoutElementBuilders.TextOverflowProp

An extensible TextOverflow property.

LayoutElementBuilders.TextOverflowProp.Builder

Builder for TextOverflowProp

LayoutElementBuilders.VerticalAlignmentProp

An extensible VerticalAlignment property.

LayoutElementBuilders.VerticalAlignmentProp.Builder

Builder for VerticalAlignmentProp

ModifiersBuilders

Builders for modifiers for composable layout elements.

ModifiersBuilders.AnimatedVisibility

The content transition of an element.

ModifiersBuilders.AnimatedVisibility.Builder

Builder for AnimatedVisibility

ModifiersBuilders.ArcModifiers

Modifiers that can be used with ArcLayoutElements.

ModifiersBuilders.ArcModifiers.Builder

Builder for ArcModifiers

ModifiersBuilders.Background

A modifier to apply a background to an element.

ModifiersBuilders.Background.Builder

Builder for Background

ModifiersBuilders.Border

A modifier to apply a border around an element.

ModifiersBuilders.Border.Builder

Builder for Border

ModifiersBuilders.Clickable

A modifier for an element which can have associated Actions for click events.

ModifiersBuilders.Clickable.Builder

Builder for Clickable

ModifiersBuilders.Corner

The corner of a androidx.wear.protolayout.LayoutElementBuilders.Box element.

ModifiersBuilders.Corner.Builder

Builder for Corner

ModifiersBuilders.DefaultContentTransitions

Prebuilt default objects for animated visibility transition animations.

ModifiersBuilders.ElementMetadata

Metadata about an element.

ModifiersBuilders.ElementMetadata.Builder

Builder for ElementMetadata

ModifiersBuilders.EnterTransition

The content transition that is triggered when element enters the layout.

ModifiersBuilders.EnterTransition.Builder

Builder for EnterTransition

ModifiersBuilders.ExitTransition

The content transition that is triggered when element exits the layout.

ModifiersBuilders.ExitTransition.Builder

Builder for ExitTransition

ModifiersBuilders.FadeInTransition

The fading animation for content transition of an element and its children, from the specified starting alpha to fully visible.

ModifiersBuilders.FadeInTransition.Builder

Builder for FadeInTransition

ModifiersBuilders.FadeOutTransition

The fading animation for content transition of an element and its children, from fully visible to the specified target alpha.

ModifiersBuilders.FadeOutTransition.Builder

Builder for FadeOutTransition

ModifiersBuilders.Modifiers

Modifiers for an element.

ModifiersBuilders.Modifiers.Builder

Builder for Modifiers

ModifiersBuilders.Padding

A modifier to apply padding around an element.

ModifiersBuilders.Padding.Builder

Builder for Padding

ModifiersBuilders.Semantics

A modifier for an element which has accessibility semantics associated with it.

ModifiersBuilders.Semantics.Builder

Builder for Semantics

ModifiersBuilders.Shadow

The shadow definition.

ModifiersBuilders.Shadow.Builder

Builder for Shadow

ModifiersBuilders.SlideInTransition

The sliding in animation for content transition of an element and its children.

ModifiersBuilders.SlideInTransition.Builder

Builder for SlideInTransition

ModifiersBuilders.SlideOutTransition

The sliding out animation for content transition of an element and its children.

ModifiersBuilders.SlideOutTransition.Builder

Builder for SlideOutTransition

ModifiersBuilders.SlideParentBound

The slide animation will animate from/to the parent elements boundaries.

ModifiersBuilders.SlideParentBound.Builder

Builder for SlideParentBound.

ModifiersBuilders.SpanModifiers

Modifiers that can be used with elements.

ModifiersBuilders.SpanModifiers.Builder

Builder for SpanModifiers

ModifiersBuilders.Transformation

A modifier to apply transformations to the element.

ModifiersBuilders.Transformation.Builder

Builder for Transformation

ResourceBuilders

Builders for the resources for a layout.

ResourceBuilders.AndroidAnimatedImageResourceByResId

A non-seekable animated image resource that maps to an Android drawable by resource ID.

ResourceBuilders.AndroidAnimatedImageResourceByResId.Builder

Builder for AndroidAnimatedImageResourceByResId

ResourceBuilders.AndroidImageResourceByResId

An image resource which maps to an Android drawable by resource ID.

ResourceBuilders.AndroidImageResourceByResId.Builder

Builder for AndroidImageResourceByResId

ResourceBuilders.AndroidSeekableAnimatedImageResourceByResId

A seekable animated image resource that maps to an Android drawable by resource ID.

ResourceBuilders.AndroidSeekableAnimatedImageResourceByResId.Builder

Builder for AndroidSeekableAnimatedImageResourceByResId

ResourceBuilders.ImageResource

An image resource, which can be used by layouts.

ResourceBuilders.ImageResource.Builder

Builder for ImageResource

ResourceBuilders.InlineImageResource

An image resource whose data is fully inlined, with no dependency on a system or app resource.

ResourceBuilders.InlineImageResource.Builder

Builder for InlineImageResource

ResourceBuilders.Resources

The resources for a layout.

ResourceBuilders.Resources.Builder

Builder for Resources

StateBuilders

Builders for state of a layout.

StateBuilders.State

State information.

StateBuilders.State.Builder

Builder for State

TimelineBuilders

Builders for a timeline with entries representing content that should be displayed within given time intervals.

TimelineBuilders.TimeInterval

A time interval, typically used to describe the validity period of a TimelineEntry.

TimelineBuilders.TimeInterval.Builder

Builder for TimeInterval

TimelineBuilders.Timeline

A collection of TimelineEntry items.

TimelineBuilders.Timeline.Builder

Builder for Timeline

TimelineBuilders.TimelineEntry

One piece of renderable content along with the time that it is valid for.

TimelineBuilders.TimelineEntry.Builder

Builder for TimelineEntry

TriggerBuilders

Builders for triggers that can be used to start an animation.

TypeBuilders

Builders for extensible primitive types used by layout elements.

TypeBuilders.BoolProp

A boolean type.

TypeBuilders.BoolProp.Builder

Builder for BoolProp

TypeBuilders.FloatProp

A float type.

TypeBuilders.FloatProp.Builder

Builder for FloatProp

TypeBuilders.Int32Prop

An int32 type.

TypeBuilders.Int32Prop.Builder

Builder for Int32Prop

TypeBuilders.StringLayoutConstraint

A type for specifying layout constraints when using StringProp on a data bindable layout element.

TypeBuilders.StringLayoutConstraint.Builder

Builder for StringLayoutConstraint.

TypeBuilders.StringProp

A string type.

TypeBuilders.StringProp.Builder

Builder for StringProp