UserStyleSetting.BooleanUserStyleSetting
public final class UserStyleSetting.BooleanUserStyleSetting extends UserStyleSetting
| java.lang.Object | ||
| ↳ | 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 types |
|---|
public final class UserStyleSetting.BooleanUserStyleSetting.BooleanOption extends UserStyleSetting.OptionThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
public final class UserStyleSetting.BooleanUserStyleSetting.BuilderThis class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public constructors |
|---|
This method is deprecated. Use the Builder instead |
Public methods |
|
|---|---|
final boolean |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Inherited methods |
||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public constructors
BooleanUserStyleSetting
publicBooleanUserStyleSetting(
@NonNull UserStyleSetting.Id id,
@NonNull Resources resources,
@StringRes int displayNameResourceId,
@StringRes int descriptionResourceId,
Icon icon,
@NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers,
boolean defaultValue,
UserStyleSetting.WatchFaceEditorData watchFaceEditorData
)
Constructs a BooleanUserStyleSetting where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.description are specified as resources.
| Parameters | |
|---|---|
@NonNull UserStyleSetting.Id id |
|
@NonNull Resources resources |
The |
@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 |
|
@NonNull Collection<@NonNull WatchFaceLayer> affectsWatchFaceLayers |
Used by the style configuration UI. Describes which watch face rendering layers this style affects. |
boolean defaultValue |
The default value for this BooleanUserStyleSetting. |
UserStyleSetting.WatchFaceEditorData watchFaceEditorData |
Optional data for an on watch face editor, this will not be sent to the companion and its contents may be used in preference to other fields by an on watch face editor. |
Public methods
getDefaultValue
public final boolean getDefaultValue()Returns the default value.