Added in API level 14

Summary: Inherited Constants | Fields | Methods | Inherited Methods

SpellCheckerInfo

---

Kotlin |Java

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

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout 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.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

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.