TextAttribute

Kotlin |Java

class TextAttribute : Parcelable

kotlin.Any
↳	android.view.inputmethod.TextAttribute

The data class that IME can take extra information to applications when setting the text. See InputConnection.commitText(CharSequence, int, TextAttribute) and InputConnection.setComposingRegion(int, int, TextAttribute) and InputConnection.setComposingText(CharSequence, int, TextAttribute)

Summary

Nested classes
	`Builder` Builder for creating a `TextAttribute`.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
PersistableBundle	`getExtras()` Get the extras data.
MutableList<String!>	`getTextConversionSuggestions()` Get the list of text conversion suggestions.
Boolean	`isTextSuggestionSelected()` Get whether the text is undergoing a text candidate selection, relevant for CJK languages.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

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`

getExtras

Added in API level 33

fun getExtras(): PersistableBundle

Get the extras data. More extras data details in Builder.setExtras(PersistableBundle).

Return
`PersistableBundle`	Extras data. If the Bundle is empty, it means that IME not set this field or IME didn't have extras data. This value cannot be `null`.

getTextConversionSuggestions

Added in API level 33

fun getTextConversionSuggestions(): MutableList<String!>

Get the list of text conversion suggestions. More text conversion details in Builder.setTextConversionSuggestions(List).

Return
`MutableList<String!>`	List of text conversion suggestions. If the list is empty, it means that IME not set this field or IME didn't have suggestions for applications. This value cannot be `null`.

isTextSuggestionSelected

Added in API level 33

fun isTextSuggestionSelected(): Boolean

Get whether the text is undergoing a text candidate selection, relevant for CJK languages. This describes a state when user going through a list of text conversion candidates. Builder.setTextSuggestionSelected(boolean).

Return
`Boolean`	True if the current text is currently in a state of selecting a suggestion.

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<TextAttribute!>