Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public final class

SpellCheckerInfo

extends Object
implements Parcelable
java.lang.Object
   ↳ android.view.textservice.SpellCheckerInfo

Class Overview

This class is used to specify meta information of a spell checker.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator < SpellCheckerInfo > CREATOR Used to make this class parcelable.
Public Methods
int describeContents ()
Used to make this class parcelable.
ComponentName getComponent ()
Return the component of the service that implements.
String getId ()
Return a unique ID for this spell checker.
String getPackageName ()
Return the .apk package that implements this.
ServiceInfo getServiceInfo ()
Return the raw information about the Service implementing this spell checker.
String getSettingsActivity ()
Return the class name of an activity that provides a settings UI.
SpellCheckerSubtype getSubtypeAt (int index)
Return the subtype at the specified index.
int getSubtypeCount ()
Return the count of the subtypes.
Drawable loadIcon ( PackageManager pm)
Load the user-displayed icon for this spell checker.
CharSequence loadLabel ( PackageManager pm)
Load the user-displayed label for this spell checker.
void writeToParcel ( Parcel dest, int flags)
Used to package this object into a Parcel .
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator < SpellCheckerInfo > CREATOR

Added in API level 14

Used to make this class parcelable.

Public Methods

public int describeContents ()

Used to make this class parcelable.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public ComponentName getComponent ()

Return the component of the service that implements.

public String getId ()

Return a unique ID for this spell checker. The ID is generated from the package and class name implementing the method.

public String getPackageName ()

Return the .apk package that implements this.

public ServiceInfo getServiceInfo ()

Return the raw information about the Service implementing this spell checker. Do not modify the returned object.

public String getSettingsActivity ()

Return the class name of an activity that provides a settings UI. You can launch this activity be starting it with an Intent whose action is MAIN and with an explicit ComponentName composed of getPackageName() and the class name returned here.

A null will be returned if there is no settings activity.

public SpellCheckerSubtype getSubtypeAt (int index)

Return the subtype at the specified index.

Parameters
index the index of the subtype to return.

public int getSubtypeCount ()

Return the count of the subtypes.

public Drawable loadIcon ( PackageManager pm)

Load the user-displayed icon for this spell checker.

Parameters
pm Supply a PackageManager used to load the spell checker's resources.

public CharSequence loadLabel ( PackageManager pm)

Load the user-displayed label for this spell checker.

Parameters
pm Supply a PackageManager used to load the spell checker's resources.

public void writeToParcel ( Parcel dest, int flags)

Used to package this object into a Parcel .

Parameters
dest The Parcel to be written.
flags The flags used for parceling.