| java.lang.Object | ||
| ↳ | android.text.style.CharacterStyle | |
| ↳ | android.text.style.SuggestionSpan | |
Holds suggestion candidates for the text enclosed in this span. When such a span is edited in an EditText, double tapping on the text enclosed in this span will display a popup dialog listing suggestion replacement for that text. The user can then replace the original text by one of the suggestions. These spans should typically be created by the input method to provide correction and alternates for the text.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ACTION_SUGGESTION_PICKED | ||||||||||
| int | FLAG_AUTO_CORRECTION | Sets this flag if the auto correction is about to be applied to a word/text that the user is typing/composing. | |||||||||
| int | FLAG_EASY_CORRECT | Sets this flag if the suggestions should be easily accessible with few interactions. | |||||||||
| int | FLAG_MISSPELLED | Sets this flag if the suggestions apply to a misspelled word/text. | |||||||||
| int | SUGGESTIONS_MAX_SIZE | ||||||||||
| String | SUGGESTION_SPAN_PICKED_AFTER | ||||||||||
| String | SUGGESTION_SPAN_PICKED_BEFORE | ||||||||||
| String | SUGGESTION_SPAN_PICKED_HASHCODE | ||||||||||
| 
         
          [Expand]
         
          
          Inherited Constants
          
         | 
       |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
         
           
         
         From interface
         
          android.os.Parcelable
         
          | 
       |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 
          | 
        CREATOR | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 
          | 
        
          
          Describe the kinds of special objects contained in this Parcelable's
 marshalled representation.
          
         | 
       ||||||||||
| 
          | 
        
          
          Compares this instance with the specified object and indicates if they
 are equal.
          
         | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          
          Return a special type identifier for this span class.
          
         | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          
          Returns an integer hash code for this object.
          
         | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          | 
       ||||||||||
| 
          | 
        
          
          Flatten this object in to a Parcel.
          
         | 
       ||||||||||
| 
         
          [Expand]
         
          
          Inherited Methods
          
         | 
       |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
         
           
         
         From class
         
          android.text.style.CharacterStyle
         
          | 
       |||||||||||
         
           
         
         From class
         
          java.lang.Object
         
          | 
       |||||||||||
         
           
         
         From interface
         
          android.os.Parcelable
         
          | 
       |||||||||||
         
           
         
         From interface
         
          android.text.ParcelableSpan
         
          | 
       |||||||||||
Sets this flag if the auto correction is about to be applied to a word/text that the user is typing/composing. This type of suggestion is rendered differently to indicate the auto correction is happening.
Sets this flag if the suggestions should be easily accessible with few interactions. This flag should be set for every suggestions that the user is likely to use.
Sets this flag if the suggestions apply to a misspelled word/text. This type of suggestion is rendered differently to highlight the error.
| context | Context for the application | 
|---|---|
| suggestions | Suggestions for the string under the span | 
| flags | Additional flags indicating how this span is handled in TextView | 
| locale | Locale of the suggestions | 
|---|---|
| suggestions | Suggestions for the string under the span | 
| flags | Additional flags indicating how this span is handled in TextView | 
| context | Context for the application | 
|---|---|
| locale | locale Locale of the suggestions | 
| suggestions | 
           Suggestions for the string under the span. Only the first up to
           
            
             SUGGESTIONS_MAX_SIZE
            
           
           will be considered. Null values not permitted.
           | 
         
| flags | Additional flags indicating how this span is handled in TextView | 
| notificationTargetClass | if not null, this class will get notified when the user selects one of the suggestions. | 
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
         Compares this instance with the specified object and indicates if they
 are equal. In order to be equal,
         
          o
         
         must represent the same object
 as this instance using a class-specific comparison. The general contract
 is that this comparison should be reflexive, symmetric, and transitive.
 Also, no object reference other than null is equal to null.
        
         The default implementation returns
         
          true
         
         only if
         
          this ==
 o
         
         . See
         
          Writing a correct
          
           equals
          
          method
         
         if you intend implementing your own
         
          equals
         
         method.
        
         The general contract for the
         
          equals
         
         and
         
          
           hashCode()
          
         
         methods is that if
         
          equals
         
         returns
         
          true
         
         for
 any two objects, then
         
          hashCode()
         
         must return the same value for
 these objects. This means that subclasses of
         
          Object
         
         usually
 override either both methods or neither of them.
        
| o | the object to compare this instance with. | 
|---|
           true
          
          if the specified object is equal to this
          
           Object
          
          ;
          
           false
          
          otherwise.
         Return a special type identifier for this span class.
         Returns an integer hash code for this object. By contract, any two
 objects for which
         
          
           equals(Object)
          
         
         returns
         
          true
         
         must return
 the same hash code value. This means that subclasses of
         
          Object
         
         usually override both methods or neither method.
        
Note that hash values must not change over time unless information used in equals comparisons also changes.
         See
         
          Writing a correct
          
           hashCode
          
          method
         
         if you intend implementing your own
         
          hashCode
         
         method.
        
Flatten this object in to a Parcel.
| dest | The Parcel in which the object should be written. | 
|---|---|
| flags | 
           Additional flags about how the object should be written.
 May be 0 or
           
            
             PARCELABLE_WRITE_RETURN_VALUE
            
           
           .
           |