Android APIs
public static abstract class

SpellCheckerService.Session

extends Object
java.lang.Object
   ↳ android.service.textservice.SpellCheckerService.Session

Class Overview

This abstract class should be overridden by a concrete implementation of a spell checker.

Summary

Public Constructors
SpellCheckerService.Session()
Public Methods
Bundle getBundle()
String getLocale()
void onCancel()
Request to abort all tasks executed in SpellChecker.
void onClose()
Request to close this session.
abstract void onCreate()
This is called after the class is initialized, at which point it knows it can call getLocale() etc...
SentenceSuggestionsInfo[] onGetSentenceSuggestionsMultiple(TextInfo[] textInfos, int suggestionsLimit)
Get sentence suggestions for specified texts in an array of TextInfo.
abstract SuggestionsInfo onGetSuggestions(TextInfo textInfo, int suggestionsLimit)
Get suggestions for specified text in TextInfo.
SuggestionsInfo[] onGetSuggestionsMultiple(TextInfo[] textInfos, int suggestionsLimit, boolean sequentialWords)
A batch process of onGetSuggestions.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SpellCheckerService.Session ()

Added in API level 14

Public Methods

public Bundle getBundle ()

Added in API level 14

Returns
Bundle Bundle for this session

public String getLocale ()

Added in API level 14

Returns
String Locale for this session

public void onCancel ()

Added in API level 14

Request to abort all tasks executed in SpellChecker. This function will run on the incoming IPC thread. So, this is not called on the main thread, but will be called in series on another thread.

public void onClose ()

Added in API level 15

Request to close this session. This function will run on the incoming IPC thread. So, this is not called on the main thread, but will be called in series on another thread.

public abstract void onCreate ()

Added in API level 14

This is called after the class is initialized, at which point it knows it can call getLocale() etc...

public SentenceSuggestionsInfo[] onGetSentenceSuggestionsMultiple (TextInfo[] textInfos, int suggestionsLimit)

Added in API level 16

Get sentence suggestions for specified texts in an array of TextInfo. The default implementation splits the input text to words and returns SentenceSuggestionsInfo which contains suggestions for each word. This function will run on the incoming IPC thread. So, this is not called on the main thread, but will be called in series on another thread. When you override this method, make sure that suggestionsLimit is applied to suggestions that share the same start position and length.

Parameters
textInfos TextInfo: an array of the text metadata
suggestionsLimit int: the maximum number of suggestions to be returned
Returns
SentenceSuggestionsInfo[] an array of SentenceSuggestionsInfo returned by onGetSuggestions(TextInfo, int)

public abstract SuggestionsInfo onGetSuggestions (TextInfo textInfo, int suggestionsLimit)

Added in API level 14

Get suggestions for specified text in TextInfo. This function will run on the incoming IPC thread. So, this is not called on the main thread, but will be called in series on another thread.

Parameters
textInfo TextInfo: the text metadata
suggestionsLimit int: the maximum number of suggestions to be returned
Returns
SuggestionsInfo SuggestionsInfo which contains suggestions for textInfo

public SuggestionsInfo[] onGetSuggestionsMultiple (TextInfo[] textInfos, int suggestionsLimit, boolean sequentialWords)

Added in API level 14

A batch process of onGetSuggestions. This function will run on the incoming IPC thread. So, this is not called on the main thread, but will be called in series on another thread.

Parameters
textInfos TextInfo: an array of the text metadata
suggestionsLimit int: the maximum number of suggestions to be returned
sequentialWords boolean: true if textInfos can be treated as sequential words.
Returns
SuggestionsInfo[] an array of SentenceSuggestionsInfo returned by onGetSuggestions(TextInfo, int)