BooleanUserStyleSetting

Kotlin |Java

class BooleanUserStyleSetting : UserStyleSetting

kotlin.Any
↳	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 classes
	BooleanOption Represents a true or false option in the BooleanUserStyleSetting.

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

Public methods
Boolean	getDefaultValue() Returns the default value.
BooleanUserStyleSettingWireFormat	toWireFormat()

Inherited functions

From class UserStyleSetting UserStyleSetting.Option getDefaultOption() Returns the default for when the user hasn't selected an option. UserStyleSetting.Option getOptionForId(optionId: String) Translates an option name into an option. This will need to be overridden for userStyle categories that can't sensibly be fully enumerated (e.g. a full 24-bit color picker). 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>

BooleanUserStyleSetting(
    id: String, 
    displayName: CharSequence, 
    description: CharSequence, 
    icon: Icon?, 
    defaultValue: Boolean, 
    affectsLayers: Collection<Layer>)

Public methods

getDefaultValue

fun getDefaultValue(): Boolean

Returns the default value.

toWireFormat

fun toWireFormat(): BooleanUserStyleSettingWireFormat