SuggestionRangeSpan

Kotlin |Java

class SuggestionRangeSpan : CharacterStyle, ParcelableSpan

kotlin.Any
↳	android.text.style.CharacterStyle
	↳	android.text.style.SuggestionRangeSpan

A SuggestionRangeSpan is used to show which part of an EditText is affected by a suggestion popup window.

Summary

Public constructors
`SuggestionRangeSpan()`

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.
Unit	`setBackgroundColor(backgroundColor: Int)`
Unit	`updateDrawState(tp: TextPaint)`
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.

Properties
static Parcelable.Creator<SuggestionRangeSpan!>	`CREATOR`

Public constructors

SuggestionRangeSpan

Added in API level 33

SuggestionRangeSpan()

Public methods

describeContents

Added in API level 33

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 33

fun getBackgroundColor(): Int

getSpanTypeId

Added in API level 33

fun getSpanTypeId(): Int

Return a special type identifier for this span class.

setBackgroundColor

Added in API level 33

fun setBackgroundColor(backgroundColor: Int): Unit

updateDrawState

Added in API level 33

fun updateDrawState(tp: TextPaint): Unit

Parameters
`tp`	TextPaint: This value cannot be `null`.

writeToParcel

Added in API level 33

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`

Properties

CREATOR

Added in API level 33

static val CREATOR: Parcelable.Creator<SuggestionRangeSpan!>