Android 12 Developer Preview is here! Try it out, and give us your feedback!

DistanceSpan

public final class DistanceSpan
extends CarSpan

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


A span that replaces the text it is attached to with the string representation of a Distance instance.

The Distance instance will be displayed by the host in a localized format, so that it will be consistent with the rest of the user interface where distance information are displayed.

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

String interpunct = "\\u00b7";
 SpannableString string = new SpannableString("  " + interpunct + " Point-of-Interest 1");
 string.setSpan(
   DistanceSpan.create(
     Distance.create(1000, "1.0", UNIT_KILOMETERS)), 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(
   DistanceSpan.create(
     Distance.create(1000, "1.0", UNIT_KILOMETERS)), 0, 1, SPAN_INCLUSIVE_INCLUSIVE);
 string.setSpan(ForegroundCarColorSpan.create(CarColor.BLUE), 0, 1, SPAN_EXCLUSIVE_EXCLUSIVE);
 

Summary

Public methods

static DistanceSpan create(Distance distance)

Creates a DistanceSpan from a CarIcon.

boolean equals(Object other)
Distance getDistance()

Returns the Distance instance associated with this span.

int hashCode()
String toString()

Inherited methods

Public methods

create

public static DistanceSpan create (Distance distance)

Creates a DistanceSpan from a CarIcon.

Parameters
distance Distance

Returns
DistanceSpan

equals

public boolean equals (Object other)

Parameters
other Object

Returns
boolean

getDistance

public Distance getDistance ()

Returns the Distance instance associated with this span.

Returns
Distance

hashCode

public int hashCode ()

Returns
int

toString

public String toString ()

Returns
String