SuggestionSpan

See also:

• TextView.isSuggestionsEnabled()

ACTION_SUGGESTION_PICKED

public static final String ACTION_SUGGESTION_PICKED

This constant was deprecated in API level 29.
For IMEs to receive this kind of user interaction signals, implement IMEs' own suggestion picker UI instead of relying on SuggestionSpan. To retrieve bounding boxes for each character of the composing text, use CursorAnchorInfo.

This action is deprecated in Build.VERSION_CODES.Q.

Constant Value: "android.text.style.SUGGESTION_PICKED"

FLAG_AUTO_CORRECTION

public static final 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. This type of suggestion is rendered differently to indicate the auto correction is happening.

Constant Value: 4 (0x00000004)

FLAG_EASY_CORRECT

public static final int FLAG_EASY_CORRECT

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.

Constant Value: 1 (0x00000001)

FLAG_GRAMMAR_ERROR

public static final int FLAG_GRAMMAR_ERROR

Sets this flag if the suggestions apply to a grammar error. This type of suggestion is rendered differently to highlight the error.

Constant Value: 8 (0x00000008)

FLAG_MISSPELLED

public static final int FLAG_MISSPELLED

Sets this flag if the suggestions apply to a misspelled word/text. This type of suggestion is rendered differently to highlight the error.

Constant Value: 2 (0x00000002)

SUGGESTIONS_MAX_SIZE

public static final int SUGGESTIONS_MAX_SIZE

Constant Value: 5 (0x00000005)

SUGGESTION_SPAN_PICKED_AFTER

public static final String SUGGESTION_SPAN_PICKED_AFTER

This constant was deprecated in API level 29.
See ACTION_SUGGESTION_PICKED.

This is deprecated in Build.VERSION_CODES.Q.

Constant Value: "after"

SUGGESTION_SPAN_PICKED_BEFORE

public static final String SUGGESTION_SPAN_PICKED_BEFORE

This constant was deprecated in API level 29.
See ACTION_SUGGESTION_PICKED.

This is deprecated in Build.VERSION_CODES.Q.

Constant Value: "before"

SUGGESTION_SPAN_PICKED_HASHCODE

public static final String SUGGESTION_SPAN_PICKED_HASHCODE

This constant was deprecated in API level 29.
See ACTION_SUGGESTION_PICKED.

This is deprecated in Build.VERSION_CODES.Q.

Constant Value: "hashcode"

CREATOR

public static final Creator<SuggestionSpan> CREATOR

SuggestionSpan

public SuggestionSpan (Context context, 
                String[] suggestions, 
                int flags)

SuggestionSpan

public SuggestionSpan (Locale locale, 
                String[] suggestions, 
                int flags)

SuggestionSpan

public SuggestionSpan (Context context, 
                Locale locale, 
                String[] suggestions, 
                int flags, 
                Class<?> notificationTargetClass)

SuggestionSpan

public SuggestionSpan (Parcel src)

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.

equals

public boolean equals (Object o)

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

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getFlags

public int getFlags ()

getLocale

public String getLocale ()

This method was deprecated in API level 24.
use getLocaleObject() instead.

getLocaleObject

public Locale getLocaleObject ()

Returns a well-formed BCP 47 language tag representation of the suggestions, as a Locale object.

Caveat: The returned object is guaranteed to be a a well-formed BCP 47 language tag representation. For example, this method can return an empty locale rather than returning a malformed data when this object is initialized with an malformed Locale object, e.g. new Locale(" a ", " b c d ", " ".

getSpanTypeId

public int getSpanTypeId ()

Return a special type identifier for this span class.

getSuggestions

public String[] getSuggestions ()

getUnderlineColor

public int getUnderlineColor ()

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

setFlags

public void setFlags (int flags)

updateDrawState

public void updateDrawState (TextPaint tp)

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.