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.BuilderBuilder for creating a  | 
| 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
Public methods
describeContents
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 0orCONTENTS_FILE_DESCRIPTOR | 
getExtras
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
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
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
| dest | Parcel: This value cannot benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
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 2025-02-10 UTC.
