package

androidx.wear.protolayout

Overview

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

Interfaces

ActionBuilders.ActionInterface defining an action that can be used by a layout element.
ActionBuilders.Action.BuilderBuilder to create ActionBuilders.Action objects.
ActionBuilders.AndroidExtraInterface defining an item that can be included in the extras of an intent that will be sent to an Android activity.
ActionBuilders.AndroidExtra.BuilderBuilder to create ActionBuilders.AndroidExtra objects.
ColorBuilders.BrushInterface defining a ColorBuilders.Brush describes how something is drawn on screen.
ColorBuilders.Brush.BuilderBuilder to create ColorBuilders.Brush objects.
DimensionBuilders.ContainerDimensionInterface defining a dimension that can be applied to a container.
DimensionBuilders.ContainerDimension.BuilderBuilder to create DimensionBuilders.ContainerDimension objects.
DimensionBuilders.ExtensionDimensionInterface defining a dimension that can be applied to a LayoutElementBuilders.ExtensionLayoutElement element.
DimensionBuilders.ExtensionDimension.BuilderBuilder to create DimensionBuilders.ExtensionDimension objects.
DimensionBuilders.ImageDimensionInterface defining a dimension that can be applied to an image.
DimensionBuilders.ImageDimension.BuilderBuilder to create DimensionBuilders.ImageDimension objects.
DimensionBuilders.PivotDimensionInterface defining a dimension that can be applied to a pivot location for scale and rotate transformations.
DimensionBuilders.PivotDimension.BuilderBuilder to create DimensionBuilders.PivotDimension objects.
DimensionBuilders.SpacerDimensionInterface defining a dimension that can be applied to a spacer.
DimensionBuilders.SpacerDimension.BuilderBuilder to create DimensionBuilders.SpacerDimension objects.
LayoutElementBuilders.ArcLayoutElementInterface defining the root of all elements that can be used in an LayoutElementBuilders.Arc.
LayoutElementBuilders.ArcLayoutElement.BuilderBuilder to create LayoutElementBuilders.ArcLayoutElement objects.
LayoutElementBuilders.FontSettingInterface defining a single point of customization in a font.
LayoutElementBuilders.FontSetting.BuilderBuilder to create LayoutElementBuilders.FontSetting objects.
LayoutElementBuilders.LayoutElementInterface defining the root of all layout elements.
LayoutElementBuilders.LayoutElement.BuilderBuilder to create LayoutElementBuilders.LayoutElement objects.
LayoutElementBuilders.SpanInterface defining a single LayoutElementBuilders.Span.
LayoutElementBuilders.Span.BuilderBuilder to create LayoutElementBuilders.Span objects.
ModifiersBuilders.SlideBoundInterface defining the boundary that a Slide animation will use for start/end.
ModifiersBuilders.SlideBound.BuilderBuilder to create ModifiersBuilders.SlideBound objects.
TriggerBuilders.TriggerInterface defining the triggers that can be fired.
TriggerBuilders.Trigger.BuilderBuilder to create TriggerBuilders.Trigger objects.

Classes

ActionBuildersBuilders for actions that can be performed when a user interacts with layout elements.
ActionBuilders.AndroidActivityA launch action to send an intent to an Android activity.
ActionBuilders.AndroidActivity.BuilderBuilder for ActionBuilders.AndroidActivity
ActionBuilders.AndroidBooleanExtraA boolean value that can be added to an Android intent's extras.
ActionBuilders.AndroidBooleanExtra.BuilderBuilder for ActionBuilders.AndroidBooleanExtra.
ActionBuilders.AndroidDoubleExtraA double value that can be added to an Android intent's extras.
ActionBuilders.AndroidDoubleExtra.BuilderBuilder for ActionBuilders.AndroidDoubleExtra.
ActionBuilders.AndroidIntExtraAn integer value that can be added to an Android intent's extras.
ActionBuilders.AndroidIntExtra.BuilderBuilder for ActionBuilders.AndroidIntExtra.
ActionBuilders.AndroidLongExtraA long value that can be added to an Android intent's extras.
ActionBuilders.AndroidLongExtra.BuilderBuilder for ActionBuilders.AndroidLongExtra.
ActionBuilders.AndroidStringExtraA string value that can be added to an Android intent's extras.
ActionBuilders.AndroidStringExtra.BuilderBuilder for ActionBuilders.AndroidStringExtra.
ActionBuilders.LaunchActionAn action used to launch another activity on the system.
ActionBuilders.LaunchAction.BuilderBuilder for ActionBuilders.LaunchAction.
ActionBuilders.LoadActionAn action used to load (or reload) the layout contents.
ActionBuilders.LoadAction.BuilderBuilder for ActionBuilders.LoadAction.
ColorBuildersBuilders for color utilities for layout elements.
ColorBuilders.ColorPropA property defining a color.
ColorBuilders.ColorProp.BuilderBuilder for ColorBuilders.ColorProp
ColorBuilders.ColorStopA color and an offset, determining a color position in a gradient.
ColorBuilders.ColorStop.BuilderBuilder for ColorBuilders.ColorStop
ColorBuilders.SweepGradientA sweep gradient with the given colors dispersed around its center with offsets defined in each color stop.
ColorBuilders.SweepGradient.BuilderBuilder for ColorBuilders.SweepGradient.
DeviceParametersBuildersBuilders for request messages used to fetch layouts and resources.
DeviceParametersBuilders.CapabilitiesDeviceParametersBuilders.Capabilities describing the features that the renderer supports.
DeviceParametersBuilders.Capabilities.BuilderBuilder for DeviceParametersBuilders.Capabilities
DeviceParametersBuilders.DeviceParametersParameters describing the device requesting a layout update.
DeviceParametersBuilders.DeviceParameters.BuilderBuilder for DeviceParametersBuilders.DeviceParameters
DimensionBuildersBuilders for dimensions for layout elements.
DimensionBuilders.AngularLayoutConstraintA type for specifying layout constraints when using DimensionBuilders.DegreesProp on a data bindable layout element.
DimensionBuilders.AngularLayoutConstraint.BuilderBuilder for DimensionBuilders.AngularLayoutConstraint.
DimensionBuilders.BoundingBoxRatioProvide a position representation proportional to the bounding box width/height.
DimensionBuilders.BoundingBoxRatio.BuilderBuilder for DimensionBuilders.BoundingBoxRatio.
DimensionBuilders.DegreesPropA type for angular dimensions, measured in degrees.
DimensionBuilders.DegreesProp.BuilderBuilder for DimensionBuilders.DegreesProp
DimensionBuilders.DpPropA type for linear dimensions, measured in dp.
DimensionBuilders.DpProp.BuilderBuilder for DimensionBuilders.DpProp.
DimensionBuilders.EmPropA type for font spacing, measured in em.
DimensionBuilders.EmProp.BuilderBuilder for DimensionBuilders.EmProp
DimensionBuilders.ExpandedDimensionPropA type for a dimension that fills all the space it can (i.e.
DimensionBuilders.ExpandedDimensionProp.BuilderBuilder for DimensionBuilders.ExpandedDimensionProp.
DimensionBuilders.HorizontalLayoutConstraintA type for specifying horizontal layout constraints when using DimensionBuilders.DpProp on a data bindable layout element.
DimensionBuilders.HorizontalLayoutConstraint.BuilderBuilder for DimensionBuilders.HorizontalLayoutConstraint.
DimensionBuilders.ProportionalDimensionPropA 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.BuilderBuilder for DimensionBuilders.ProportionalDimensionProp.
DimensionBuilders.SpPropA type for font sizes, measured in sp.
DimensionBuilders.SpProp.BuilderBuilder for DimensionBuilders.SpProp
DimensionBuilders.VerticalLayoutConstraintA type for specifying vertical layout constraints when using DimensionBuilders.DpProp on a data bindable layout element.
DimensionBuilders.VerticalLayoutConstraint.BuilderBuilder for DimensionBuilders.VerticalLayoutConstraint.
DimensionBuilders.WrappedDimensionPropA type for a dimension that sizes itself to the size of its children (i.e.
DimensionBuilders.WrappedDimensionProp.BuilderBuilder for DimensionBuilders.WrappedDimensionProp.
LayoutElementBuildersBuilders for composable layout elements that can be combined together to create renderable UI layouts.
LayoutElementBuilders.ArcAn arc container.
LayoutElementBuilders.Arc.BuilderBuilder for LayoutElementBuilders.Arc.
LayoutElementBuilders.ArcAdapterA container that allows a standard LayoutElementBuilders.LayoutElement to be added to an LayoutElementBuilders.Arc.
LayoutElementBuilders.ArcAdapter.BuilderBuilder for LayoutElementBuilders.ArcAdapter.
LayoutElementBuilders.ArcAnchorTypePropAn extensible ArcAnchorType property.
LayoutElementBuilders.ArcAnchorTypeProp.BuilderBuilder for LayoutElementBuilders.ArcAnchorTypeProp
LayoutElementBuilders.ArcDirectionPropAn extensible ArcDirection property that can be set to any curved element to control the drawing direction.
LayoutElementBuilders.ArcDirectionProp.BuilderBuilder for LayoutElementBuilders.ArcDirectionProp
LayoutElementBuilders.ArcLineA line that can be used in an LayoutElementBuilders.Arc and renders as a round progress bar.
LayoutElementBuilders.ArcLine.BuilderBuilder for LayoutElementBuilders.ArcLine.
LayoutElementBuilders.ArcSpacerA simple spacer used to provide padding between adjacent elements in an LayoutElementBuilders.Arc.
LayoutElementBuilders.ArcSpacer.BuilderBuilder for LayoutElementBuilders.ArcSpacer.
LayoutElementBuilders.ArcTextA text element that can be used in an LayoutElementBuilders.Arc.
LayoutElementBuilders.ArcText.BuilderBuilder for LayoutElementBuilders.ArcText.
LayoutElementBuilders.BoxA container which stacks all of its children on top of one another.
LayoutElementBuilders.Box.BuilderBuilder for LayoutElementBuilders.Box.
LayoutElementBuilders.ColorFilterFiltering parameters used for images.
LayoutElementBuilders.ColorFilter.BuilderBuilder for LayoutElementBuilders.ColorFilter
LayoutElementBuilders.ColumnA column of elements.
LayoutElementBuilders.Column.BuilderBuilder for LayoutElementBuilders.Column.
LayoutElementBuilders.ContentScaleModePropAn extensible ContentScaleMode property.
LayoutElementBuilders.ContentScaleModeProp.BuilderBuilder for LayoutElementBuilders.ContentScaleModeProp
LayoutElementBuilders.ExtensionLayoutElementA layout element which can be defined by a renderer extension.
LayoutElementBuilders.ExtensionLayoutElement.BuilderBuilder for LayoutElementBuilders.ExtensionLayoutElement.
LayoutElementBuilders.FontStyleThe styling of a font (e.g.
LayoutElementBuilders.FontStyle.BuilderBuilder for LayoutElementBuilders.FontStyle
LayoutElementBuilders.FontStylesFont styles, currently set up to match Wear's font styling.
LayoutElementBuilders.FontVariantPropAn extensible FontVariant property.
LayoutElementBuilders.FontVariantProp.BuilderBuilder for LayoutElementBuilders.FontVariantProp
LayoutElementBuilders.FontWeightPropAn extensible FontWeight property.
LayoutElementBuilders.FontWeightProp.BuilderBuilder for LayoutElementBuilders.FontWeightProp
LayoutElementBuilders.HorizontalAlignmentPropAn extensible HorizontalAlignment property.
LayoutElementBuilders.HorizontalAlignmentProp.BuilderBuilder for LayoutElementBuilders.HorizontalAlignmentProp
LayoutElementBuilders.ImageAn image.
LayoutElementBuilders.Image.BuilderBuilder for LayoutElementBuilders.Image.
LayoutElementBuilders.LayoutA complete layout.
LayoutElementBuilders.Layout.BuilderBuilder for LayoutElementBuilders.Layout
LayoutElementBuilders.RowA row of elements.
LayoutElementBuilders.Row.BuilderBuilder for LayoutElementBuilders.Row.
LayoutElementBuilders.SpacerA simple spacer, typically used to provide padding between adjacent elements.
LayoutElementBuilders.Spacer.BuilderBuilder for LayoutElementBuilders.Spacer.
LayoutElementBuilders.SpanImageAn image which can be added to a LayoutElementBuilders.Span.
LayoutElementBuilders.SpanImage.BuilderBuilder for LayoutElementBuilders.SpanImage.
LayoutElementBuilders.SpannableA container of LayoutElementBuilders.Span elements.
LayoutElementBuilders.Spannable.BuilderBuilder for LayoutElementBuilders.Spannable.
LayoutElementBuilders.SpanTextA portion of text which can be added to a LayoutElementBuilders.Span.
LayoutElementBuilders.SpanText.BuilderBuilder for LayoutElementBuilders.SpanText.
LayoutElementBuilders.SpanVerticalAlignmentPropAn extensible SpanVerticalAlignment property.
LayoutElementBuilders.SpanVerticalAlignmentProp.BuilderBuilder for LayoutElementBuilders.SpanVerticalAlignmentProp
LayoutElementBuilders.StrokeCapPropAn extensible StrokeCap property.
LayoutElementBuilders.StrokeCapProp.BuilderBuilder for LayoutElementBuilders.StrokeCapProp
LayoutElementBuilders.TextA text string.
LayoutElementBuilders.Text.BuilderBuilder for LayoutElementBuilders.Text.
LayoutElementBuilders.TextAlignmentPropAn extensible TextAlignment property.
LayoutElementBuilders.TextAlignmentProp.BuilderBuilder for LayoutElementBuilders.TextAlignmentProp
LayoutElementBuilders.TextOverflowPropAn extensible TextOverflow property.
LayoutElementBuilders.TextOverflowProp.BuilderBuilder for LayoutElementBuilders.TextOverflowProp
LayoutElementBuilders.VerticalAlignmentPropAn extensible VerticalAlignment property.
LayoutElementBuilders.VerticalAlignmentProp.BuilderBuilder for LayoutElementBuilders.VerticalAlignmentProp
ModifiersBuildersBuilders for modifiers for composable layout elements.
ModifiersBuilders.AnimatedVisibilityThe content transition of an element.
ModifiersBuilders.AnimatedVisibility.BuilderBuilder for ModifiersBuilders.AnimatedVisibility
ModifiersBuilders.ArcModifiersModifiersBuilders.Modifiers that can be used with ArcLayoutElements.
ModifiersBuilders.ArcModifiers.BuilderBuilder for ModifiersBuilders.ArcModifiers
ModifiersBuilders.BackgroundA modifier to apply a background to an element.
ModifiersBuilders.Background.BuilderBuilder for ModifiersBuilders.Background
ModifiersBuilders.BorderA modifier to apply a border around an element.
ModifiersBuilders.Border.BuilderBuilder for ModifiersBuilders.Border
ModifiersBuilders.ClickableA modifier for an element which can have associated Actions for click events.
ModifiersBuilders.Clickable.BuilderBuilder for ModifiersBuilders.Clickable
ModifiersBuilders.CornerThe corner of a LayoutElementBuilders.Box element.
ModifiersBuilders.Corner.BuilderBuilder for ModifiersBuilders.Corner
ModifiersBuilders.CornerRadiusA radius for either circular or elliptical shapes.
ModifiersBuilders.CornerRadius.BuilderBuilder for ModifiersBuilders.CornerRadius
ModifiersBuilders.DefaultContentTransitionsPrebuilt default objects for animated visibility transition animations.
ModifiersBuilders.ElementMetadataMetadata about an element.
ModifiersBuilders.ElementMetadata.BuilderBuilder for ModifiersBuilders.ElementMetadata
ModifiersBuilders.EnterTransitionThe content transition that is triggered when element enters the layout.
ModifiersBuilders.EnterTransition.BuilderBuilder for ModifiersBuilders.EnterTransition
ModifiersBuilders.ExitTransitionThe content transition that is triggered when element exits the layout.
ModifiersBuilders.ExitTransition.BuilderBuilder for ModifiersBuilders.ExitTransition
ModifiersBuilders.FadeInTransitionThe fading animation for content transition of an element and its children, from the specified starting alpha to fully visible.
ModifiersBuilders.FadeInTransition.BuilderBuilder for ModifiersBuilders.FadeInTransition
ModifiersBuilders.FadeOutTransitionThe fading animation for content transition of an element and its children, from fully visible to the specified target alpha.
ModifiersBuilders.FadeOutTransition.BuilderBuilder for ModifiersBuilders.FadeOutTransition
ModifiersBuilders.ModifiersModifiersBuilders.Modifiers for an element.
ModifiersBuilders.Modifiers.BuilderBuilder for ModifiersBuilders.Modifiers
ModifiersBuilders.PaddingA modifier to apply padding around an element.
ModifiersBuilders.Padding.BuilderBuilder for ModifiersBuilders.Padding
ModifiersBuilders.SemanticsA modifier for an element which has accessibility semantics associated with it.
ModifiersBuilders.Semantics.BuilderBuilder for ModifiersBuilders.Semantics
ModifiersBuilders.ShadowThe shadow definition.
ModifiersBuilders.Shadow.BuilderBuilder for ModifiersBuilders.Shadow
ModifiersBuilders.SlideInTransitionThe sliding in animation for content transition of an element and its children.
ModifiersBuilders.SlideInTransition.BuilderBuilder for ModifiersBuilders.SlideInTransition
ModifiersBuilders.SlideOutTransitionThe sliding out animation for content transition of an element and its children.
ModifiersBuilders.SlideOutTransition.BuilderBuilder for ModifiersBuilders.SlideOutTransition
ModifiersBuilders.SlideParentBoundThe slide animation will animate from/to the parent elements boundaries.
ModifiersBuilders.SlideParentBound.BuilderBuilder for ModifiersBuilders.SlideParentBound.
ModifiersBuilders.SpanModifiersModifiersBuilders.Modifiers that can be used with LayoutElementBuilders.Span elements.
ModifiersBuilders.SpanModifiers.BuilderBuilder for ModifiersBuilders.SpanModifiers
ModifiersBuilders.TransformationA modifier to apply transformations to the element.
ModifiersBuilders.Transformation.BuilderBuilder for ModifiersBuilders.Transformation
ResourceBuildersBuilders for the resources for a layout.
ResourceBuilders.AndroidAnimatedImageResourceByResIdA non-seekable animated image resource that maps to an Android drawable by resource ID.
ResourceBuilders.AndroidAnimatedImageResourceByResId.BuilderBuilder for ResourceBuilders.AndroidAnimatedImageResourceByResId
ResourceBuilders.AndroidImageResourceByResIdAn image resource which maps to an Android drawable by resource ID.
ResourceBuilders.AndroidImageResourceByResId.BuilderBuilder for ResourceBuilders.AndroidImageResourceByResId
ResourceBuilders.AndroidSeekableAnimatedImageResourceByResIdA seekable animated image resource that maps to an Android drawable by resource ID.
ResourceBuilders.AndroidSeekableAnimatedImageResourceByResId.BuilderBuilder for ResourceBuilders.AndroidSeekableAnimatedImageResourceByResId
ResourceBuilders.ImageResourceAn image resource, which can be used by layouts.
ResourceBuilders.ImageResource.BuilderBuilder for ResourceBuilders.ImageResource
ResourceBuilders.InlineImageResourceAn image resource whose data is fully inlined, with no dependency on a system or app resource.
ResourceBuilders.InlineImageResource.BuilderBuilder for ResourceBuilders.InlineImageResource
ResourceBuilders.ResourcesThe resources for a layout.
ResourceBuilders.Resources.BuilderBuilder for ResourceBuilders.Resources
StateBuildersBuilders for state of a layout.
StateBuilders.StateStateBuilders.State information.
StateBuilders.State.BuilderBuilder for StateBuilders.State
TimelineBuildersBuilders for a timeline with entries representing content that should be displayed within given time intervals.
TimelineBuilders.TimeIntervalA time interval, typically used to describe the validity period of a TimelineBuilders.TimelineEntry.
TimelineBuilders.TimeInterval.BuilderBuilder for TimelineBuilders.TimeInterval
TimelineBuilders.TimelineA collection of TimelineBuilders.TimelineEntry items.
TimelineBuilders.Timeline.BuilderBuilder for TimelineBuilders.Timeline
TimelineBuilders.TimelineEntryOne piece of renderable content along with the time that it is valid for.
TimelineBuilders.TimelineEntry.BuilderBuilder for TimelineBuilders.TimelineEntry
TriggerBuildersBuilders for triggers that can be used to start an animation.
TypeBuildersBuilders for extensible primitive types used by layout elements.
TypeBuilders.BoolPropA boolean type.
TypeBuilders.BoolProp.BuilderBuilder for TypeBuilders.BoolProp
TypeBuilders.FloatPropA float type.
TypeBuilders.FloatProp.BuilderBuilder for TypeBuilders.FloatProp
TypeBuilders.Int32PropAn int32 type.
TypeBuilders.Int32Prop.BuilderBuilder for TypeBuilders.Int32Prop
TypeBuilders.StringLayoutConstraintA type for specifying layout constraints when using TypeBuilders.StringProp on a data bindable layout element.
TypeBuilders.StringLayoutConstraint.BuilderBuilder for TypeBuilders.StringLayoutConstraint.
TypeBuilders.StringPropA string type.
TypeBuilders.StringProp.BuilderBuilder for TypeBuilders.StringProp

Annotation Types

DeviceParametersBuilders.DevicePlatformThe platform of the device requesting a layout.
DeviceParametersBuilders.ScreenShapeThe shape of a screen.
LayoutElementBuilders.AngularAlignmentHow to lay out components in a LayoutElementBuilders.Arc context when they are smaller than their container.
LayoutElementBuilders.ArcAnchorTypeThe anchor position of an LayoutElementBuilders.Arc's elements.
LayoutElementBuilders.ArcDirectionDirection of drawing for any curved element.
LayoutElementBuilders.ContentScaleModeHow content which does not match the dimensions of its bounds (e.g.
LayoutElementBuilders.FontStyle.FontFamilyNameThe recommended font family names to be used within LayoutElementBuilders.FontStyle.
LayoutElementBuilders.FontVariantThe variant of a font.
LayoutElementBuilders.FontWeightThe weight to be applied to the font.
LayoutElementBuilders.HorizontalAlignmentThe horizontal alignment of an element within its container.
LayoutElementBuilders.SpanVerticalAlignmentThe alignment of a LayoutElementBuilders.SpanImage within the line height of the surrounding LayoutElementBuilders.Spannable.
LayoutElementBuilders.StrokeCapStyles to use for path endings.
LayoutElementBuilders.TextAlignmentAlignment of a text element.
LayoutElementBuilders.TextOverflowHow text that will not fit inside the bounds of a LayoutElementBuilders.Text element will be handled.
LayoutElementBuilders.VerticalAlignmentThe vertical alignment of an element within its container.
ModifiersBuilders.SemanticsRoleThe type of user interface element.
ModifiersBuilders.SlideDirectionThe slide direction used for slide animations on any element, from the specified point to its destination in the layout for in animation or reverse for out animation.
ModifiersBuilders.SlideParentSnapOptionThe snap options to use when sliding using parent boundaries.
ResourceBuilders.AnimatedImageFormatFormat describing the contents of an animated image.
ResourceBuilders.ImageFormatFormat describing the contents of an image data byte array.
Generated Fri, 13 Sep 2024 06:44:37 +0000 by Michael Jentsch - Privacy Policy - Legal Details