UserStyleSetting.Option

Artifact: androidx.wear.watchface:watchface-style

View Source

Added in 1.0.0

---

Kotlin |Java

public abstract class UserStyleSetting.Option

Known direct subclasses

UserStyleSetting.BooleanUserStyleSetting.BooleanOption, UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption, UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption, UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption, UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption, UserStyleSetting.ListUserStyleSetting.ListOption, UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption

UserStyleSetting.BooleanUserStyleSetting.BooleanOption	Represents a true or false option in the BooleanUserStyleSetting.
UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption	Represents an override to the initial androidx.wear.watchface.ComplicationSlotsManager configuration.
UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption	An application specific custom value.
UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption	Represents an option as a Double in the range minimumValue .. maximumValue.
UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption	An application specific custom value.
UserStyleSetting.ListUserStyleSetting.ListOption	Represents choice within a ListUserStyleSetting, these must be enumerated up front.
UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption	Represents an option a Long in the range minimumValue .. maximumValue.

---

Represents a choice within a style setting which can either be an option from the list or a an arbitrary value depending on the nature of the style setting.

Summary

Nested types
public final class UserStyleSetting.Option.Id Machine readable identifier for Options.

Public constructors
Option(@NonNull UserStyleSetting.Option.Id id) This constructor is unused (the parent class is sealed), but is required to make tooling happy.

Public methods
boolean	equals(Object other)
final @NonNull Collection<@NonNull UserStyleSetting>	getChildSettings() The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings.
final @NonNull UserStyleSetting.Option.Id	getId() Machine readable Id for the style setting.
int	hashCode()
@NonNull String	toString()

Public constructors

Option

Added in 1.0.0

public Option(@NonNull UserStyleSetting.Option.Id id)

This constructor is unused (the parent class is sealed), but is required to make tooling happy.

Public methods

equals

public boolean equals(Object other)

getChildSettings

Added in 1.1.0

public final @NonNull Collection<@NonNull UserStyleSetting> getChildSettings()

The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings. These must be in UserStyleSchema.userStyleSettings. Child UserStyleSettings are deemed to be active if the Option is selected by the UserStyle. This is particularly important is there are multiple ComplicationSlotsUserStyleSettings, only one of which is allowed to be active at any time.

getId

Added in 1.0.0

public final @NonNull UserStyleSetting.Option.Id getId()

Machine readable Id for the style setting. Identifier for the option (or the option itself for CustomValueUserStyleSetting.CustomValueOption), must be unique within the UserStyleSetting. Short ids are encouraged.

hashCode

public int hashCode()

toString

public @NonNull String toString()