docs: add package summary for spell checker services (b22723c3) · Commits · e / os / android_frameworks_base

core/java/android/service/textservice/package.html

0 → 100644

+38 −0

Original line number	Diff line number	Diff line
		<HTML>
		<BODY>
		<p>Provides classes that allow you to create spell checkers in a manner similar to the
		input method framework (for IMEs).</p>

		<p>To create a new spell checker, you must implement a service that extends {@link
		android.service.textservice.SpellCheckerService} and extend the {@link
		android.service.textservice.SpellCheckerService.Session} class to provide spelling suggestions based
		on text provided by the interface's callback methods. In the {@link
		android.service.textservice.SpellCheckerService.Session} callback methods, you must return the
		spelling suggestions as {@link android.view.textservice.SuggestionsInfo} objects. </p>

		<p>Applications with a spell checker service must declare the {@link
		android.Manifest.permission#BIND_TEXT_SERVICE} permission as required by the service. The service
		must also declare an intent filter with {@code <action
		android:name="android.service.textservice.SpellCheckerService" />} as the intent’s action and should
		include a {@code <meta-data>} element that declares configuration information for the spell
		checker. For example:</p>

		<pre>
		<service
		android:label="@string/app_name"
		android:name=".SampleSpellCheckerService"
		android:permission="android.permission.BIND_TEXT_SERVICE" >
		<intent-filter >
		<action android:name="android.service.textservice.SpellCheckerService" />
		</intent-filter>
		<meta-data
		android:name="android.view.textservice.scs"
		android:resource="@xml/spellchecker" />
		</service>
		</pre>

		<p>For example code, see the <a
		href="{@docRoot}resources/samples/SampleSpellCheckerService/index.html">Spell
		Checker</a> sample app.</p>
		</BODY>
		</HTML>