IT. Expert System.

Android Reference

InputMethodSubtype


android.view.inputmethod

Class InputMethodSubtype

  • All Implemented Interfaces:
    Parcelable


    public final class InputMethodSubtype
    extends Object
    implements Parcelable
    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. For more information, see the guide to Creating an Input Method.

    • Constructor Detail

      • InputMethodSubtype

        public InputMethodSubtype(int nameId,
                          int iconId,
                          String locale,
                          String mode,
                          String extraValue,
                          boolean isAuxiliary)
        Constructor with no subtype ID specified, overridesImplicitlyEnabledSubtype not specified.
        Parameters:
        nameId - 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(android.content.Context, java.lang.String, android.content.pm.ApplicationInfo) for details.
        iconId - Resource ID of the subtype icon drawable.
        locale - The locale supported by the subtype
        mode - The mode supported by the subtype
        extraValue - 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(java.lang.String) and getExtraValueOf(java.lang.String).
        isAuxiliary - 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 InputMethodManager.switchToLastInputMethod(android.os.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).
      • InputMethodSubtype

        public InputMethodSubtype(int nameId,
                          int iconId,
                          String locale,
                          String mode,
                          String extraValue,
                          boolean isAuxiliary,
                          boolean overridesImplicitlyEnabledSubtype)
        Constructor with no subtype ID specified.
        Parameters:
        nameId - 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(android.content.Context, java.lang.String, android.content.pm.ApplicationInfo) for details.
        iconId - Resource ID of the subtype icon drawable.
        locale - The locale supported by the subtype
        mode - The mode supported by the subtype
        extraValue - 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(java.lang.String) and getExtraValueOf(java.lang.String).
        isAuxiliary - 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 InputMethodManager.switchToLastInputMethod(android.os.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 - 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.
      • InputMethodSubtype

        public InputMethodSubtype(int nameId,
                          int iconId,
                          String locale,
                          String mode,
                          String extraValue,
                          boolean isAuxiliary,
                          boolean overridesImplicitlyEnabledSubtype,
                          int id)
        Constructor.
        Parameters:
        nameId - 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(android.content.Context, java.lang.String, android.content.pm.ApplicationInfo) for details.
        iconId - Resource ID of the subtype icon drawable.
        locale - The locale supported by the subtype
        mode - The mode supported by the subtype
        extraValue - 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(java.lang.String) and getExtraValueOf(java.lang.String).
        isAuxiliary - 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 InputMethodManager.switchToLastInputMethod(android.os.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 - 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 - 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}) will be used instead.
    • Method Detail

      • getNameResId

        public int getNameResId()
        Returns:
        Resource ID of the subtype name string.
      • getIconResId

        public int getIconResId()
        Returns:
        Resource ID of the subtype icon drawable.
      • getLocale

        public String getLocale()
        Returns:
        The locale of the subtype. This method returns the "locale" string parameter passed to the constructor.
      • getMode

        public String getMode()
        Returns:
        The mode of the subtype.
      • getExtraValue

        public String getExtraValue()
        Returns:
        The extra value of the subtype.
      • isAuxiliary

        public boolean isAuxiliary()
        Returns:
        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 InputMethodManager.switchToLastInputMethod(android.os.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

        public boolean overridesImplicitlyEnabledSubtype()
        Returns:
        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.
      • getDisplayName

        public CharSequence getDisplayName(Context context,
                                  String packageName,
                                  ApplicationInfo appInfo)
        Parameters:
        context - Context will be used for getting Locale and PackageManager.
        packageName - The package name of the IME
        appInfo - The application info of the IME
        Returns:
        a display name for this subtype. The string resource of the label (mSubtypeNameResId) 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. If there is not, this method returns the string specified by mSubtypeNameResId. If mSubtypeNameResId is not specified (== 0), it's up to the framework to generate an appropriate display name.
      • containsExtraValueKey

        public 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 - The key of extra value
        Returns:
        The subtype contains specified the extra value
      • getExtraValueOf

        public 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 - The key of extra value
        Returns:
        The value of the specified key
      • hashCode

        public int hashCode()
        Description copied from class: Object
        Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.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.

        Overrides:
        hashCode in class Object
        Returns:
        this object's hash code.
        See Also:
        Object.equals(java.lang.Object)
      • equals

        public boolean equals(Object o)
        Description copied from class: Object
        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 Object.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.

        Overrides:
        equals in class Object
        Parameters:
        o - the object to compare this instance with.
        Returns:
        true if the specified object is equal to this Object; false otherwise.
        See Also:
        Object.hashCode()
      • describeContents

        public int describeContents()
        Description copied from interface: Parcelable
        Describe the kinds of special objects contained in this Parcelable's marshalled representation.
        Specified by:
        describeContents in interface Parcelable
        Returns:
        a bitmask indicating the set of special object types marshalled by the Parcelable.
      • writeToParcel

        public void writeToParcel(Parcel dest,
                         int parcelableFlags)
        Description copied from interface: Parcelable
        Flatten this object in to a Parcel.
        Specified by:
        writeToParcel in interface Parcelable
        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.PARCELABLE_WRITE_RETURN_VALUE.
      • sort

        public static List<InputMethodSubtype> sort(Context context,
                                    int flags,
                                    InputMethodInfo imi,
                                    List<InputMethodSubtype> subtypeList)
        Sort the list of InputMethodSubtype
        Parameters:
        context - Context will be used for getting localized strings from IME
        flags - Flags for the sort order
        imi - InputMethodInfo of which subtypes are subject to be sorted
        subtypeList - List of InputMethodSubtype which will be sorted
        Returns:
        Sorted list of subtypes


Content

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.
All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.
Copyright 2016 © ELTASK.COM. All rights reserved.
Site is optimized for mobile devices.
Downloads: 727 / 158857790. Delta: 0.05166 с