ForegroundCarColorSpan

@CarProtocol
public final class ForegroundCarColorSpan extends CarSpan


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 @NonNull ForegroundCarColorSpan
create(@NonNull CarColor carColor)

Creates a ForegroundColorSpan from a CarColor.

boolean
@NonNull CarColor

Returns the CarColor associated with this span.

int
@NonNull String

Public methods

create

Added in 1.0.0
public static @NonNull ForegroundCarColorSpan create(@NonNull CarColor carColor)

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 carColor contains a custom color

java.lang.NullPointerException

if carColor is null

equals

Added in 1.4.0-rc02
public boolean equals(@Nullable Object other)

getColor

Added in 1.0.0
public @NonNull CarColor getColor()

Returns the CarColor associated with this span.

hashCode

Added in 1.4.0-rc02
public int hashCode()

toString

Added in 1.4.0-rc02
public @NonNull String toString()