RangedValueComplicationData.Builder
public final class RangedValueComplicationData.Builder
Builder for RangedValueComplicationData.
You must at a minimum set the min, max and contentDescription fields, at least one of value or dynamicValue, and at least one of monochromaticImage, smallImage, text or title.
Summary
Public constructors |
|---|
@RequiresApi(value = 34)Creates a |
Builder(Creates a |
@RequiresApi(value = 33)Creates a |
Public methods |
|
|---|---|
@NonNull RangedValueComplicationData |
build()Builds the |
final @NonNull RangedValueComplicationData.Builder |
setColorRamp(ColorRamp colorRamp)Sets an optional hint that the renderer should draw the progress bar using the |
final @NonNull RangedValueComplicationData.Builder |
setMonochromaticImage(MonochromaticImage monochromaticImage)Sets optional icon associated with the complication data. |
final @NonNull RangedValueComplicationData.Builder |
setSmallImage(SmallImage smallImage)Sets optional image associated with the complication data. |
final @NonNull RangedValueComplicationData.Builder |
setTapAction(PendingIntent tapAction)Sets optional pending intent to be invoked when the complication is tapped. |
final @NonNull RangedValueComplicationData.Builder |
setText(ComplicationText text)Sets optional text associated with the complication data. |
final @NonNull RangedValueComplicationData.Builder |
setTitle(ComplicationText title)Sets optional title associated with the complication data. |
final @NonNull RangedValueComplicationData.Builder |
setValidTimeRange(TimeRange validTimeRange)Sets optional time range during which the complication has to be shown. |
final @NonNull RangedValueComplicationData.Builder |
setValueType(int valueType)Sets the semantic meaning of |
Public constructors
Builder
@RequiresApi(value = 34)
public Builder(
@NonNull DynamicBuilders.DynamicFloat dynamicValue,
float min,
float max,
@NonNull ComplicationText contentDescription
)
Creates a Builder for a RangedValueComplicationData with a DynamicFloat value, and no fallbackValue for API levels known to support dynamic values.
| Parameters | |
|---|---|
@NonNull DynamicBuilders.DynamicFloat dynamicValue |
The |
float min |
The minimum value. For |
float max |
The maximum value. This must be less than |
@NonNull ComplicationText contentDescription |
Defines localized text that briefly describes content of the complication. This property is used primarily for accessibility. Since some complications do not have textual representation this attribute can be used for providing such. Please do not include the word 'complication' in the description. |
Builder
public Builder(
float value,
float min,
float max,
@NonNull ComplicationText contentDescription
)
Creates a Builder for a RangedValueComplicationData with a Float value.
| Parameters | |
|---|---|
float value |
The value of the ranged complication which should be in the range [ |
float min |
The minimum value. For |
float max |
The maximum value. This must be less than |
@NonNull ComplicationText contentDescription |
Defines localized text that briefly describes content of the complication. This property is used primarily for accessibility. Since some complications do not have textual representation this attribute can be used for providing such. Please do not include the word 'complication' in the description. |
Builder
@RequiresApi(value = 33)
public Builder(
@NonNull DynamicBuilders.DynamicFloat dynamicValue,
float fallbackValue,
float min,
float max,
@NonNull ComplicationText contentDescription
)
Creates a Builder for a RangedValueComplicationData with a DynamicFloat value.
| Parameters | |
|---|---|
@NonNull DynamicBuilders.DynamicFloat dynamicValue |
The |
float fallbackValue |
The fallback value of the ranged complication used on systems that don't support This is only relevant before IMPORTANT: This is only used when the system does not support |
float min |
The minimum value. For |
float max |
The maximum value. This must be less than |
@NonNull ComplicationText contentDescription |
Defines localized text that briefly describes content of the complication. This property is used primarily for accessibility. Since some complications do not have textual representation this attribute can be used for providing such. Please do not include the word 'complication' in the description. |
Public methods
build
public @NonNull RangedValueComplicationData build()
Builds the RangedValueComplicationData.
setColorRamp
public final @NonNull RangedValueComplicationData.Builder setColorRamp(ColorRamp colorRamp)
Sets an optional hint that the renderer should draw the progress bar using the ColorRamp.
setMonochromaticImage
public final @NonNull RangedValueComplicationData.Builder setMonochromaticImage(MonochromaticImage monochromaticImage)
Sets optional icon associated with the complication data.
setSmallImage
public final @NonNull RangedValueComplicationData.Builder setSmallImage(SmallImage smallImage)
Sets optional image associated with the complication data.
setTapAction
public final @NonNull RangedValueComplicationData.Builder setTapAction(PendingIntent tapAction)
Sets optional pending intent to be invoked when the complication is tapped.
setText
public final @NonNull RangedValueComplicationData.Builder setText(ComplicationText text)
Sets optional text associated with the complication data.
setTitle
public final @NonNull RangedValueComplicationData.Builder setTitle(ComplicationText title)
Sets optional title associated with the complication data.
setValidTimeRange
public final @NonNull RangedValueComplicationData.Builder setValidTimeRange(TimeRange validTimeRange)
Sets optional time range during which the complication has to be shown.
setValueType
public final @NonNull RangedValueComplicationData.Builder setValueType(int valueType)
Sets the semantic meaning of value. The complication renderer may choose to visually differentiate between the different types, for example rendering a dot on a line/arc to indicate the value for a TYPE_RATING. Defaults to TYPE_UNDEFINED if not set.