UserStyleSetting
public sealed class UserStyleSetting
UserStyleSetting.BooleanUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSetting.ColorUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSetting.ComplicationSlotsUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSetting.CustomValueUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSetting.DoubleRangeUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSetting.LargeCustomValueUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSetting.ListUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSetting.LongRangeUserStyleSetting |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Watch faces often have user configurable styles, the definition of what is a style is left up to the watch face but it typically incorporates a variety of settings such as: color, visual theme for watch hands, font, tick shape, complication slots, audio elements, etc...
A UserStyleSetting represents one of these dimensions. See also UserStyleSchema which defines the list of UserStyleSettings provided by the watch face.
Styling data gets shared with the companion phone to support editors (typically over bluetooth), as a result the size of serialized UserStyleSettings could become an issue if large.
It is possible to define a hierarchy of styles, (e.g. a watch face might have support a number of different looks, each with their own settings). A hierarchy is defined by setting child styles in ListUserStyleSetting.ListOption.childSettings. A setting is deemed to be active if it's either in the top level of the tree, or if it's the child of an Option selected by the user in the UserStyle. In a hierarchy multiple ComplicationSlotsUserStyleSetting are allowed but only one can be active at any time, for more details see UserStyleSchema.findComplicationSlotsOptionForUserStyle.
use Watch Face Format instead
Summary
Nested types |
|---|
public final class UserStyleSetting.BooleanUserStyleSetting extends UserStyleSettingThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.BooleanUserStyleSetting.BooleanOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.BooleanUserStyleSetting.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
@RequiresApi(value = 34)This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ColorUserStyleSetting.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
@RequiresApi(value = 34)This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ColorUserStyleSetting.ColorOption.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting extends UserStyleSettingThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlayThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.CustomValueUserStyleSetting extends UserStyleSettingThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.DoubleRangeUserStyleSetting extends UserStyleSettingThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.DoubleRangeUserStyleSetting.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.IdThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
@RequiresApi(value = 33)This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public class UserStyleSetting.ListUserStyleSetting extends UserStyleSettingThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ListUserStyleSetting.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ListUserStyleSetting.ListOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.ListUserStyleSetting.ListOption.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.LongRangeUserStyleSetting extends UserStyleSettingThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.LongRangeUserStyleSetting.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public abstract class UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.Option.IdThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.WatchFaceEditorDataThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public methods |
|
|---|---|
boolean |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final @NonNull Collection<@NonNull WatchFaceLayer> |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final @NonNull UserStyleSetting.Option |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final int |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final @NonNull CharSequence |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final @NonNull CharSequence |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final Icon |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final @NonNull UserStyleSetting.Id |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
@NonNull UserStyleSetting.Option |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final @NonNull List<@NonNull UserStyleSetting.Option> |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final UserStyleSetting.WatchFaceEditorData |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
int |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
@NonNull String |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public methods
getAffectedWatchFaceLayers
public final @NonNull Collection<@NonNull WatchFaceLayer>getAffectedWatchFaceLayers()
Used by the style configuration UI. Describes which rendering layers this style affects.
getDefaultOption
public final @NonNull UserStyleSetting.OptiongetDefaultOption()
Returns the default for when the user hasn't selected an option.
getDefaultOptionIndex
public final int getDefaultOptionIndex()The default option index, used if nothing has been selected within the options list.
getDescription
public final @NonNull CharSequencegetDescription()
Localized description string displayed under the displayName.
getDisplayName
public final @NonNull CharSequencegetDisplayName()
Localized human readable name for the element, used in the userStyle selection UI.
getIcon
public final IcongetIcon()
Icon for use in the companion editor style selection UI.
getId
public final @NonNull UserStyleSetting.IdgetId()
Identifier for the element, must be unique. Styling data gets shared with the companion (typically via bluetooth) so size is a consideration and short ids are encouraged. There is a maximum length see UserStyleSetting.Id.MAX_LENGTH.
getOptionForId
public @NonNull UserStyleSetting.OptiongetOptionForId(@NonNull UserStyleSetting.Option.Id optionId)
Translates an option name into an option. This will need to be overridden for userStyle categories that can't sensibly be fully enumerated (e.g. a full 24-bit color picker).
| Parameters | |
|---|---|
@NonNull UserStyleSetting.Option.Id optionId |
The |
| Returns | |
|---|---|
@NonNull UserStyleSetting.Option |
An |
getOptions
public final @NonNull List<@NonNull UserStyleSetting.Option>getOptions()
List of options for this UserStyleSetting. Depending on the type of UserStyleSetting this may be an exhaustive list, or just examples to populate a ListView in case the UserStyleSetting isn't supported by the UI (e.g. a new WatchFace with an old companion).
getWatchFaceEditorData
public final UserStyleSetting.WatchFaceEditorDatagetWatchFaceEditorData()
Optional data for an on watch face editor, this will not be sent to the companion and its contents may be used in preference to other fields by an on watch face editor.