DurationSpan

Added in 1.0.0

Kotlin |Java

@CarProtocol
public final class DurationSpan extends CarSpan

java.lang.Object
↳	android.text.style.CharacterStyle
	↳	androidx.car.app.model.CarSpan
		↳	androidx.car.app.model.DurationSpan

A span that replaces the text it is attached to with a localized duration string.

For example, the following code creates a string that shows the duration as the first text in the string before the interpunct:

String interpunct = "\\u00b7";
SpannableString string = new SpannableString("  " + interpunct + " Point-of-Interest 1");
string.setSpan(DurationSpan.create(300), 0, 1, SPAN_INCLUSIVE_INCLUSIVE);

The span flags (e.g. SPAN_EXCLUSIVE_EXCLUSIVE) will be ignored.

This span will be ignored if it overlaps with any span that replaces text, such as another DistanceSpan, DurationSpan, or CarIconSpan. However, it is possible to * apply styling to the text, such as changing colors:

String interpunct = "\\u00b7";
SpannableString string = new SpannableString("  " + interpunct + " Point-of-Interest 1");
string.setSpan(DurationSpan.create(300), 0, 1, SPAN_INCLUSIVE_INCLUSIVE);
string.setSpan(ForegroundCarColorSpan.create(CarColor.BLUE), 0, 1, SPAN_EXCLUSIVE_EXCLUSIVE);

Summary

Public methods
`static @NonNull DurationSpan`	`@RequiresApi(value = 26) create(@NonNull Duration duration)` Creates a `DurationSpan` with the given duration.
`static @NonNull DurationSpan`	`create(long durationSeconds)` Creates a `DurationSpan` with the given duration.
`boolean`	`equals(@Nullable Object other)`
`long`	`getDurationSeconds()` Returns the time duration associated with this span, in seconds.
`int`	`hashCode()`
`@NonNull String`	`toString()`

Inherited methods

From androidx.car.app.model.CarSpan

void

updateDrawState(@NonNull TextPaint tp)

From android.text.style.CharacterStyle

`CharacterStyle`	`getUnderlying()`
`abstract void`	`updateDrawState(TextPaint p)`
`static CharacterStyle`	`wrap(CharacterStyle cs)`

Public methods

create

Added in 1.0.0

@RequiresApi(value = 26)
public static @NonNull DurationSpan create(@NonNull Duration duration)

Creates a DurationSpan with the given duration.

create

Added in 1.0.0

public static @NonNull DurationSpan create(long durationSeconds)

Creates a DurationSpan with the given duration.

equals

public boolean equals(@Nullable Object other)

getDurationSeconds

Added in 1.0.0

public long getDurationSeconds()

Returns the time duration associated with this span, in seconds.

hashCode

public int hashCode()

toString

public @NonNull String toString()