UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay
Overrides to be applied to the corresponding androidx.wear.watchface.ComplicationSlot's initial config (as specified in it's constructor) when the setting is selected.
Summary
Nested types |
|---|
public final class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay.BuilderConstructs a |
Public constructors |
|---|
This method is deprecated. This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId |
ComplicationSlotOverlay( |
Public methods |
|
|---|---|
boolean |
|
final Integer |
If non null the accessibility traversal index for this configuration. |
final ComplicationSlotBounds |
If non null, the |
final int |
The id of the |
final Integer |
If non null, the string resource identifier for name of the complication slot, for this configuration. |
final Integer |
If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. |
int |
hashCode() |
final Boolean |
If non null, whether the complication should be enabled for this configuration. |
@NonNull String |
toString() |
Public constructors
publicComplicationSlotOverlay(
int complicationSlotId,
Boolean enabled,
ComplicationSlotBounds complicationSlotBounds,
Integer accessibilityTraversalIndex
)
This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId ComplicationSlotOverlay(Int, Boolean?, ComplicationSlotBounds?, Int?, Int?, Int?
ComplicationSlotOverlay
public ComplicationSlotOverlay(
int complicationSlotId,
Boolean enabled,
ComplicationSlotBounds complicationSlotBounds,
Integer accessibilityTraversalIndex,
Integer nameResourceId,
Integer screenReaderNameResourceId
)
| Parameters | |
|---|---|
int complicationSlotId |
The id of the |
Boolean enabled |
If non null, whether the complication should be enabled for this configuration. If null then no changes are made. |
ComplicationSlotBounds complicationSlotBounds |
If non null, the |
Integer accessibilityTraversalIndex |
If non null the accessibility traversal index for this configuration. This is used to determine the order in which accessibility labels for the watch face are read to the user. |
Integer nameResourceId |
If non null, the string resource identifier for name of the complication slot, for this configuration. These strings should be short (perhaps 10 characters max) E.g. complication slots named 'left' and 'right' might be shown by the editor in a list from which the user selects a complication slot for editing. |
Integer screenReaderNameResourceId |
If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. While similar to |
Public methods
getAccessibilityTraversalIndex
public final Integer getAccessibilityTraversalIndex()
If non null the accessibility traversal index for this configuration. This is used to determine the order in which accessibility labels for the watch face are read to the user.
getComplicationSlotBounds
public final ComplicationSlotBounds getComplicationSlotBounds()
If non null, the ComplicationSlotBounds for this configuration. If null then no changes are made.
getComplicationSlotId
public final int getComplicationSlotId()
The id of the androidx.wear.watchface.ComplicationSlot to configure.
getNameResourceId
public final Integer getNameResourceId()
If non null, the string resource identifier for name of the complication slot, for this configuration. These strings should be short (perhaps 10 characters max) E.g. complication slots named 'left' and 'right' might be shown by the editor in a list from which the user selects a complication slot for editing.
getScreenReaderNameResourceId
public final Integer getScreenReaderNameResourceId()
If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. While similar to nameResourceId this string can be longer and should be more descriptive. E.g. saying 'left complication' rather than just 'left'.