Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

ForegroundColorSpan

public class ForegroundColorSpan
extends CharacterStyle implements UpdateAppearance, ParcelableSpan

java.lang.Object
   ↳ android.text.style.CharacterStyle
     ↳ android.text.style.ForegroundColorSpan


Changes the color of the text to which the span is attached.

For example, to set a green text color you would create a SpannableString based on the text and set the span.

SpannableString string = new SpannableString("Text with a foreground color span");
string.setSpan(new ForegroundColorSpan(color), 12, 28, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
Set a text color.

Summary

Inherited constants

Public constructors

ForegroundColorSpan(int color)

Creates a ForegroundColorSpan from a color integer.

ForegroundColorSpan(Parcel src)

Creates a ForegroundColorSpan from a parcel.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

int getForegroundColor()
int getSpanTypeId()

Return a special type identifier for this span class.

void updateDrawState(TextPaint textPaint)

Updates the color of the TextPaint to the foreground color.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Public constructors

ForegroundColorSpan

added in API level 1
public ForegroundColorSpan (int color)

Creates a ForegroundColorSpan from a color integer.

To get the color integer associated with a particular color resource ID, use Resources.getColor(int, Resources.Theme)

Parameters
color int: color integer that defines the text color

ForegroundColorSpan

added in API level 3
public ForegroundColorSpan (Parcel src)

Creates a ForegroundColorSpan from a parcel.

Parameters
src Parcel

This value must never be null.

Public methods

describeContents

added in API level 3
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getForegroundColor

added in API level 1
public int getForegroundColor ()

Returns
int the foreground color of this span.

getSpanTypeId

added in API level 3
public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

updateDrawState

added in API level 1
public void updateDrawState (TextPaint textPaint)

Updates the color of the TextPaint to the foreground color.

Parameters
textPaint TextPaint

This value must never be null.

writeToParcel

added in API level 3
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

This value must never be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.