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 ()

Added in API level 14

Used to make this class parcelable.

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

public ComponentName getComponent ()

Added in API level 14

Return the component of the service that implements.

Returns
ComponentName

public String getId ()

Added in API level 14

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

Returns
String

public String getPackageName ()

Added in API level 14

Return the .apk package that implements this.

Returns
String

public ServiceInfo getServiceInfo ()

Added in API level 14

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

Returns
ServiceInfo

public String getSettingsActivity ()

Added in API level 14

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.

Returns
String

public SpellCheckerSubtype getSubtypeAt (int index)

Added in API level 14

Return the subtype at the specified index.

Parameters
index the index of the subtype to return.
Returns
SpellCheckerSubtype

public int getSubtypeCount ()

Added in API level 14

Return the count of the subtypes.

Returns
int

public Drawable loadIcon (PackageManager pm)

Added in API level 14

Load the user-displayed icon for this spell checker.

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

public CharSequence loadLabel (PackageManager pm)

Added in API level 14

Load the user-displayed label for this spell checker.

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

public void writeToParcel (Parcel dest, int flags)

Added in API level 14

Used to package this object into a Parcel.

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