UserStyleSetting.BooleanUserStyleSetting

Artifact: androidx.wear.watchface:watchface-style

View Source

Added in 1.0.0

---

Kotlin |Java

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
public final class UserStyleSetting.BooleanUserStyleSetting.BooleanOption extends UserStyleSetting.Option 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.
BooleanUserStyleSetting(     @NonNull UserStyleSetting.Id id,     @NonNull Resources resources,     @StringRes int displayNameResourceId,     @StringRes int descriptionResourceId,     @NonNull Function0<Icon> iconProvider,     @NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers,     boolean defaultValue,     UserStyleSetting.WatchFaceEditorData watchFaceEditorData ) Constructs a BooleanUserStyleSetting with a lazily evaluated icon, where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.description are specified as resources.

Public methods
final boolean	getDefaultValue() Returns the default value.

Inherited methods

From androidx.wear.watchface.style.UserStyleSetting boolean equals(Object other) final @NonNull Collection<@NonNull WatchFaceLayer> getAffectedWatchFaceLayers() Used by the style configuration UI. final @NonNull UserStyleSetting.Option getDefaultOption() Returns the default for when the user hasn't selected an option. final int getDefaultOptionIndex() The default option index, used if nothing has been selected within the options list. final @NonNull CharSequence getDescription() Localized description string displayed under the displayName. final @NonNull CharSequence getDisplayName() Localized human readable name for the element, used in the userStyle selection UI. final Icon getIcon() Icon for use in the companion editor style selection UI. final @NonNull UserStyleSetting.Id getId() Identifier for the element, must be unique. @NonNull UserStyleSetting.Option getOptionForId(@NonNull UserStyleSetting.Option.Id optionId) Translates an option name into an option. final @NonNull List<@NonNull UserStyleSetting.Option> getOptions() List of options for this UserStyleSetting. final UserStyleSetting.WatchFaceEditorData getWatchFaceEditorData() 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 hashCode() @NonNull String toString()

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.

BooleanUserStyleSetting

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

Constructs a BooleanUserStyleSetting with a lazily evaluated icon, 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.
@NonNull Function0<Icon> iconProvider	A provider of an Icon for use in the companion userStyle selection UI. This gets lazily evaluated and is sent to the companion over bluetooth and should be small (ideally a few kb in size). Note this is not guaranteed to be called on the calling thread.
@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.