ShortTextComplicationData
class ShortTextComplicationData : ComplicationData
| kotlin.Any | ||
| ↳ | androidx.wear.watchface.complications.data.ComplicationData | |
| ↳ | androidx.wear.watchface.complications.data.ShortTextComplicationData | |
Type used for complications where the primary piece of data is a short piece of text (expected to be no more than seven characters in length). The text may be accompanied by an icon or a title or both.
If only one of icon and title is provided, it is expected that it will be displayed. If both are provided, it is expected that at least one of these will be displayed.
If a monochromaticImage and a smallImage are both specified then only one should be displayed. If the complication is drawn with a single color it's recommended to choose monochromaticImage and apply a tint. If the complication is rendered with multiple colors it's recommended to choose the smallImage. It's best practice for a ComplicationDataSource to specify both a monochromaticImage and a smallImage
A data source that wants to serve a ShortTextComplicationData must include the following meta data in its manifest (NB the value is a comma separated list):
<meta-data android:name="android.support.wearable.complications.SUPPORTED_TYPES"
android:value="SHORT_TEXT"/>
Summary
Nested types |
|---|
|
Builder for |
Public companion properties |
|
|---|---|
Int |
The maximum length of |
ComplicationType |
The |
Public functions |
|
|---|---|
open Instant |
getNextChangeInstant(afterInstant: Instant)Returns the next |
open Boolean |
Returns |
open String |
toString() |
Public properties |
|
|---|---|
ComplicationText? |
The content description field for accessibility. |
MonochromaticImage? |
A simple |
SmallImage? |
A |
ComplicationText |
The body |
ComplicationText? |
The optional title |
Inherited properties |
||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public companion properties
MAX_TEXT_LENGTH
val MAX_TEXT_LENGTH: Int
The maximum length of ShortTextComplicationData.text in characters.
Public functions
getNextChangeInstant
open fun getNextChangeInstant(afterInstant: Instant): Instant
Returns the next Instant after afterInstant at which any field of the complication may change. If there's no scheduled changes then Instant.MAX will be returned.
hasPlaceholderFields
open fun hasPlaceholderFields(): Boolean
Returns true if any of the fields of this ComplicationData are placeholders. I.e. if any fields are equal to: ComplicationText.PLACEHOLDER, SmallImage.PLACEHOLDER, MonochromaticImage.PLACEHOLDER, PhotoImageComplicationData.PLACEHOLDER, or RangedValueComplicationData.PLACEHOLDER.
Public properties
contentDescription
val contentDescription: ComplicationText?
The content description field for accessibility.
monochromaticImage
val monochromaticImage: MonochromaticImage?
A simple MonochromaticImage image that can be tinted by the watch face. If the monochromaticImage is equal to MonochromaticImage.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.
smallImage
val smallImage: SmallImage?
A SmallImage that is expected to cover a small fraction of a watch face occupied by a single complication. If the smallImage is equal to SmallImage.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.
text
val text: ComplicationText
The body ComplicationText of the complication. The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated. If the text is equal to ComplicationText.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.
title
val title: ComplicationText?
The optional title ComplicationText. The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated. If the title is equal to ComplicationText.PLACEHOLDER the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.