UserStyleSetting.BooleanUserStyleSetting

public final class UserStyleSetting.BooleanUserStyleSetting extends UserStyleSetting

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

A BooleanUserStyleSetting represents a setting with a true and a false setting.

Summary

Nested types

Represents a true or false option in the BooleanUserStyleSetting.

Public constructors
BooleanUserStyleSetting(
    @NonNull UserStyleSetting.Id id,
    @NonNull Resources resources,
    @StringRes int displayNameResourceId,
    @StringRes int descriptionResourceId,
    Icon icon,
    @NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers,
    boolean defaultValue,
    UserStyleSetting.WatchFaceEditorData watchFaceEditorData
)

Constructs a BooleanUserStyleSetting where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.description are specified as resources.

Public methods
final boolean

Returns the default value.

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.
@NonNull UserStyleSetting.Option

Translates an option name into an option.
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

BooleanUserStyleSetting

public BooleanUserStyleSetting(
    @NonNull UserStyleSetting.Id id,
    @NonNull Resources resources,
    @StringRes int displayNameResourceId,
    @StringRes int descriptionResourceId,
    Icon icon,
    @NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers,
    boolean defaultValue,
    UserStyleSetting.WatchFaceEditorData watchFaceEditorData
)

Constructs a BooleanUserStyleSetting where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.description are specified as resources.

Parameters
@NonNull UserStyleSetting.Id id

Id for the element, must be unique.
@NonNull Resources resources

The Resources from which displayNameResourceId and descriptionResourceId are loaded.
@StringRes int displayNameResourceId

String resource id for a human readable name for the element, used in the userStyle selection UI.
@StringRes int descriptionResourceId

String resource id for a human readable description string displayed under the displayName.
Icon icon

Icon for use in the companion userStyle selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size).
@NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers

Used by the style configuration UI. Describes which watch face rendering layers this style affects.
boolean defaultValue

The default value for this BooleanUserStyleSetting.
UserStyleSetting.WatchFaceEditorData 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.

Public methods

getDefaultValue

Added in 1.0.0
public final boolean getDefaultValue()

Returns the default value.