public final class TextAttribute
extends Object implements Parcelable


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

From interface android.os.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(Parcel, int): 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)".

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.

boolean isTextSuggestionSelected()

Get whether the text is undergoing a text candidate selection, relevant for CJK languages.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface android.os.Parcelable

abstract int describeContents()

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

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

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

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.

isTextSuggestionSelected

Added in API level 33 

public boolean isTextSuggestionSelected ()

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).

Returns
boolean True if the current text is currently in a state of selecting a suggestion.

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

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-02-26 UTC.