| java.lang.Object | |
| ↳ | android.view.textservice.SpellCheckerSession |
The SpellCheckerSession interface provides the per client functionality of SpellCheckerService.
In most cases, applications that are using the standard
TextView or its subclasses will have little they need
to do to work well with spell checker services. The main things you need to
be aware of are:
inputType in your editable
text views, so that the spell checker will have enough context to help the
user in editing text in them.
For the rare people amongst us writing client applications that use the spell checker service
directly, you will need to use getSuggestions(TextInfo, int) or
getSuggestions(TextInfo[], int, boolean) for obtaining results from the spell checker
service by yourself.
There are a lot of security issues associated with spell checkers,
since they could monitor all the text being sent to them
through, for instance, TextView.
The Android spell checker framework also allows
arbitrary third party spell checkers, so care must be taken to restrict their
selection and interactions.
Here are some key points about the security architecture behind the spell checker framework:
SpellCheckerService interface, via the
BIND_TEXT_SERVICE permission. This is
enforced in the system by not binding to a spell checker service that does
not require this permission.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Cancel pending and running spell check tasks
| |||||||||||
Finish this session and allow TextServicesManagerService to disconnect the bound spell
checker.
| |||||||||||
Get suggestions from the specified sentences
| |||||||||||
Get the spell checker service info this spell checker session has.
| |||||||||||
This method was deprecated
in API level 16.
use
getSentenceSuggestions(TextInfo[], int) instead
| |||||||||||
This method was deprecated
in API level 16.
use
getSentenceSuggestions(TextInfo[], int) instead
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Invoked when the garbage collector has detected that this instance is no longer reachable.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Name under which a SpellChecker service component publishes information about itself. This meta-data must reference an XML resource.
Finish this session and allow TextServicesManagerService to disconnect the bound spell checker.
Get suggestions from the specified sentences
| textInfos | an array of text metadata for a spell checker |
|---|---|
| suggestionsLimit | the maximum number of suggestions that will be returned |
Get the spell checker service info this spell checker session has.
This method was deprecated
in API level 16.
use getSentenceSuggestions(TextInfo[], int) instead
A batch process of getSuggestions
| textInfos | an array of text metadata for a spell checker |
|---|---|
| suggestionsLimit | the maximum number of suggestions that will be returned |
| sequentialWords | true if textInfos can be treated as sequential words. |
This method was deprecated
in API level 16.
use getSentenceSuggestions(TextInfo[], int) instead
Get candidate strings for a substring of the specified text.
| textInfo | text metadata for a spell checker |
|---|---|
| suggestionsLimit | the maximum number of suggestions that will be returned |
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.
| Throwable |
|---|