Added in API level 1

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.

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

Summary

Public constructors

Creates a BackgroundColorSpan from a color integer.

Creates a BackgroundColorSpan from a parcel.

Public methods
open Int

open Int

open Int

open String

open Unit

Updates the background color of the TextPaint.

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

Flatten this object in to a Parcel.

Inherited functions

Public constructors

BackgroundColorSpan

Added in API level 1
BackgroundColorSpan(color: Int)

Creates a BackgroundColorSpan from a color integer.

Parameters
color Int: color integer that defines the background color

See Also

    BackgroundColorSpan

    Added in API level 3
    BackgroundColorSpan(src: Parcel)

    Creates a BackgroundColorSpan from a parcel.

    Parameters
    src Parcel: This value cannot be null.

    Public methods

    describeContents

    Added in API level 3
    open fun describeContents(): Int
    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

    Added in API level 1
    open fun getBackgroundColor(): Int
    Return
    Int the background color of this span.

    getSpanTypeId

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

    toString

    Added in API level 1
    open fun toString(): String
    Return
    String a string representation of the object.

    updateDrawState

    Added in API level 1
    open fun updateDrawState(textPaint: TextPaint): Unit

    Updates the background color of the TextPaint.

    Parameters
    textPaint TextPaint: This value cannot be null.

    writeToParcel

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

    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_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