BackgroundColorSpan

Kotlin |Java

open class BackgroundColorSpan : CharacterStyle, ParcelableSpan, UpdateAppearance

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 android.text.SpannableString 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
`BackgroundColorSpan(src: Parcel)` Creates a `BackgroundColorSpan` from a parcel.
`BackgroundColorSpan(color: Int)` Creates a `BackgroundColorSpan` from a color integer.

Public methods
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Int	`getBackgroundColor()`
open Int	`getSpanTypeId()` Return a special type identifier for this span class.
open String	`toString()` Returns a string representation of the object.
open Unit	`updateDrawState(textPaint: TextPaint)` Updates the background color of the TextPaint.
open Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Inherited functions

From class CharacterStyle

CharacterStyle!

getUnderlying()

Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by wrap, returns the underlying CharacterStyle.

CharacterStyle!

wrap(cs: CharacterStyle!)

A given CharacterStyle can only applied to a single region of a given Spanned. If you need to attach the same CharacterStyle to multiple regions, you can use this method to wrap it with a new object that will have the same effect but be a distinct object so that it can also be attached without conflict.

Public constructors

BackgroundColorSpan

Added in API level 3

BackgroundColorSpan(src: Parcel)

Creates a BackgroundColorSpan from a parcel.

Parameters
`src`	Parcel: This value cannot be `null`.

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

Public methods

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(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`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

open fun getBackgroundColor(): Int

Return
`Int`	the background color of this span.

See Also

android.text.style.BackgroundColorSpan#BackgroundColorSpan(int)

getSpanTypeId

Added in API level 3

open fun getSpanTypeId(): Int

Return a special type identifier for this span class.

toString

Added in API level 1

open fun toString(): String

Returns a string representation of the object.

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 the following: `PARCELABLE_WRITE_RETURN_VALUE`