TextAttribute

public final class TextAttribute
extends Object implements Parcelable

java.lang.Object
   ↳ 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

class TextAttribute.Builder

Builder for creating a TextAttribute. 

Inherited constants

Fields

public static final Creator<TextAttribute> CREATOR

Public methods

int describeContents()

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

PersistableBundle getExtras()

Get the extras data.

List<String> getTextConversionSuggestions()

Get the list of text conversion suggestions.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 33 
 public static final Creator<TextAttribute> CREATOR

Public methods

describeContents

Added in API level 33 
 public int describeContents ()

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.

Returns
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 
 public PersistableBundle getExtras ()

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

Returns
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 
 public List<String> getTextConversionSuggestions ()

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

Returns
List<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.

writeToParcel

Added in API level 33 
 public void writeToParcel (Parcel dest, int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES