UserStyleSetting.CustomValueUserStyleSetting

public final class UserStyleSetting.CustomValueUserStyleSetting extends UserStyleSetting

java.lang.Object
   ↳ androidx.wear.watchface.style.UserStyleSetting
     ↳ androidx.wear.watchface.style.UserStyleSetting.CustomValueUserStyleSetting

An application specific style setting. This style is ignored by the system editor. This is expected to be used in conjunction with an on watch face editor. Only a single ComplicationSlotsUserStyleSetting or LargeCustomValueUserStyleSetting is permitted in the UserStyleSchema.

The CustomValueOption can store at most Option.Id.MAX_LENGTH bytes. If you need more storage, consider using LargeCustomValueUserStyleSetting.

Summary

Nested types

An application specific custom value.

Public constructors
CustomValueUserStyleSetting(
    @NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers,
    @NonNull byte[] defaultValue
)

Constructs a CustomValueUserStyleSetting.

Public methods
@NonNull UserStyleSetting.Option

Translates an option name into an option.

Inherited methods
From androidx.wear.watchface.style.UserStyleSetting
boolean
equals(Object other)
final @NonNull Collection<@NonNull WatchFaceLayer>

Used by the style configuration UI.
final @NonNull UserStyleSetting.Option

Returns the default for when the user hasn't selected an option.
final int

The default option index, used if nothing has been selected within the options list.
final @NonNull CharSequence

Localized description string displayed under the displayName.
final @NonNull CharSequence

Localized human readable name for the element, used in the userStyle selection UI.
final Icon

Icon for use in the companion editor style selection UI.
final @NonNull UserStyleSetting.Id

Identifier for the element, must be unique.
final @NonNull List<@NonNull UserStyleSetting.Option>

List of options for this UserStyleSetting.
final UserStyleSetting.WatchFaceEditorData

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.
int
@NonNull String

Public constructors

CustomValueUserStyleSetting

public CustomValueUserStyleSetting(
    @NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers,
    @NonNull byte[] defaultValue
)

Constructs a CustomValueUserStyleSetting.

Parameters
@NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers

Used by the style configuration UI. Describes which watch face rendering layers this style affects.
@NonNull byte[] defaultValue

The default value ByteArray.

Public methods

getOptionForId

public @NonNull UserStyleSetting.Option getOptionForId(@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 Option.Id of the option
Returns
@NonNull UserStyleSetting.Option

An Option corresponding to the name. This could either be one of the options from UserStyleSettings or a newly constructed Option depending on the nature of the UserStyleSetting. If optionName is unrecognized then the default value for the setting should be returned.