ForegroundCarColorSpan
@CarProtocol
class ForegroundCarColorSpan : CarSpan
| kotlin.Any | |||
| ↳ | 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.
| See also | |
|---|---|
CarColor |
|
ForegroundColorSpan |
Summary
Public functions |
|
|---|---|
java-static ForegroundCarColorSpan |
Creates a |
Boolean |
|
CarColor |
getColor()Returns the |
Int |
hashCode() |
String |
toString() |
Inherited functions |
||||||
|---|---|---|---|---|---|---|
|
||||||
|
Public functions
create
java-static fun create(carColor: CarColor): ForegroundCarColorSpan
Creates a ForegroundColorSpan from a CarColor.
Custom colors created with createCustom are not supported in text spans unless explicitly documented otherwise in the API that takes the string.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if |
java.lang.NullPointerException |
if |