ModifiersBuilders

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

public final class ModifiersBuilders

---

Builders for modifiers for composable layout elements.

Summary

Nested types
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.AnimatedVisibility The content transition of an element.
public final class ModifiersBuilders.AnimatedVisibility.Builder Builder for AnimatedVisibility
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.ArcModifiers Modifiers that can be used with ArcLayoutElements.
public final class ModifiersBuilders.ArcModifiers.Builder Builder for ArcModifiers
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.Background A modifier to apply a background to an element.
public final class ModifiersBuilders.Background.Builder Builder for Background
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.Border A modifier to apply a border around an element.
public final class ModifiersBuilders.Border.Builder Builder for Border
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.Clickable A modifier for an element which can have associated Actions for click events.
public final class ModifiersBuilders.Clickable.Builder Builder for Clickable
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.Corner The corner of a androidx.wear.protolayout.LayoutElementBuilders.Box element.
public final class ModifiersBuilders.Corner.Builder Builder for Corner
@ProtoLayoutExperimental public final class ModifiersBuilders.DefaultContentTransitions Prebuilt default objects for animated visibility transition animations.
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.ElementMetadata Metadata about an element.
public final class ModifiersBuilders.ElementMetadata.Builder Builder for ElementMetadata
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.EnterTransition The content transition that is triggered when element enters the layout.
public final class ModifiersBuilders.EnterTransition.Builder Builder for EnterTransition
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.ExitTransition The content transition that is triggered when element exits the layout.
public final class ModifiersBuilders.ExitTransition.Builder Builder for ExitTransition
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.FadeInTransition The fading animation for content transition of an element and its children, from the specified starting alpha to fully visible.
public final class ModifiersBuilders.FadeInTransition.Builder Builder for FadeInTransition
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.FadeOutTransition The fading animation for content transition of an element and its children, from fully visible to the specified target alpha.
public final class ModifiersBuilders.FadeOutTransition.Builder Builder for FadeOutTransition
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.Modifiers Modifiers for an element.
public final class ModifiersBuilders.Modifiers.Builder Builder for Modifiers
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.Padding A modifier to apply padding around an element.
public final class ModifiersBuilders.Padding.Builder Builder for Padding
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.Semantics A modifier for an element which has accessibility semantics associated with it.
public final class ModifiersBuilders.Semantics.Builder Builder for Semantics
@RequiresSchemaVersion(major = 1, minor = 300) public final class ModifiersBuilders.Shadow The shadow definition.
public final class ModifiersBuilders.Shadow.Builder Builder for Shadow
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public interface ModifiersBuilders.SlideBound Interface defining the boundary that a Slide animation will use for start/end.
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.SlideInTransition The sliding in animation for content transition of an element and its children.
public final class ModifiersBuilders.SlideInTransition.Builder Builder for SlideInTransition
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.SlideOutTransition The sliding out animation for content transition of an element and its children.
public final class ModifiersBuilders.SlideOutTransition.Builder Builder for SlideOutTransition
@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental public final class ModifiersBuilders.SlideParentBound implements ModifiersBuilders.SlideBound The slide animation will animate from/to the parent elements boundaries.
public final class ModifiersBuilders.SlideParentBound.Builder Builder for SlideParentBound.
@RequiresSchemaVersion(major = 1, minor = 0) public final class ModifiersBuilders.SpanModifiers Modifiers that can be used with elements.
public final class ModifiersBuilders.SpanModifiers.Builder Builder for SpanModifiers
@RequiresSchemaVersion(major = 1, minor = 400) public final class ModifiersBuilders.Transformation A modifier to apply transformations to the element.
public final class ModifiersBuilders.Transformation.Builder Builder for Transformation

Constants
static final int	@RequiresSchemaVersion(major = 1, minor = 200) SEMANTICS_ROLE_BUTTON = 2 The element is a Button control.
static final 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).
static final int	@RequiresSchemaVersion(major = 1, minor = 200) SEMANTICS_ROLE_IMAGE = 1 The element is an image.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) SEMANTICS_ROLE_NONE = 0 Role is undefined.
static final 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.
static final 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.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_DIRECTION_BOTTOM_TO_TOP = 4 The sliding orientation that moves an element vertically from bottom to the top.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_DIRECTION_LEFT_TO_RIGHT = 1 The sliding orientation that moves an element horizontally from left to the right.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_DIRECTION_RIGHT_TO_LEFT = 2 The sliding orientation that moves an element horizontally from right to the left.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_DIRECTION_TOP_TO_BOTTOM = 3 The sliding orientation that moves an element vertically from top to the bottom.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_DIRECTION_UNDEFINED = 0 The undefined sliding orientation.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_PARENT_SNAP_TO_INSIDE = 1 The option that snaps insides of the element and its parent at start/end.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_PARENT_SNAP_TO_OUTSIDE = 2 The option that snaps outsides of the element and its parent at start/end.
static final int	@RequiresSchemaVersion(major = 1, minor = 200) @ProtoLayoutExperimental SLIDE_PARENT_SNAP_UNDEFINED = 0 The undefined snapping option.

Constants

SEMANTICS_ROLE_BUTTON

Added in 1.0.0

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

The element is a Button control.

SEMANTICS_ROLE_CHECKBOX

Added in 1.0.0

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

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)
public static final int SEMANTICS_ROLE_IMAGE = 1

The element is an image.

SEMANTICS_ROLE_NONE

Added in 1.0.0

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

Role is undefined. It may be automatically populated.

SEMANTICS_ROLE_RADIOBUTTON

Added in 1.0.0

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

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)
public static final int SEMANTICS_ROLE_SWITCH = 4

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
public static final int SLIDE_DIRECTION_BOTTOM_TO_TOP = 4

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
public static final int SLIDE_DIRECTION_LEFT_TO_RIGHT = 1

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
public static final int SLIDE_DIRECTION_RIGHT_TO_LEFT = 2

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
public static final int SLIDE_DIRECTION_TOP_TO_BOTTOM = 3

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
public static final int SLIDE_DIRECTION_UNDEFINED = 0

The undefined sliding orientation.

SLIDE_PARENT_SNAP_TO_INSIDE

Added in 1.0.0

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

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
public static final int SLIDE_PARENT_SNAP_TO_OUTSIDE = 2

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
public static final int SLIDE_PARENT_SNAP_UNDEFINED = 0

The undefined snapping option.