BackgroundColorSpan

open class BackgroundColorSpan : CharacterStyle, UpdateAppearance, ParcelableSpan
kotlin.Any
   ↳ 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 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

Public constructors
<init>(color: Int)

Creates a BackgroundColorSpan from a color integer.

<init>(src: Parcel)

Creates a BackgroundColorSpan from a parcel.

Public methods
open Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

open Int

Return a special type identifier for this span class.

open Unit

Updates the background color of the TextPaint.

open Int

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

open Int

Inherited functions

Public constructors

<init>

BackgroundColorSpan(color: Int)

Creates a BackgroundColorSpan from a color integer.

Parameters
color Int: color integer that defines the background color

See Also

  • android.content.res.Resources#getColor(int, Resources.Theme)

<init>

BackgroundColorSpan(src: Parcel)

Creates a BackgroundColorSpan from a parcel.

Parameters
src Parcel: This value must never be null.

Public methods

writeToParcel

added in API level 3
open fun writeToParcel(dest: Parcel, flags: Int): Unit

Flatten this object in to a Parcel.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
dest Parcel: This value must never be null.
flags Parcel: Additional flags about how the object should be written. May be 0 or #PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

getSpanTypeId

added in API level 3
open fun getSpanTypeId(): Int

Return a special type identifier for this span class.
Requires API level 3 (Android 1.5, Cupcake) Requires API level 3 (Android 1.5, Cupcake)

updateDrawState

open fun updateDrawState(textPaint: TextPaint): Unit

Updates the background color of the TextPaint.

Parameters
textPaint TextPaint: This value must never be null.

describeContents

added in API level 3
open fun describeContents(): Int

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. Requires API level 3 (Android 1.5, Cupcake)

Return
Int: a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getBackgroundColor

open fun getBackgroundColor(): Int
Return
Int: the background color of this span.