UserStyle
class UserStyle : Map
An immutable representation of user style choices that maps each UserStyleSetting to UserStyleSetting.Option.
This is intended for use by the WatchFace and entries are the same as the ones specified in the UserStyleSchema. This means you can't serialize a UserStyle directly, instead you need to use a UserStyleData (see toUserStyleData).
To modify the user style, you should call toMutableUserStyle and construct a new UserStyle instance with MutableUserStyle.toUserStyle.
Summary
Public constructors |
|---|
UserStyle(Constructs a |
|
Constructs a copy of the |
UserStyle(userStyle: UserStyleData, styleSchema: UserStyleSchema)Constructs a |
Public functions |
|
|---|---|
open Boolean |
containsKey(key: UserStyleSetting) |
open Boolean |
containsValue(value: UserStyleSetting.Option) |
open operator Boolean |
|
open operator UserStyleSetting.Option? |
get(key: UserStyleSetting)Returns the |
operator UserStyleSetting.Option? |
get(settingId: UserStyleSetting.Id)Returns the |
open Int |
hashCode() |
open Boolean |
isEmpty() |
MutableUserStyle |
Returns a mutable instance initialized with the same mapping. |
open String |
toString() |
UserStyleData |
Returns the style as a |
Public properties |
|
|---|---|
open Set<Map.Entry<UserStyleSetting, UserStyleSetting.Option>> |
|
open Set<UserStyleSetting> |
|
open Int |
The number of entries in the style. |
open Collection<UserStyleSetting.Option> |
Inherited functions |
||||
|---|---|---|---|---|
|
Public constructors
UserStyle
UserStyle(
selectedOptions: Map<UserStyleSetting, UserStyleSetting.Option>
)
Constructs a UserStyle with the given selected options for each setting.
A copy of the selectedOptions map will be created, so that changed to the map will not be reflected by this object.
| Parameters | |
|---|---|
selectedOptions: Map<UserStyleSetting, UserStyleSetting.Option> |
The |
UserStyle
UserStyle(userStyle: UserStyle)
Constructs a copy of the UserStyle. It is backed by the same map.
UserStyle
UserStyle(userStyle: UserStyleData, styleSchema: UserStyleSchema)
Constructs a UserStyle from a UserStyleData and the UserStyleSchema. Unrecognized style settings will be ignored. Unlisted style settings will be initialized with that setting's default option.
| Parameters | |
|---|---|
userStyle: UserStyleData |
The |
styleSchema: UserStyleSchema |
The |
Public functions
get
open operator fun get(key: UserStyleSetting): UserStyleSetting.Option?
Returns the UserStyleSetting.Option for key if there is one or null otherwise.
get
operator fun get(settingId: UserStyleSetting.Id): UserStyleSetting.Option?
Returns the UserStyleSetting.Option for settingId if there is one or null otherwise. Note this is an O(n) operation.
toMutableUserStyle
fun toMutableUserStyle(): MutableUserStyle
Returns a mutable instance initialized with the same mapping.
toUserStyleData
fun toUserStyleData(): UserStyleData
Returns the style as a UserStyleData.