Skip to content

Most visited

Recently visited

navigation
Added in API level 14

SpellCheckerSubtype

public final class SpellCheckerSubtype
extends Object implements Parcelable

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


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.

See also:

Summary

XML attributes

android:label The name of the subtype. 
android:languageTag The BCP-47 Language Tag of the subtype. 
android:subtypeExtraValue The extra value of the subtype. 
android:subtypeId The unique id for the subtype. 
android:subtypeLocale The locale of the subtype. 

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<SpellCheckerSubtype> CREATOR

Public constructors

SpellCheckerSubtype(int nameId, String locale, String extraValue)

This constructor was deprecated in API level 24. There is no public API that requires developers to directly instantiate custom SpellCheckerSubtype objects right now. Hence only the system is expected to be able to instantiate SpellCheckerSubtype object.

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 instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

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 getLanguageTag()
String getLocale()

This method was deprecated in API level 24. Use getLanguageTag() instead.

int getNameResId()
int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int parcelableFlags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

XML attributes

android:label

The name of the subtype.

May be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This corresponds to the global attribute resource symbol label.

android:languageTag

The BCP-47 Language Tag of the subtype. This replaces SpellChecker_Subtype_subtypeLocale.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol languageTag.

android:subtypeExtraValue

The extra value of the subtype. This string can be any string and will be passed to the SpellChecker.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol subtypeExtraValue.

android:subtypeId

The unique id for the subtype. The text service (spell checker) framework keeps track of enabled subtypes by ID. When the spell checker package gets upgraded, enabled IDs will stay enabled even if other attributes are different. If the ID is unspecified or or explicitly specified to 0 in XML resources, {@code Arrays.hashCode(new Object[] {subtypeLocale, extraValue}) will be used instead.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol {@link android.R.attr#subtypeId}.

android:subtypeLocale

The locale of the subtype. This string should be a locale (e.g. en_US, fr_FR...) This is also used by the framework to know the supported locales of the spell checker. getLocale() returns the value specified in this attribute.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol subtypeLocale.

Fields

CREATOR

Added in API level 14
Creator<SpellCheckerSubtype> CREATOR

Public constructors

SpellCheckerSubtype

Added in API level 14
SpellCheckerSubtype (int nameId, 
                String locale, 
                String extraValue)

This constructor was deprecated in API level 24.
There is no public API that requires developers to directly instantiate custom SpellCheckerSubtype objects right now. Hence only the system is expected to be able to instantiate SpellCheckerSubtype object.

Constructor.

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

Public methods

containsExtraValueKey

Added in API level 16
boolean containsExtraValueKey (String key)

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

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

describeContents

Added in API level 14
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

equals

Added in API level 14
boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getDisplayName

Added in API level 14
CharSequence getDisplayName (Context context, 
                String packageName, 
                ApplicationInfo appInfo)

Parameters
context Context: Context will be used for getting Locale and PackageManager.
packageName String: The package name of the spell checker
appInfo ApplicationInfo: 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.

getExtraValue

Added in API level 14
String getExtraValue ()

Returns
String the extra value of the subtype

getExtraValueOf

Added in API level 16
String getExtraValueOf (String key)

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

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

getLanguageTag

Added in API level 24
String getLanguageTag ()

Returns
String the BCP-47 Language Tag of the subtype. Returns an empty string when no Language Tag is specified.

See also:

getLocale

Added in API level 14
String getLocale ()

This method was deprecated in API level 24.
Use getLanguageTag() instead.

Returns
String the locale of the subtype

getNameResId

Added in API level 14
int getNameResId ()

Returns
int the name of the subtype

hashCode

Added in API level 14
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

writeToParcel

Added in API level 14
void writeToParcel (Parcel dest, 
                int parcelableFlags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
parcelableFlags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.