Android APIs
public static class

InputMethodSubtype.InputMethodSubtypeBuilder

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

Class Overview

InputMethodSubtypeBuilder is a builder class of InputMethodSubtype. This class is designed to be used with setAdditionalInputMethodSubtypes(String, InputMethodSubtype[]). The developer needs to be aware of what each parameter means.

Summary

Public Constructors
InputMethodSubtype.InputMethodSubtypeBuilder()
Public Methods
InputMethodSubtype build()
InputMethodSubtype.InputMethodSubtypeBuilder setIsAsciiCapable(boolean isAsciiCapable)
InputMethodSubtype.InputMethodSubtypeBuilder setIsAuxiliary(boolean isAuxiliary)
InputMethodSubtype.InputMethodSubtypeBuilder setOverridesImplicitlyEnabledSubtype(boolean overridesImplicitlyEnabledSubtype)
InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeExtraValue(String subtypeExtraValue)
InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeIconResId(int subtypeIconResId)
InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeId(int subtypeId)
InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeLocale(String subtypeLocale)
InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeMode(String subtypeMode)
InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeNameResId(int subtypeNameResId)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public InputMethodSubtype.InputMethodSubtypeBuilder ()

Added in API level 19

Public Methods

public InputMethodSubtype build ()

Added in API level 19

Returns
InputMethodSubtype InputMethodSubtype using parameters in this InputMethodSubtypeBuilder.

public InputMethodSubtype.InputMethodSubtypeBuilder setIsAsciiCapable (boolean isAsciiCapable)

Added in API level 19

Parameters
isAsciiCapable should be 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.
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setIsAuxiliary (boolean isAuxiliary)

Added in API level 19

Parameters
isAuxiliary should true when this subtype is auxiliary, false otherwise. An auxiliary subtype has the following differences with a regular subtype: - An auxiliary subtype cannot be chosen as the default IME in Settings. - The framework will never switch to this subtype through switchToLastInputMethod(IBinder). Note that the subtype will still be available in the IME switcher. The intent is to allow for IMEs to specify they are meant to be invoked temporarily in a one-shot way, and to return to the previous IME once finished (e.g. voice input).
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setOverridesImplicitlyEnabledSubtype (boolean overridesImplicitlyEnabledSubtype)

Added in API level 19

Parameters
overridesImplicitlyEnabledSubtype should be true if this subtype should be enabled by default if no other subtypes in the IME are enabled explicitly. Note that a subtype with this parameter set will not be shown in the list of subtypes in each IME's subtype enabler. A canonical use of this would be for an IME to supply an "automatic" subtype that adapts to the current system language.
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeExtraValue (String subtypeExtraValue)

Added in API level 19

Parameters
subtypeExtraValue is 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).
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeIconResId (int subtypeIconResId)

Added in API level 19

Parameters
subtypeIconResId is a resource ID of the subtype icon drawable.
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeId (int subtypeId)

Added in API level 19

Parameters
subtypeId is the unique ID for this 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.
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeLocale (String subtypeLocale)

Added in API level 19

Parameters
subtypeLocale is the locale supported by this subtype.
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeMode (String subtypeMode)

Added in API level 19

Parameters
subtypeMode is the mode supported by this subtype.
Returns
InputMethodSubtype.InputMethodSubtypeBuilder

public InputMethodSubtype.InputMethodSubtypeBuilder setSubtypeNameResId (int subtypeNameResId)

Added in API level 19

Parameters
subtypeNameResId is the resource ID of the subtype name string. The string resource may have exactly one %s in it. If present, the %s part will be replaced with the locale's display name by the formatter. Please refer to getDisplayName(Context, String, ApplicationInfo) for details.
Returns
InputMethodSubtype.InputMethodSubtypeBuilder