UserStyleSetting.LongRangeUserStyleSetting

public final class UserStyleSetting.LongRangeUserStyleSetting extends UserStyleSetting


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

Summary

Nested types

UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption

Represents an option a Long in the range minimumValue ..

Public fields

final long

The default value.

final long

The maximum value.

final long

The minimum value.

Public constructors

LongRangeUserStyleSetting(
    UserStyleSetting.Id id,
    Resources resources,
    @StringRes int displayNameResourceId,
    @StringRes int descriptionResourceId,
    Icon icon,
    long minimumValue,
    long maximumValue,
    Collection<WatchFaceLayer> affectsWatchFaceLayers,
    long defaultValue
)

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

Public methods

@NonNull UserStyleSetting.Option

We support all values in the range min ...

Inherited methods

From class UserStyleSetting
boolean
equals(Object other)
int
@NonNull String

Public fields

defaultValue

public final long defaultValue

The default value.

maximumValue

public final long maximumValue

The maximum value.

minimumValue

public final long minimumValue

The minimum value.

Public constructors

LongRangeUserStyleSetting

public final LongRangeUserStyleSetting(
    UserStyleSetting.Id id,
    Resources resources,
    @StringRes int displayNameResourceId,
    @StringRes int descriptionResourceId,
    Icon icon,
    long minimumValue,
    long maximumValue,
    Collection<WatchFaceLayer> affectsWatchFaceLayers,
    long defaultValue
)

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

Parameters
UserStyleSetting.Id id

Id for the element, must be unique.

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 userStyle selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size).

long minimumValue

Minimum value (inclusive).

long maximumValue

Maximum value (inclusive).

Collection<WatchFaceLayer> affectsWatchFaceLayers

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

long defaultValue

The default value for this LongRangeUserStyleSetting.

Public methods

getOptionForId

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

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