Added in API level 11

InputMethodSubtype

class InputMethodSubtype : Parcelable
kotlin.Any
   ↳ 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.

Summary

Nested classes

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
Public constructors
InputMethodSubtype(nameId: Int, iconId: Int, locale: String!, mode: String!, extraValue: String!, isAuxiliary: Boolean, overridesImplicitlyEnabledSubtype: Boolean)

Constructor with no subtype ID specified.
InputMethodSubtype(nameId: Int, iconId: Int, locale: String!, mode: String!, extraValue: String!, isAuxiliary: Boolean, overridesImplicitlyEnabledSubtype: Boolean, id: Int)

Constructor.
Public methods
Boolean

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

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
CharSequence
getDisplayName(context: Context!, packageName: String!, appInfo: ApplicationInfo!)

Returns a display name for this subtype.
String!

String!

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

String

String

String!

CharSequence

Int

ULocale?

Returns the physical keyboard BCP-47 language tag.
String

Returns the physical keyboard layout type string.
Int

Boolean

Boolean

Boolean

Unit
writeToParcel(dest: Parcel, parcelableFlags: Int)
Properties
static Parcelable.Creator<InputMethodSubtype!>

XML attributes

android:icon

android:icon
The icon of the subtype.

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

android:imeSubtypeExtraValue

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.

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

android:imeSubtypeLocale

android:imeSubtypeLocale
The locale of the subtype. This string should be a locale (for example en_US and 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.

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

android:imeSubtypeMode

android:imeSubtypeMode
The mode of the subtype. This string can be a mode (for example, voice and keyboard) and this string will be passed to the IME when the framework calls the IME with the subtype. android.view.inputmethod.InputMethodSubtype#getLocale() returns the value specified in this attribute.

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

android:isAsciiCapable

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.

Note: In order to avoid some known system issues on android.os.Build.VERSION_CODES#P and prior OSes, you may want to include "AsciiCapable" in android.R.styleable#InputMethod_Subtype_imeSubtypeExtraValue when you specify true to this attribute.

May be a boolean value, such as "true" or "false".

android:isAuxiliary

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.

May be a boolean value, such as "true" or "false".

android:label

android:label
The name of the subtype.

May be a reference to another resource, in the form "@[+][package:]type/name" or 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;

android:languageTag

android:languageTag
The BCP-47 Language Tag of the subtype. This replaces android.R.styleable#InputMethod_Subtype_imeSubtypeLocale.

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

android:overridesImplicitlyEnabledSubtype

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.

May be a boolean value, such as "true" or "false".

android:subtypeId

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.

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

Public constructors

InputMethodSubtype

Added in API level 14
InputMethodSubtype(
    nameId: Int, 
    iconId: Int, 
    locale: String!, 
    mode: String!, 
    extraValue: String!, 
    isAuxiliary: Boolean, 
    overridesImplicitlyEnabledSubtype: Boolean)

Deprecated: use InputMethodSubtypeBuilder instead. Arguments for this constructor have the same meanings as InputMethodSubtype#InputMethodSubtype(int, int, String, String, String, boolean, except "id".

Constructor with no subtype ID specified.

InputMethodSubtype

Added in API level 17
InputMethodSubtype(
    nameId: Int, 
    iconId: Int, 
    locale: String!, 
    mode: String!, 
    extraValue: String!, 
    isAuxiliary: Boolean, 
    overridesImplicitlyEnabledSubtype: Boolean, 
    id: Int)

Deprecated: use 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 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 and getExtraValueOf.
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 android.view.inputmethod.InputMethodManager#switchToLastInputMethod. 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
fun containsExtraValueKey(key: String!): Boolean

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
Return
Boolean The subtype contains specified the extra value

describeContents

Added in API level 11
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 11
fun equals(other: Any?): Boolean

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getDisplayName

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

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 android.content.pm.PackageManager.
packageName String!: The package name of the input method.
appInfo ApplicationInfo!: The ApplicationInfo of the input method.
Return
CharSequence a display name for this subtype. This value cannot be null.

getExtraValue

Added in API level 11
fun getExtraValue(): String!
Return
String! The extra value of the subtype.

getExtraValueOf

Added in API level 12
fun getExtraValueOf(key: String!): String!

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
Return
String! The value of the specified key

getIconResId

Added in API level 11
fun getIconResId(): Int
Return
Int Resource ID of the subtype icon drawable.

getLanguageTag

Added in API level 24
fun getLanguageTag(): String
Return
String the BCP-47 Language Tag of the subtype. Returns an empty string when no Language Tag is specified. This value cannot be null.

getLocale

Added in API level 11
Deprecated in API level 24
fun getLocale(): String

Deprecated: Use getLanguageTag() instead.

Return
String The locale of the subtype. This method returns the "locale" string parameter passed to the constructor. This value cannot be null.

getMode

Added in API level 11
fun getMode(): String!
Return
String! The mode of the subtype.

getNameOverride

Added in API level 34
fun getNameOverride(): CharSequence
Return
CharSequence The subtype's untranslatable name string. This value cannot be null.

getNameResId

Added in API level 11
fun getNameResId(): Int
Return
Int Resource ID of the subtype name string.

getPhysicalKeyboardHintLanguageTag

Added in API level 34
fun getPhysicalKeyboardHintLanguageTag(): ULocale?

Returns the physical keyboard BCP-47 language tag.

Return
ULocale? This value may be null.

getPhysicalKeyboardHintLayoutType

Added in API level 34
fun getPhysicalKeyboardHintLayoutType(): String

Returns the physical keyboard layout type string.

Return
String This value cannot be null.

hashCode

Added in API level 11
fun hashCode(): Int
Return
Int a hash code value for this object.

isAsciiCapable

Added in API level 19
fun isAsciiCapable(): Boolean
Return
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
fun isAuxiliary(): Boolean
Return
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 android.view.inputmethod.InputMethodManager#switchToLastInputMethod. 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
fun overridesImplicitlyEnabledSubtype(): Boolean
Return
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
fun writeToParcel(
    dest: Parcel, 
    parcelableFlags: Int
): Unit
Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 11
static val CREATOR: Parcelable.Creator<InputMethodSubtype!>