TimeFormatComplicationText.Builder

public static final class TimeFormatComplicationText.Builder
extends Object

java.lang.Object
↳	com.google.wear.services.complications.TimeFormatComplicationText.Builder

Builder for TimeFormatComplicationText.

Summary

Public constructors
`Builder()`

Public methods
`TimeFormatComplicationText`	`build()` Builds a `TimeFormatComplicationText`.
`TimeFormatComplicationText.Builder`	`setFormat(String format)` Sets the format that should be applied to the date.
`TimeFormatComplicationText.Builder`	`setStyle(int style)` Sets the style in which the time format part will be displayed.
`TimeFormatComplicationText.Builder`	`setSurroundingText(CharSequence surroundingText)` Sets the string within which the time difference will be displayed.
`TimeFormatComplicationText.Builder`	`setTimeZone(TimeZone timeZone)` Sets the time zone that will be used for the formatted time.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

Builder

public Builder ()

Public methods

build

Added in API level 36

public TimeFormatComplicationText build ()

Builds a TimeFormatComplicationText.

Returns
`TimeFormatComplicationText`

setFormat

Added in API level 36

public TimeFormatComplicationText.Builder setFormat (String format)

Sets the format that should be applied to the date. This should be a pattern as used by SimpleDateFormat.

Parameters
`format`	`String`

Returns
`TimeFormatComplicationText.Builder`

setStyle

Added in API level 36

public TimeFormatComplicationText.Builder setStyle (int style)

Sets the style in which the time format part will be displayed. If not set, defaults to TimeFormatComplicationText.STYLE_DEFAULT, which leaves the formatted date unchanged.

Parameters
`style`	`int`: Value is one of the following: `TimeFormatComplicationText.STYLE_DEFAULT` `TimeFormatComplicationText.STYLE_UPPER_CASE` `TimeFormatComplicationText.STYLE_LOWER_CASE`

Returns
`TimeFormatComplicationText.Builder`	this builder for chaining.

See also:

setSurroundingText

Added in API level 36

public TimeFormatComplicationText.Builder setSurroundingText (CharSequence surroundingText)

Sets the string within which the time difference will be displayed. This is optional.

Within the text, ^1 will be replaced with the time format, so for example to show a result like "10:00: meeting" the surrounding text would be "^1: meeting".

To use the ^ character within the text, escape it as ^^.

If the text contains spans, some of them may not be rendered by the complication drawable. Supported spans are ForegroundColorSpan, LocaleSpan, SubscriptSpan, SuperscriptSpan, StyleSpan, StrikethroughSpan, TypefaceSpan and UnderlineSpan.

Parameters
`surroundingText`	`CharSequence`: string within which the time difference value will be displayed, with `^1` in place of the time difference.

Returns
`TimeFormatComplicationText.Builder`	this builder for chaining.

setTimeZone

Added in API level 36

public TimeFormatComplicationText.Builder setTimeZone (TimeZone timeZone)

Sets the time zone that will be used for the formatted time. This is optional - if not set, the system's default time zone will be used.

Parameters
`timeZone`	`TimeZone`

Returns
`TimeFormatComplicationText.Builder`	this builder for chaining.