ComplicationsUserStyleSetting

Kotlin |Java

class ComplicationsUserStyleSetting : UserStyleSetting

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

ComplicationsUserStyleSetting is the recommended UserStyleSetting for representing complication configuration options such as the number of active complications, their location, etc... The ComplicationsOption class allows you to apply a list of ComplicationOverlays on top of the base config as specified by the androidx.wear.watchface.Complication constructor.

The ComplicationsManager listens for style changes with this setting and when a ComplicationsOption is selected the overrides are automatically applied. Note its suggested that the default ComplicationOverlay (the first entry in the list) does not apply any overrides.

Not to be confused with complication provider selection.

Summary

Nested classes
	ComplicationOverlay Overrides to be applied to the corresponding complication's initial config (as specified in androidx.wear.watchface.Complication) when the setting is selected.
	ComplicationsOption Represents an override to the initial complication configuration.

Public constructors
<init>(id: String, displayName: CharSequence, description: CharSequence, icon: Icon?, complicationConfig: List<UserStyleSetting.ComplicationsUserStyleSetting.ComplicationsOption>, affectsLayers: Collection<Layer>)

Public methods
ComplicationsUserStyleSettingWireFormat	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>

ComplicationsUserStyleSetting(
    id: String, 
    displayName: CharSequence, 
    description: CharSequence, 
    icon: Icon?, 
    complicationConfig: List<UserStyleSetting.ComplicationsUserStyleSetting.ComplicationsOption>, 
    affectsLayers: Collection<Layer>)

Public methods

toWireFormat

fun toWireFormat(): ComplicationsUserStyleSettingWireFormat