Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public final class

SuggestionsInfo

extends Object
implements Parcelable
java.lang.Object
   ↳ android.view.textservice.SuggestionsInfo

Class Overview

This class contains a metadata of suggestions from the text service

Summary

Constants
int RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes() : this tells that the text service thinks the result suggestions include highly recommended ones.
int RESULT_ATTR_IN_THE_DICTIONARY Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes() : this tells that the requested word was found in the dictionary in the text service.
int RESULT_ATTR_LOOKS_LIKE_TYPO Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes() : this tells that the text service thinks the requested word looks like a typo.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator < SuggestionsInfo > CREATOR Used to make this class parcelable.
Public Constructors
SuggestionsInfo (int suggestionsAttributes, String[] suggestions)
Constructor.
SuggestionsInfo (int suggestionsAttributes, String[] suggestions, int cookie, int sequence)
Constructor.
SuggestionsInfo ( Parcel source)
Public Methods
int describeContents ()
Used to make this class parcelable.
int getCookie ()
int getSequence ()
String getSuggestionAt (int i)
int getSuggestionsAttributes ()
int getSuggestionsCount ()
void setCookieAndSequence (int cookie, int sequence)
Set the cookie and the sequence of SuggestionsInfo which are set to TextInfo from a client application
void writeToParcel ( Parcel dest, int flags)
Used to package this object into a Parcel .
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS

Added in API level 15

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes() : this tells that the text service thinks the result suggestions include highly recommended ones.

Constant Value: 4 (0x00000004)

public static final int RESULT_ATTR_IN_THE_DICTIONARY

Added in API level 14

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes() : this tells that the requested word was found in the dictionary in the text service.

Constant Value: 1 (0x00000001)

public static final int RESULT_ATTR_LOOKS_LIKE_TYPO

Added in API level 14

Flag of the attributes of the suggestions that can be obtained by getSuggestionsAttributes() : this tells that the text service thinks the requested word looks like a typo.

Constant Value: 2 (0x00000002)

Fields

public static final Creator < SuggestionsInfo > CREATOR

Added in API level 14

Used to make this class parcelable.

Public Constructors

public SuggestionsInfo (int suggestionsAttributes, String[] suggestions)

Constructor.

Parameters
suggestionsAttributes from the text service
suggestions from the text service

public SuggestionsInfo (int suggestionsAttributes, String[] suggestions, int cookie, int sequence)

Constructor.

Parameters
suggestionsAttributes from the text service
suggestions from the text service
cookie the cookie of the input TextInfo
sequence the cookie of the input TextInfo

public SuggestionsInfo ( Parcel source)

Public Methods

public int describeContents ()

Used to make this class parcelable.

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

public int getCookie ()

Returns
  • the cookie which may be set by a client application

public int getSequence ()

Returns
  • the sequence which may be set by a client application

public String getSuggestionAt (int i)

Parameters
i the id of suggestions
Returns
  • the suggestion at the specified id

public int getSuggestionsAttributes ()

Returns
  • the attributes of suggestions. This includes whether the spell checker has the word in its dictionary or not and whether the spell checker has confident suggestions for the word or not.

public int getSuggestionsCount ()

Returns
  • the count of the suggestions. If there's no suggestions at all, this method returns -1. Even if this method returns 0, it doesn't necessarily mean that there are no suggestions for the requested word. For instance, the caller could have been asked to limit the maximum number of suggestions returned.

public void setCookieAndSequence (int cookie, int sequence)

Set the cookie and the sequence of SuggestionsInfo which are set to TextInfo from a client application

Parameters
cookie the cookie of an input TextInfo
sequence the cookie of an input TextInfo

public void writeToParcel ( Parcel dest, int flags)

Used to package this object into a Parcel .

Parameters
dest The Parcel to be written.
flags The flags used for parceling.