Android APIs
public class

SuggestionSpan

extends CharacterStyle
implements ParcelableSpan
java.lang.Object
   ↳ android.text.style.CharacterStyle
     ↳ android.text.style.SuggestionSpan

Class Overview

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.

Summary

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
public static final Creator<SuggestionSpan> CREATOR
Public Constructors
SuggestionSpan(Context context, String[] suggestions, int flags)
SuggestionSpan(Locale locale, String[] suggestions, int flags)
SuggestionSpan(Context context, Locale locale, String[] suggestions, int flags, Class<?> notificationTargetClass)
SuggestionSpan(Parcel src)
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
int getFlags()
String getLocale()
int getSpanTypeId()
Return a special type identifier for this span class.
String[] getSuggestions()
int hashCode()
Returns an integer hash code for this object.
void setFlags(int flags)
void updateDrawState(TextPaint tp)
void writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class android.text.style.CharacterStyle
From class java.lang.Object
From interface android.text.ParcelableSpan
From interface android.os.Parcelable

Constants

public static final String ACTION_SUGGESTION_PICKED

Added in API level 14

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

public static final int FLAG_AUTO_CORRECTION

Added in API level 15

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)

public static final int FLAG_EASY_CORRECT

Added in API level 14

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)

public static final int FLAG_MISSPELLED

Added in API level 14

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)

public static final int SUGGESTIONS_MAX_SIZE

Added in API level 14

Constant Value: 5 (0x00000005)

public static final String SUGGESTION_SPAN_PICKED_AFTER

Added in API level 14

Constant Value: "after"

public static final String SUGGESTION_SPAN_PICKED_BEFORE

Added in API level 14

Constant Value: "before"

public static final String SUGGESTION_SPAN_PICKED_HASHCODE

Added in API level 14

Constant Value: "hashcode"

Fields

public static final Creator<SuggestionSpan> CREATOR

Added in API level 14

Public Constructors

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

Added in API level 14

Parameters
context Context: Context for the application
suggestions String: Suggestions for the string under the span
flags int: Additional flags indicating how this span is handled in TextView

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

Added in API level 14

Parameters
locale Locale: Locale of the suggestions
suggestions String: Suggestions for the string under the span
flags int: Additional flags indicating how this span is handled in TextView

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

Added in API level 14

Parameters
context Context: Context for the application
locale Locale: locale Locale of the suggestions
suggestions String: Suggestions for the string under the span. Only the first up to SUGGESTIONS_MAX_SIZE will be considered. Null values not permitted.
flags int: Additional flags indicating how this span is handled in TextView
notificationTargetClass Class: if not null, this class will get notified when the user selects one of the suggestions.

public SuggestionSpan (Parcel src)

Added in API level 14

Parameters
src Parcel

Public Methods

public int describeContents ()

Added in API level 14

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

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object o)

Added in API level 14

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.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public int getFlags ()

Added in API level 14

Returns
int

public String getLocale ()

Added in API level 14

Returns
String the locale of the suggestions

public int getSpanTypeId ()

Added in API level 14

Return a special type identifier for this span class.

Returns
int

public String[] getSuggestions ()

Added in API level 14

Returns
String[] an array of suggestion texts for this span

public int hashCode ()

Added in API level 14

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.

Returns
int this object's hash code.

public void setFlags (int flags)

Added in API level 14

Parameters
flags int

public void updateDrawState (TextPaint tp)

Added in API level 14

Parameters
tp TextPaint

public void writeToParcel (Parcel dest, int flags)

Added in API level 14

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.