Added in API level 1

Summary: Inherited Constants | Ctors | Methods | Inherited Methods

BackgroundColorSpan

---

Kotlin |Java

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

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

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.
String	toString() Returns a string representation of the object.
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
From class android.text.style.CharacterStyle CharacterStyle getUnderlying() Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by wrap(CharacterStyle), returns the underlying CharacterStyle. abstract void updateDrawState(TextPaint tp) static CharacterStyle wrap(CharacterStyle cs) A given CharacterStyle can only applied to a single region of a given Spanned.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.text.ParcelableSpan abstract int getSpanTypeId() Return a special type identifier for this span class.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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

See also:

• Resources.getColor(int, Resources.Theme)

BackgroundColorSpan

Added in API level 3

public BackgroundColorSpan (Parcel src)

Creates a BackgroundColorSpan from a parcel.

Parameters
src	Parcel: This value cannot 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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getBackgroundColor

Added in API level 1

public int getBackgroundColor ()

Returns
int	the background color of this span.

See also:

• BackgroundColorSpan(int)

getSpanTypeId

Added in API level 3

public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

updateDrawState

Added in API level 1

public void updateDrawState (TextPaint textPaint)

Updates the background color of the TextPaint.

Parameters
textPaint	TextPaint: This value cannot 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: This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES