package.html revision 9498e8a8d2deb7b0a2e964d5d3c5d3b8747610e9 
1<HTML>
2<BODY>
3<p>Provides classes that allow you to create spell checkers in a manner similar to the
4input method framework (for IMEs).</p>
5
6<p>To create a new spell checker, you must implement a service that extends {@link
7android.service.textservice.SpellCheckerService} and extend the {@link
8android.service.textservice.SpellCheckerService.Session} class to provide spelling suggestions based
9on text provided by the interface's callback methods. In the {@link
10android.service.textservice.SpellCheckerService.Session} callback methods, you must return the
11spelling suggestions as {@link android.view.textservice.SuggestionsInfo} objects. </p>
12
13<p>Applications with a spell checker service must declare the {@link
14android.Manifest.permission#BIND_TEXT_SERVICE} permission as required by the service. The service
15must also declare an intent filter with {@code <action
16android:name="android.service.textservice.SpellCheckerService" />} as the intent’s action and should
17include a {@code <meta-data>} element that declares configuration information for the spell
18checker. For example:</p>
19
20<pre>
21&lt;service
22    android:label="&#064;string/app_name"
23    android:name=".SampleSpellCheckerService"
24    android:permission="android.permission.BIND_TEXT_SERVICE" >
25    &lt;intent-filter >
26        &lt;action android:name="android.service.textservice.SpellCheckerService" />
27    &lt;/intent-filter>
28    &lt;meta-data
29        android:name="android.view.textservice.scs"
30        android:resource="&#064;xml/spellchecker" />
31&lt;/service>
32</pre>
33
34<p>For example code, see the sample <a
35href="{@docRoot}resources/samples/SpellChecker/SampleSpellCheckerService/index.html">Spell
36Checker service</a> app, and the sample <a
37href="{@docRoot}resources/samples/SpellChecker/HelloSpellChecker/index.html">Spell
38Checker client</a> app.</p>
39</BODY>
40</HTML>
41