CarIconSpan

Added in 1.0.0

Kotlin |Java

@CarProtocol
class CarIconSpan : CarSpan

kotlin.Any
↳	android.text.style.CharacterStyle
	↳	androidx.car.app.model.CarSpan
		↳	androidx.car.app.model.CarIconSpan

A span that replaces the text it is attached to with a CarIcon that is aligned with the surrounding text.

The image may be scaled with the text differently depending on the template that the text belongs to. Refer to the documentation of each template for that information.

For example, the following code creates a string for a navigation maneuver that has an image with the number of a highway rendered as an icon in between "on" and "East":

SpannableString string = new SpannableString("Turn right on 520 East");
string.setSpan(
    CarIconSpan.create(new CarIcon.Builder(
        IconCompat.createWithResource(getCarContext(), R.drawable.ic_520_highway))),
        14, 17, SPAN_INCLUSIVE_EXCLUSIVE);

CarIconSpans in strings passed to the library templates may be ignored by the host when displaying the text unless support for them is explicitly documented in the API that takes the string.

This span will be ignored if it overlaps with any span that replaces text, such as another DistanceSpan, DurationSpan, or CarIconSpan.

See also
`CarIcon`

Summary

Constants
`const Int`	`ALIGN_BASELINE = 1` A constant indicating that the bottom of this span should be aligned with the baseline of the surrounding text.
`const Int`	`ALIGN_BOTTOM = 0` A constant indicating that the bottom of this span should be aligned with the bottom of the surrounding text, at the same level as the lowest descender in the text.
`const Int`	`ALIGN_CENTER = 2` A constant indicating that this span should be vertically centered between the top and the lowest descender.

Public functions
`java-static CarIconSpan`	`create(icon: CarIcon)` Creates a `CarIconSpan` from a `CarIcon` with a default alignment of `ALIGN_BASELINE`.
`java-static CarIconSpan`	`create(icon: CarIcon, alignment: Int)` Creates a `CarIconSpan` from a `CarIcon`, specifying the alignment of the icon with respect to its surrounding text.
`Boolean`	`equals(other: Any?)`
`Int`	`getAlignment()` Returns the alignment that should be used with this span.
`CarIcon`	`getIcon()` Returns the `CarIcon` instance associated with this span.
`Int`	`hashCode()`
`String`	`toString()`

Inherited functions

From androidx.car.app.model.CarSpan

Unit

updateDrawState(tp: TextPaint)

From android.text.style.CharacterStyle

`CharacterStyle!`	`getUnderlying()`
`abstract Unit`	`updateDrawState(p: TextPaint!)`
`java-static CharacterStyle!`	`wrap(cs: CharacterStyle!)`

Constants

ALIGN_BASELINE

Added in 1.0.0

const val ALIGN_BASELINE = 1: Int

A constant indicating that the bottom of this span should be aligned with the baseline of the surrounding text.

ALIGN_BOTTOM

Added in 1.0.0

const val ALIGN_BOTTOM = 0: Int

A constant indicating that the bottom of this span should be aligned with the bottom of the surrounding text, at the same level as the lowest descender in the text.

ALIGN_CENTER

Added in 1.0.0

const val ALIGN_CENTER = 2: Int

A constant indicating that this span should be vertically centered between the top and the lowest descender.

Public functions

create

Added in 1.0.0

java-static fun create(icon: CarIcon): CarIconSpan

Creates a CarIconSpan from a CarIcon with a default alignment of ALIGN_BASELINE.

Throws
`java.lang.NullPointerException`	if `icon` is `null`

See also
`create`

create

Added in 1.0.0

java-static fun create(icon: CarIcon, alignment: Int): CarIconSpan

Creates a CarIconSpan from a CarIcon, specifying the alignment of the icon with respect to its surrounding text.

Parameters
`icon: CarIcon`	the `CarIcon` to replace the text with
`alignment: Int`	the alignment of the `CarIcon` relative to the text. This should be one of `ALIGN_BASELINE`, `ALIGN_BOTTOM` or `ALIGN_CENTER`

Throws
`java.lang.NullPointerException`	if `icon` is `null`
`java.lang.IllegalArgumentException`	if `alignment` is not a valid value

See also
`ALIGN_BASELINE`
`ALIGN_BOTTOM`
`ALIGN_CENTER`

equals

fun equals(other: Any?): Boolean

getAlignment

Added in 1.0.0

fun getAlignment(): Int

Returns the alignment that should be used with this span.

getIcon

Added in 1.0.0

fun getIcon(): CarIcon

Returns the CarIcon instance associated with this span.

hashCode

fun hashCode(): Int

toString

fun toString(): String