ForegroundCarColorSpan

public final class ForegroundCarColorSpan
extends CarSpan

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


A span that changes the color of the text to which the span is attached.

For example, to set a green text color to a span of a string:

SpannableString string = new SpannableString("Text with a foreground color span");
 string.setSpan(ForegroundCarColorSpan.create(CarColor.GREEN),
     12, 28, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE));
 

The host may ignore the color specified in the ForegroundCarColorSpan and instead use a default color unless support for ForegroundCarColorSpan is explicitly documented in the API that takes the string. Depending on contrast requirements, capabilities of the vehicle screens, or other factors, the color may also be ignored by the host or overridden by the vehicle system.

Summary

Public methods

static ForegroundCarColorSpan create(CarColor carColor)

Creates a ForegroundColorSpan from a CarColor.

boolean equals(Object other)
CarColor getColor()

Returns the CarColor associated with this span.

int hashCode()
String toString()

Inherited methods

Public methods

create

public static ForegroundCarColorSpan create (CarColor carColor)

Creates a ForegroundColorSpan from a CarColor.

Custom colors created with CarColor.createCustom(int, int) are not supported in text spans unless explicitly documented otherwise in the API that takes the string.

Parameters
carColor CarColor

Returns
ForegroundCarColorSpan

Throws
IllegalArgumentException if carColor contains a custom color
NullPointerException if carColor is null

equals

public boolean equals (Object other)

Parameters
other Object

Returns
boolean

getColor

public CarColor getColor ()

Returns the CarColor associated with this span.

Returns
CarColor

hashCode

public int hashCode ()

Returns
int

toString

public String toString ()

Returns
String