SentenceSuggestionsInfo

public final class SentenceSuggestionsInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.textservice.SentenceSuggestionsInfo


This class contains a metadata of suggestions returned from a text service (e.g. SpellCheckerService). The text service uses this class to return the suggestions for a sentence. See SuggestionsInfo which is used for suggestions for a word. This class extends the functionality of SuggestionsInfo as far as this class enables you to put multiple SuggestionsInfos on a sentence with the offsets and the lengths of all SuggestionsInfos.

Summary

Inherited constants

Fields

public static final Creator<SentenceSuggestionsInfo> CREATOR

Used to make this class parcelable.

Public constructors

SentenceSuggestionsInfo(SuggestionsInfo[] suggestionsInfos, int[] offsets, int[] lengths)

Constructor.

SentenceSuggestionsInfo(Parcel source)

Public methods

int describeContents()

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

int getLengthAt(int i)
int getOffsetAt(int i)
int getSuggestionsCount()
SuggestionsInfo getSuggestionsInfoAt(int i)
void writeToParcel(Parcel dest, int flags)

Used to package this object into a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 16
public static final Creator<SentenceSuggestionsInfo> CREATOR

Used to make this class parcelable.

Public constructors

SentenceSuggestionsInfo

Added in API level 16
public SentenceSuggestionsInfo (SuggestionsInfo[] suggestionsInfos, 
                int[] offsets, 
                int[] lengths)

Constructor.

Parameters
suggestionsInfos SuggestionsInfo: from the text service

offsets int: the array of offsets of suggestions

lengths int: the array of lengths of suggestions

SentenceSuggestionsInfo

Added in API level 16
public SentenceSuggestionsInfo (Parcel source)

Parameters
source Parcel

Public methods

describeContents

Added in API level 16
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 0 or CONTENTS_FILE_DESCRIPTOR

getLengthAt

Added in API level 16
public int getLengthAt (int i)

Parameters
i int: the id of SuggestionsInfos this instance holds

Returns
int the length of the specified SuggestionsInfo

getOffsetAt

Added in API level 16
public int getOffsetAt (int i)

Parameters
i int: the id of SuggestionsInfos this instance holds

Returns
int the offset of the specified SuggestionsInfo

getSuggestionsCount

Added in API level 16
public int getSuggestionsCount ()

Returns
int the count of SuggestionsInfos this instance holds.

getSuggestionsInfoAt

Added in API level 16
public SuggestionsInfo getSuggestionsInfoAt (int i)

Parameters
i int: the id of SuggestionsInfos this instance holds.

Returns
SuggestionsInfo a SuggestionsInfo at the specified id

writeToParcel

Added in API level 16
public void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written.

flags int: The flags used for parceling.