DoubleRangeUserStyleSetting

Kotlin |Java

class DoubleRangeUserStyleSetting : UserStyleSetting

kotlin.Any
↳	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 classes
	`DoubleRangeOption` Represents an option as a Double in the range minimumValue..maximumValue.

Public constructors
`<init>(id: String, displayName: CharSequence, description: CharSequence, icon: Icon?, minimumValue: Double, maximumValue: Double, defaultValue: Double, affectsLayers: Collection<Layer>)`

Public methods
Double	`getDefaultValue()` Returns the default value.
Double	`getMaximumValue()` Returns the maximum value.
Double	`getMinimumValue()` Returns the minimum value.
UserStyleSetting.Option	`getOptionForId(optionId: String)` We support all values in the range min...max not just min & max.
DoubleRangeUserStyleSettingWireFormat	`toWireFormat()`

Inherited functions

From class UserStyleSetting

UserStyleSetting.Option

getDefaultOption()

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

List<OptionWireFormat>

getWireFormatOptionsList()

Inherited properties

From class UserStyleSetting

`Collection<Layer>`	`affectsLayers` Used by the style configuration UI. Describes which rendering layers this style affects.
`Int`	`defaultOptionIndex` The default option index, used if nothing has been selected within the options list.
`CharSequence`	`description` Localized description string displayed under the displayName.
`CharSequence`	`displayName` Localized human readable name for the element, used in the userStyle selection UI.
`Icon?`	`icon` Icon for use in the style selection UI.
`String`	`id` Identifier for the element, must be unique.
`List<UserStyleSetting.Option>`	`options` 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).

Public constructors

<init>

DoubleRangeUserStyleSetting(
    id: String, 
    displayName: CharSequence, 
    description: CharSequence, 
    icon: Icon?, 
    minimumValue: Double, 
    maximumValue: Double, 
    defaultValue: Double, 
    affectsLayers: Collection<Layer>)

Public methods

getDefaultValue

fun getDefaultValue(): Double

Returns the default value.

getMaximumValue

fun getMaximumValue(): Double

Returns the maximum value.

getMinimumValue

fun getMinimumValue(): Double

Returns the minimum value.

getOptionForId

fun getOptionForId(optionId: String): UserStyleSetting.Option

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

toWireFormat

fun toWireFormat(): DoubleRangeUserStyleSettingWireFormat