Skip to content

Most visited

Recently visited

navigation

InputMethodSubtype

public final class InputMethodSubtype
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.inputmethod.InputMethodSubtype


This class is used to specify meta information of a subtype contained in an input method editor (IME). Subtype can describe locale (e.g. en_US, fr_FR...) and mode (e.g. voice, keyboard...), and is used for IME switch and settings. The input method subtype allows the system to bring up the specified subtype of the designated IME directly.

It should be defined in an XML resource file of the input method with the <subtype> element, which resides within an <input-method> element. For more information, see the guide to Creating an Input Method.

See also:

Summary

Nested classes

class InputMethodSubtype.InputMethodSubtypeBuilder

InputMethodSubtypeBuilder is a builder class of InputMethodSubtype. 

XML attributes

android:icon The icon of the subtype. 
android:imeSubtypeExtraValue The extra value of the subtype. 
android:imeSubtypeLocale The locale of the subtype. 
android:imeSubtypeMode The mode of the subtype. 
android:isAsciiCapable Set to true if this subtype is ASCII capable. 
android:isAuxiliary Set true if the subtype is auxiliary. 
android:label The name of the subtype. 
android:languageTag The BCP-47 Language Tag of the subtype. 
android:overridesImplicitlyEnabledSubtype Set true when this subtype should be selected by default if no other subtypes are selected explicitly. 
android:subtypeId The unique id for the subtype. 

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<InputMethodSubtype> CREATOR

Public constructors

InputMethodSubtype(int nameId, int iconId, String locale, String mode, String extraValue, boolean isAuxiliary, boolean overridesImplicitlyEnabledSubtype)

This constructor was deprecated in API level 19. use InputMethodSubtype.InputMethodSubtypeBuilder instead. Arguments for this constructor have the same meanings as InputMethodSubtype(int, int, String, String, String, boolean, boolean, int) except "id".

InputMethodSubtype(int nameId, int iconId, String locale, String mode, String extraValue, boolean isAuxiliary, boolean overridesImplicitlyEnabledSubtype, int id)

This constructor was deprecated in API level 19. use InputMethodSubtype.InputMethodSubtypeBuilder instead. "isAsciiCapable" is "false" in this 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 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)

Returns a display name for this subtype.

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

int getIconResId()
String getLanguageTag()
String getLocale()

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

String getMode()
int getNameResId()
int hashCode()

Returns a hash code value for the object.

boolean isAsciiCapable()
boolean isAuxiliary()
boolean overridesImplicitlyEnabledSubtype()
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:icon

The icon of the subtype.

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

This corresponds to the global attribute resource symbol icon.

android:imeSubtypeExtraValue

The extra value of the subtype. This string can be any string and will be passed to the IME when the framework calls the IME with the subtype.

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 imeSubtypeExtraValue.

android:imeSubtypeLocale

The locale of the subtype. This string should be a locale (e.g. en_US, fr_FR...) and will be passed to the IME when the framework calls the IME with the subtype. This is also used by the framework to know the supported locales of the IME.

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 imeSubtypeLocale.

android:imeSubtypeMode

The mode of the subtype. This string can be a mode (e.g. voice, keyboard...) and this string will be passed to the IME when the framework calls the IME with the subtype. 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 imeSubtypeMode.

android:isAsciiCapable

Set to true if this subtype is ASCII capable. If the subtype is ASCII capable, it should guarantee that the user can input ASCII characters with this subtype. This is important because many password fields only allow ASCII-characters.

Must be a boolean value, either "true" or "false".

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 isAsciiCapable.

android:isAuxiliary

Set true if the subtype is auxiliary. An auxiliary subtype won't be shown in the input method selection list in the settings app. InputMethodManager#switchToLastInputMethod will ignore auxiliary subtypes when it chooses a target subtype.

Must be a boolean value, either "true" or "false".

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 isAuxiliary.

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 InputMethod_Subtype_imeSubtypeLocale.

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:overridesImplicitlyEnabledSubtype

Set true when this subtype should be selected by default if no other subtypes are selected explicitly. Note that a subtype with this parameter being true will not be shown in the subtypes list.

Must be a boolean value, either "true" or "false".

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 overridesImplicitlyEnabledSubtype.

android:subtypeId

The unique id for the subtype. The input method framework keeps track of enabled subtypes by ID. When the IME package gets upgraded, enabled IDs will stay enabled even if other attributes are different. If the ID is unspecified (by calling the other constructor or 0. Arrays.hashCode(new Object[] {locale, mode, extraValue, isAuxiliary, overridesImplicitlyEnabledSubtype}) 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 subtypeId.

Fields

CREATOR

Added in API level 11
Creator<InputMethodSubtype> CREATOR

Public constructors

InputMethodSubtype

Added in API level 14
InputMethodSubtype (int nameId, 
                int iconId, 
                String locale, 
                String mode, 
                String extraValue, 
                boolean isAuxiliary, 
                boolean overridesImplicitlyEnabledSubtype)

This constructor was deprecated in API level 19.
use InputMethodSubtype.InputMethodSubtypeBuilder instead. Arguments for this constructor have the same meanings as InputMethodSubtype(int, int, String, String, String, boolean, boolean, int) except "id".

Constructor with no subtype ID specified.

Parameters
nameId int
iconId int
locale String
mode String
extraValue String
isAuxiliary boolean
overridesImplicitlyEnabledSubtype boolean

InputMethodSubtype

Added in API level 17
InputMethodSubtype (int nameId, 
                int iconId, 
                String locale, 
                String mode, 
                String extraValue, 
                boolean isAuxiliary, 
                boolean overridesImplicitlyEnabledSubtype, 
                int id)

This constructor was deprecated in API level 19.
use InputMethodSubtype.InputMethodSubtypeBuilder instead. "isAsciiCapable" is "false" in this constructor.

Constructor.

Parameters
nameId int: Resource ID of the subtype name string. The string resource may have exactly one %s in it. If there is, the %s part will be replaced with the locale's display name by the formatter. Please refer to getDisplayName(Context, String, ApplicationInfo) for details.
iconId int: Resource ID of the subtype icon drawable.
locale String: The locale supported by the subtype
mode String: The mode supported by the subtype
extraValue String: The extra value of the subtype. This string is free-form, but the API supplies tools to deal with a key-value comma-separated list; see containsExtraValueKey(String) and getExtraValueOf(String).
isAuxiliary boolean: true when this subtype is auxiliary, false otherwise. An auxiliary subtype will not be shown in the list of enabled IMEs for choosing the current IME in the Settings even when this subtype is enabled. Please note that this subtype will still be shown in the list of IMEs in the IME switcher to allow the user to tentatively switch to this subtype while an IME is shown. The framework will never switch the current IME to this subtype by switchToLastInputMethod(IBinder). The intent of having this flag is to allow for IMEs that are invoked in a one-shot way as auxiliary input mode, and return to the previous IME once it is finished (e.g. voice input).
overridesImplicitlyEnabledSubtype boolean: true when this subtype should be enabled by default if no other subtypes in the IME are enabled explicitly. Note that a subtype with this parameter being true will not be shown in the list of subtypes in each IME's subtype enabler. Having an "automatic" subtype is an example use of this flag.
id int: The unique ID for the subtype. The input method framework keeps track of enabled subtypes by ID. When the IME package gets upgraded, enabled IDs will stay enabled even if other attributes are different. If the ID is unspecified or 0, Arrays.hashCode(new Object[] {locale, mode, extraValue, isAuxiliary, overridesImplicitlyEnabledSubtype, isAsciiCapable}) will be used instead.

Public methods

containsExtraValueKey

Added in API level 12
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 11
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 11
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)

Returns a display name for this subtype.

If subtypeNameResId is specified (!= 0) text generated from that resource will be returned. The localized string resource of the label should be capitalized for inclusion in UI lists. The string resource may contain at most one %s. If present, the %s will be replaced with the display name of the subtype locale in the user's locale.

If subtypeNameResId is not specified (== 0) the framework returns the display name of the subtype locale, as capitalized for use in UI lists, in the user's locale.

Parameters
context Context: Context will be used for getting Locale and PackageManager.
packageName String: The package name of the input method.
appInfo ApplicationInfo: The ApplicationInfo of the input method.
Returns
CharSequence a display name for this subtype.

getExtraValue

Added in API level 11
String getExtraValue ()

Returns
String The extra value of the subtype.

getExtraValueOf

Added in API level 12
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

getIconResId

Added in API level 11
int getIconResId ()

Returns
int Resource ID of the subtype icon drawable.

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

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

Returns
String The locale of the subtype. This method returns the "locale" string parameter passed to the constructor.

getMode

Added in API level 11
String getMode ()

Returns
String The mode of the subtype.

getNameResId

Added in API level 11
int getNameResId ()

Returns
int Resource ID of the subtype name string.

hashCode

Added in API level 11
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.

isAsciiCapable

Added in API level 19
boolean isAsciiCapable ()

Returns
boolean true if this subtype is Ascii capable, false otherwise. If the subtype is ASCII capable, it should guarantee that the user can input ASCII characters with this subtype. This is important because many password fields only allow ASCII-characters.

isAuxiliary

Added in API level 14
boolean isAuxiliary ()

Returns
boolean true if this subtype is auxiliary, false otherwise. An auxiliary subtype will not be shown in the list of enabled IMEs for choosing the current IME in the Settings even when this subtype is enabled. Please note that this subtype will still be shown in the list of IMEs in the IME switcher to allow the user to tentatively switch to this subtype while an IME is shown. The framework will never switch the current IME to this subtype by switchToLastInputMethod(IBinder). The intent of having this flag is to allow for IMEs that are invoked in a one-shot way as auxiliary input mode, and return to the previous IME once it is finished (e.g. voice input).

overridesImplicitlyEnabledSubtype

Added in API level 14
boolean overridesImplicitlyEnabledSubtype ()

Returns
boolean true when this subtype will be enabled by default if no other subtypes in the IME are enabled explicitly, false otherwise. Note that a subtype with this method returning true will not be shown in the list of subtypes in each IME's subtype enabler. Having an "automatic" subtype is an example use of this flag.

writeToParcel

Added in API level 11
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.

Take a one-minute survey?
Help us improve Android tools and documentation.