ModifiersBuilders

class ModifiersBuilders

Builders for modifiers for composable layout elements.

Summary

Nested types

The content transition of an element.

Builder for AnimatedVisibility
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.ArcModifiers

Modifiers that can be used with ArcLayoutElements.

Builder for ArcModifiers
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.Background

A modifier to apply a background to an element.

Builder for Background
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.Border

A modifier to apply a border around an element.

Builder for Border
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.Clickable

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

Builder for Clickable
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.Corner

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

Builder for Corner
@RequiresSchemaVersion(major = 1, minor = 400)
class ModifiersBuilders.CornerRadius

A radius for either circular or elliptical shapes.

Builder for CornerRadius

Prebuilt default objects for animated visibility transition animations.

Metadata about an element.

Builder for ElementMetadata

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

Builder for EnterTransition

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

Builder for ExitTransition

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

Builder for FadeInTransition

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

Builder for FadeOutTransition
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.Modifiers

Modifiers for an element.

Builder for Modifiers
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.Padding

A modifier to apply padding around an element.

Builder for Padding
@RequiresSchemaVersion(major = 1, minor = 0)
class ModifiersBuilders.Semantics

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

Builder for Semantics
@RequiresSchemaVersion(major = 1, minor = 300)
class ModifiersBuilders.Shadow

The shadow definition.

Builder for Shadow

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

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

Builder for SlideInTransition

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

Builder for SlideOutTransition

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

Builder for SlideParentBound.

Modifiers that can be used with elements.

Builder for SpanModifiers
@RequiresSchemaVersion(major = 1, minor = 400)
class ModifiersBuilders.Transformation

A modifier to apply transformations to the element.

Builder for Transformation

Constants
const Int
@RequiresSchemaVersion(major = 1, minor = 200)
SEMANTICS_ROLE_BUTTON = 2

The element is a Button control.
const Int
@RequiresSchemaVersion(major = 1, minor = 200)
SEMANTICS_ROLE_CHECKBOX = 3

The element is a Checkbox which is a component that represents two states (checked / unchecked).
const Int
@RequiresSchemaVersion(major = 1, minor = 200)
SEMANTICS_ROLE_IMAGE = 1

The element is an image.
const Int
@RequiresSchemaVersion(major = 1, minor = 200)
SEMANTICS_ROLE_NONE = 0

Role is undefined.
const Int
@RequiresSchemaVersion(major = 1, minor = 200)
SEMANTICS_ROLE_RADIOBUTTON = 5

This element is a RadioButton which is a component to represent two states, selected and not selected.
const Int
@RequiresSchemaVersion(major = 1, minor = 200)
SEMANTICS_ROLE_SWITCH = 4

The element is a Switch which is a two state toggleable component that provides on/off like options.
const Int

The sliding orientation that moves an element vertically from bottom to the top.
const Int

The sliding orientation that moves an element horizontally from left to the right.
const Int

The sliding orientation that moves an element horizontally from right to the left.
const Int

The sliding orientation that moves an element vertically from top to the bottom.
const Int

The undefined sliding orientation.
const Int

The option that snaps insides of the element and its parent at start/end.
const Int

The option that snaps outsides of the element and its parent at start/end.
const Int

The undefined snapping option.

Constants

SEMANTICS_ROLE_BUTTON

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
const val SEMANTICS_ROLE_BUTTON = 2: Int

The element is a Button control.

SEMANTICS_ROLE_CHECKBOX

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
const val SEMANTICS_ROLE_CHECKBOX = 3: Int

The element is a Checkbox which is a component that represents two states (checked / unchecked).

SEMANTICS_ROLE_IMAGE

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
const val SEMANTICS_ROLE_IMAGE = 1: Int

The element is an image.

SEMANTICS_ROLE_NONE

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
const val SEMANTICS_ROLE_NONE = 0: Int

Role is undefined. It may be automatically populated.

SEMANTICS_ROLE_RADIOBUTTON

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
const val SEMANTICS_ROLE_RADIOBUTTON = 5: Int

This element is a RadioButton which is a component to represent two states, selected and not selected.

SEMANTICS_ROLE_SWITCH

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
const val SEMANTICS_ROLE_SWITCH = 4: Int

The element is a Switch which is a two state toggleable component that provides on/off like options.

SLIDE_DIRECTION_BOTTOM_TO_TOP

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_DIRECTION_BOTTOM_TO_TOP = 4: Int

The sliding orientation that moves an element vertically from bottom to the top.

SLIDE_DIRECTION_LEFT_TO_RIGHT

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_DIRECTION_LEFT_TO_RIGHT = 1: Int

The sliding orientation that moves an element horizontally from left to the right.

SLIDE_DIRECTION_RIGHT_TO_LEFT

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_DIRECTION_RIGHT_TO_LEFT = 2: Int

The sliding orientation that moves an element horizontally from right to the left.

SLIDE_DIRECTION_TOP_TO_BOTTOM

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_DIRECTION_TOP_TO_BOTTOM = 3: Int

The sliding orientation that moves an element vertically from top to the bottom.

SLIDE_DIRECTION_UNDEFINED

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_DIRECTION_UNDEFINED = 0: Int

The undefined sliding orientation.

SLIDE_PARENT_SNAP_TO_INSIDE

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_PARENT_SNAP_TO_INSIDE = 1: Int

The option that snaps insides of the element and its parent at start/end.

SLIDE_PARENT_SNAP_TO_OUTSIDE

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_PARENT_SNAP_TO_OUTSIDE = 2: Int

The option that snaps outsides of the element and its parent at start/end.

SLIDE_PARENT_SNAP_UNDEFINED

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
const val SLIDE_PARENT_SNAP_UNDEFINED = 0: Int

The undefined snapping option.