UserStyleSetting.DoubleRangeUserStyleSetting

public final class UserStyleSetting.DoubleRangeUserStyleSetting extends UserStyleSetting

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

A DoubleRangeUserStyleSetting represents a setting with a Double value in the range [minimumValue .. maximumValue].

Summary

Nested types

Represents an option as a Double in the range minimumValue .. maximumValue.

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

Constructs a DoubleRangeUserStyleSetting where DoubleRangeUserStyleSetting.displayName and DoubleRangeUserStyleSetting.description are specified as resources.
DoubleRangeUserStyleSetting(
    @NonNull UserStyleSetting.Id id,
    @NonNull Resources resources,
    @StringRes int displayNameResourceId,
    @StringRes int descriptionResourceId,
    @NonNull Function0<Icon> iconProvider,
    double minimumValue,
    double maximumValue,
    @NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers,
    double defaultValue,
    UserStyleSetting.WatchFaceEditorData watchFaceEditorData
)

Constructs a DoubleRangeUserStyleSetting with a lazily evaluated Icon, where DoubleRangeUserStyleSetting.displayName and DoubleRangeUserStyleSetting.description are specified as resources.

Public methods
final double

Returns the default value.
final double

Returns the maximum value.
final double

Returns the minimum value.
@NonNull UserStyleSetting.Option

We support all values in the range min ... max not just min & max.

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

DoubleRangeUserStyleSetting

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

Constructs a DoubleRangeUserStyleSetting where DoubleRangeUserStyleSetting.displayName and DoubleRangeUserStyleSetting.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).
double minimumValue

Minimum value (inclusive).
double maximumValue

Maximum value (inclusive).
@NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers

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

The default value for this DoubleRangeUserStyleSetting.
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.

DoubleRangeUserStyleSetting

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

Constructs a DoubleRangeUserStyleSetting with a lazily evaluated Icon, where DoubleRangeUserStyleSetting.displayName and DoubleRangeUserStyleSetting.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.
double minimumValue

Minimum value (inclusive).
double maximumValue

Maximum value (inclusive).
@NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers

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

The default value for this DoubleRangeUserStyleSetting.
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 double getDefaultValue()

Returns the default value.

getMaximumValue

Added in 1.0.0
public final double getMaximumValue()

Returns the maximum value.

getMinimumValue

Added in 1.0.0
public final double getMinimumValue()

Returns the minimum value.

getOptionForId

public @NonNull UserStyleSetting.Option getOptionForId(@NonNull UserStyleSetting.Option.Id optionId)

We support all values in the range min ... max not just min & max.