public class

SpellCheckerSession

extends Object
java.lang.Object
   ↳ android.view.textservice.SpellCheckerSession

Class Overview

The SpellCheckerSession interface provides the per client functionality of SpellCheckerService.

Summary

Nested Classes
interface SpellCheckerSession.SpellCheckerSessionListener Callback for getting results from text services  
Constants
String SERVICE_META_DATA Name under which a SpellChecker service component publishes information about itself.
Public Methods
void close()
Finish this session and allow TextServicesManagerService to disconnect the bound spell checker.
SpellCheckerInfo getSpellChecker()
Get the spell checker service info this spell checker session has.
void getSuggestions(TextInfo[] textInfos, int suggestionsLimit, boolean sequentialWords)
A batch process of getSuggestions
void getSuggestions(TextInfo textInfo, int suggestionsLimit)
Get candidate strings for a substring of the specified text.
boolean isSessionDisconnected()
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String SERVICE_META_DATA

Since: API Level 14

Name under which a SpellChecker service component publishes information about itself. This meta-data must reference an XML resource.

Constant Value: "android.view.textservice.scs"

Public Methods

public void close ()

Since: API Level 14

Finish this session and allow TextServicesManagerService to disconnect the bound spell checker.

public SpellCheckerInfo getSpellChecker ()

Since: API Level 14

Get the spell checker service info this spell checker session has.

Returns
  • SpellCheckerInfo for the specified locale.

public void getSuggestions (TextInfo[] textInfos, int suggestionsLimit, boolean sequentialWords)

Since: API Level 14

A batch process of getSuggestions

Parameters
textInfos an array of text metadata for a spell checker
suggestionsLimit the number of limit of suggestions returned
sequentialWords true if textInfos can be treated as sequential words.

public void getSuggestions (TextInfo textInfo, int suggestionsLimit)

Since: API Level 14

Get candidate strings for a substring of the specified text.

Parameters
textInfo text metadata for a spell checker
suggestionsLimit the number of limit of suggestions returned

public boolean isSessionDisconnected ()

Since: API Level 14

Returns
  • true if the connection to a text service of this session is disconnected and not alive.

Protected Methods

protected void finalize ()

Since: API Level 14

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable