LongRangeUserStyleSetting

Kotlin |Java

class LongRangeUserStyleSetting : UserStyleSetting

kotlin.Any
↳	androidx.wear.watchface.style.UserStyleSetting
	↳	androidx.wear.watchface.style.UserStyleSetting.LongRangeUserStyleSetting

A LongRangeUserStyleSetting represents a setting with a Long value in the range minimumValue..maximumValue.

Summary

Nested classes
	`LongRangeOption` Represents an option a Long in the range minimumValue..maximumValue.

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

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

Inherited functions

From class UserStyleSetting

UserStyleSetting.Option

getDefaultOption()

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

List<OptionWireFormat>

getWireFormatOptionsList()

String

toString()

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. Styling data gets shared with the companion (typically via bluetooth) so size is a consideration and short ids are encouraged. There is a maximum length see maxIdLength.
`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>

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

Public methods

getDefaultValue

fun getDefaultValue():