BackgroundColorSpan

public class BackgroundColorSpan
extends CharacterStyle implements UpdateAppearance, ParcelableSpan

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


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

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

SpannableString string = new SpannableString("Text with a background color span");
string.setSpan(new BackgroundColorSpan(color), 12, 28, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
Set a background color for the text.

Summary

Inherited constants

Public constructors

BackgroundColorSpan(int color)

Creates a BackgroundColorSpan from a color integer.

BackgroundColorSpan(Parcel src)

Creates a BackgroundColorSpan from a parcel.

Public methods

int describeContents()

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

int getBackgroundColor()
int getSpanTypeId()

Return a special type identifier for this span class.

void updateDrawState(TextPaint textPaint)

Updates the background color of the TextPaint.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Public constructors

BackgroundColorSpan

added in API level 1
public BackgroundColorSpan (int color)

Creates a BackgroundColorSpan from a color integer.

Parameters
color int: color integer that defines the background color

BackgroundColorSpan

added in API level 3
public BackgroundColorSpan (Parcel src)

Creates a BackgroundColorSpan 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.

getBackgroundColor

added in API level 1
public int getBackgroundColor ()

Returns
int the background 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 background color of the TextPaint.

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.