Android APIs
public final class

SpellCheckerSubtype

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

Class Overview

This class is used to specify meta information of a subtype contained in a spell checker. Subtype can describe locale (e.g. en_US, fr_FR...) used for settings.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<SpellCheckerSubtype> CREATOR
Public Constructors
SpellCheckerSubtype(int nameId, String locale, String extraValue)
Constructor
Public Methods
boolean containsExtraValueKey(String key)
The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
CharSequence getDisplayName(Context context, String packageName, ApplicationInfo appInfo)
String getExtraValue()
String getExtraValueOf(String key)
The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4
String getLocale()
int getNameResId()
int hashCode()
Returns an integer hash code for this object.
void writeToParcel(Parcel dest, int parcelableFlags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<SpellCheckerSubtype> CREATOR

Added in API level 14

Public Constructors

public SpellCheckerSubtype (int nameId, String locale, String extraValue)

Added in API level 14

Constructor

Parameters
nameId The name of the subtype
locale The locale supported by the subtype
extraValue The extra value of the subtype

Public Methods

public boolean containsExtraValueKey (String key)

Added in API level 16

The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4

Parameters
key the key of extra value
Returns
boolean the subtype contains specified the extra value

public int describeContents ()

Added in API level 14

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

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

public boolean equals (Object o)

Added in API level 14

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public CharSequence getDisplayName (Context context, String packageName, ApplicationInfo appInfo)

Added in API level 14

Parameters
context Context will be used for getting Locale and PackageManager.
packageName The package name of the spell checker
appInfo The application info of the spell checker
Returns
CharSequence a display name for this subtype. The string resource of the label (mSubtypeNameResId) can have only one %s in it. If there is, the %s part will be replaced with the locale's display name by the formatter. If there is not, this method simply returns the string specified by mSubtypeNameResId. If mSubtypeNameResId is not specified (== 0), it's up to the framework to generate an appropriate display name.

public String getExtraValue ()

Added in API level 14

Returns
String the extra value of the subtype

public String getExtraValueOf (String key)

Added in API level 16

The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4

Parameters
key the key of extra value
Returns
String the value of the specified key

public String getLocale ()

Added in API level 14

Returns
String the locale of the subtype

public int getNameResId ()

Added in API level 14

Returns
int the name of the subtype

public int hashCode ()

Added in API level 14

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public void writeToParcel (Parcel dest, int parcelableFlags)

Added in API level 14

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written.
parcelableFlags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.