Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

SpellCheckerInfo

public final class SpellCheckerInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.textservice.SpellCheckerInfo


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

Summary

Inherited constants

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.

Inherited methods

Fields

CREATOR

added in API level 14
public static final Creator<SpellCheckerInfo> CREATOR

Used to make this class parcelable.

Public methods

describeContents

added in API level 14
public int describeContents ()

Used to make this class parcelable.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getComponent

added in API level 14
public ComponentName getComponent ()

Return the component of the service that implements.

Returns
ComponentName

getId

added in API level 14
public String getId ()

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

Returns
String

getPackageName

added in API level 14
public String getPackageName ()

Return the .apk package that implements this.

Returns
String

getServiceInfo

added in API level 14
public ServiceInfo getServiceInfo ()

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

Returns
ServiceInfo

getSettingsActivity

added in API level 14
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.

Returns
String

getSubtypeAt

added in API level 14
public SpellCheckerSubtype getSubtypeAt (int index)

Return the subtype at the specified index.

Parameters
index int: the index of the subtype to return.

Returns
SpellCheckerSubtype

getSubtypeCount

added in API level 14
public int getSubtypeCount ()

Return the count of the subtypes.

Returns
int

loadIcon

added in API level 14
public Drawable loadIcon (PackageManager pm)

Load the user-displayed icon for this spell checker.

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

Returns
Drawable

loadLabel

added in API level 14
public CharSequence loadLabel (PackageManager pm)

Load the user-displayed label for this spell checker.

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

Returns
CharSequence

writeToParcel

added in API level 14
public void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written.

flags int: The flags used for parceling.