Added in API level 14

TextServicesManager

public final class TextServicesManager
extends Object

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


System API to the overall text services, which arbitrates interaction between applications and text services. The user can change the current text services in Settings. And also applications can specify the target text services.

Architecture Overview

There are three primary parties involved in the text services framework (TSF) architecture:

  • The text services manager as expressed by this class is the central point of the system that manages interaction between all other parts. It is expressed as the client-side API here which exists in each application context and communicates with a global system service that manages the interaction across all processes.
  • A text service implements a particular interaction model allowing the client application to retrieve information of text. The system binds to the current text service that is in use, causing it to be created and run.
  • Multiple client applications arbitrate with the text service manager for connections to text services.

Text services sessions

Summary

Public methods

SpellCheckerInfo getCurrentSpellCheckerInfo()

Retrieve the currently active spell checker, or null if there is none.

List<SpellCheckerInfo> getEnabledSpellCheckerInfos()

Retrieve the list of currently enabled spell checkers.

boolean isSpellCheckerEnabled()

Return whether the spell checker is enabled or not.

SpellCheckerSession newSpellCheckerSession(Bundle bundle, Locale locale, SpellCheckerSession.SpellCheckerSessionListener listener, boolean referToSpellCheckerLanguageSettings)

Get a spell checker session from the spell checker.

SpellCheckerSession newSpellCheckerSession(SpellCheckerSession.SpellCheckerSessionParams params, Executor executor, SpellCheckerSession.SpellCheckerSessionListener listener)

Get a spell checker session from the spell checker.

Inherited methods

Public methods

getCurrentSpellCheckerInfo

Added in API level 31
public SpellCheckerInfo getCurrentSpellCheckerInfo ()

Retrieve the currently active spell checker, or null if there is none.

Returns
SpellCheckerInfo The current active spell checker info.

getEnabledSpellCheckerInfos

Added in API level 31
public List<SpellCheckerInfo> getEnabledSpellCheckerInfos ()

Retrieve the list of currently enabled spell checkers.

Note: The results are filtered by the rules of package visibility, except for the currently active spell checker.

Returns
List<SpellCheckerInfo> The list of currently enabled spell checkers. This value cannot be null.

isSpellCheckerEnabled

Added in API level 31
public boolean isSpellCheckerEnabled ()

Return whether the spell checker is enabled or not.

Returns
boolean true if spell checker is enabled, false otherwise.

newSpellCheckerSession

Added in API level 14
public SpellCheckerSession newSpellCheckerSession (Bundle bundle, 
                Locale locale, 
                SpellCheckerSession.SpellCheckerSessionListener listener, 
                boolean referToSpellCheckerLanguageSettings)

Get a spell checker session from the spell checker.

SuggestionsInfo#RESULT_ATTR_IN_THE_DICTIONARY, SuggestionsInfo#RESULT_ATTR_LOOKS_LIKE_TYPO, and SuggestionsInfo#RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS will be passed to the spell checker as supported attributes.

Parameters
bundle Bundle: This value may be null.

locale Locale: the locale for the spell checker. If locale is null and referToSpellCheckerLanguageSettings is true, the locale specified in Settings will be returned. If locale is not null and referToSpellCheckerLanguageSettings is true, the locale specified in Settings will be returned only when it is same as locale. Exceptionally, when referToSpellCheckerLanguageSettings is true and locale is only language (e.g. "en"), the specified locale in Settings (e.g. "en_US") will be selected.

listener SpellCheckerSession.SpellCheckerSessionListener: a spell checker session lister for getting results from the spell checker. This value cannot be null.

referToSpellCheckerLanguageSettings boolean: if true, the session for one of enabled languages in settings will be returned.

Returns
SpellCheckerSession a spell checker session of the spell checker This value may be null.

newSpellCheckerSession

Added in API level 31
public SpellCheckerSession newSpellCheckerSession (SpellCheckerSession.SpellCheckerSessionParams params, 
                Executor executor, 
                SpellCheckerSession.SpellCheckerSessionListener listener)

Get a spell checker session from the spell checker.

Parameters
params SpellCheckerSession.SpellCheckerSessionParams: The parameters passed to the spell checker. This value cannot be null.

executor Executor: The executor on which listener will be called back. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

listener SpellCheckerSession.SpellCheckerSessionListener: a spell checker session lister for getting results from the spell checker. This value cannot be null.

Returns
SpellCheckerSession The spell checker session of the spell checker. This value may be null.