InputMethodInfo

public final class InputMethodInfo
extends Object implements Parcelable

This class is used to specify meta information of an input method.

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

Summary

XML attributes

android:configChanges

Specify one or more configuration changes that the IME will handle itself. If not specified, the IME will be restarted if any of these configuration changes happen in the system. Otherwise, the IME will remain running and its InputMethodService.onConfigurationChanged(Configuration) method is called with the new configuration.

Note that all of these configuration changes can impact the resource values seen by the application, so you will generally need to re-retrieve all resources (including view layouts, drawables, etc) to correctly handle any configuration change.

Must be one or more (separated by '|') of the following constant values.

Related methods:

• getConfigChanges()

android:isDefault

Set to true in all of the configurations for which this input method should be considered an option as the default.

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

android:languageSettingsActivity

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

Related methods:

• createImeLanguageSettingsActivityIntent()

android:settingsActivity

Component name of an activity that allows the user to modify the settings for this service.

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

Related methods:

• createImeLanguageSettingsActivityIntent()

android:showInInputMethodPicker

Specifies whether the IME wants to be shown in the Input Method picker. Defaults to true. Set this to false if the IME is intended to be accessed programmatically.

Note: This functions as a hint to the system, which may choose to ignore this preference in certain situations or in future releases.

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

android:stylusHandwritingSettingsActivity

Class name of an activity that allows the user to modify the stylus handwriting settings for this service

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

Related methods:

• createStylusHandwritingSettingsActivityIntent()

android:supportsConnectionlessStylusHandwriting

Specifies whether the IME supports connectionless stylus handwriting sessions. A connectionless session differs from a regular session in that the IME does not use an input connection to communicate with a text editor. Instead, the IME directly returns recognised handwritten text via an InputMethodService handwriting lifecycle API.

If the IME supports connectionless sessions, apps or framework may start a connectionless session when a stylus motion event sequence begins. InputMethodService.onStartConnectionlessStylusHandwriting(int, CursorAnchorInfo) is called. If the IME is ready for stylus input, it should return {code true} to start the basic mode session. As in the regular session, the IME will receive stylus motion events to the stylus handwriting window and should render ink to a view in this window. When the user has stopped handwriting, the IME should end the session and deliver the result by calling InputMethodService.finishConnectionlessStylusHandwriting(CharSequence). The default value is {code false}. If {code true}, R.attr.supportsStylusHandwriting should also be {code true}.

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

Related methods:

• supportsConnectionlessStylusHandwriting()

android:supportsInlineSuggestions

Specifies whether the IME supports showing inline suggestions.

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

android:supportsInlineSuggestionsWithTouchExploration

Specifies whether the IME supports showing inline suggestions when touch exploration is enabled. This does nothing if supportsInlineSuggestions is false. The default value is false and most IMEs should not set this to true since the older menu-style Autofill works better with touch exploration. This attribute should be set to true in special situations, such as if this is an accessibility-focused IME which blocks user interaction with the app window while the IME is displayed.

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

android:supportsStylusHandwriting

Specifies whether the IME supports Handwriting using stylus. Defaults to false. When IME implements support for stylus handwriting, on every ACTION_DOWN with stylus on an editor, InputMethodService.onStartStylusHandwriting() is called. If IME is ready for stylus input, it must return true for Handwriting sessions to start. IME should attach it's View that renders Ink on screen to stylus handwriting inking window InputMethodService.getStylusHandwritingWindow(). IME will then receive Stylus MotionEvent(s) on DecorView i.e. the Inking view View.onTouchEvent(MotionEvent) attached by IME to Ink window. Handwriting mode can be finished by calling InputMethodService.finishStylusHandwriting() or will be finished by framework on next InputMethodService.onFinishInput().

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

Related methods:

• supportsStylusHandwriting()

android:supportsSwitchingToNextInputMethod

Set to true if this input method supports ways to switch to a next input method (for example, a globe key.). When this is true and InputMethodManager#shouldOfferSwitchingToNextInputMethod() returns true, the IME has to offer ways to invoke InputMethodManager#switchToNextInputMethod() accordingly.

Note that the system determines the most appropriate next input method and subtype in order to provide the consistent user experience in switching between IMEs and subtypes.

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

android:suppressesSpellChecker

Specifies whether the IME suppresses system spell checker. The default value is false. If an IME sets this attribute to true, the system spell checker will be disabled while the IME has an active input session.

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

Constants

public static final String ACTION_IME_LANGUAGE_SETTINGS

public static final String ACTION_STYLUS_HANDWRITING_SETTINGS

Fields

public static final Creator<InputMethodInfo> CREATOR

Public constructors

public InputMethodInfo (Context context, 
                ResolveInfo service)

public InputMethodInfo (String packageName, 
                String className, 
                CharSequence label, 
                String settingsActivity)

Public methods

public Intent createImeLanguageSettingsActivityIntent ()

startActivity(createImeLanguageSettingsActivityIntent());

public Intent createStylusHandwritingSettingsActivityIntent ()

startActivity(createStylusHandwritingSettingsActivityIntent());
 

public int describeContents ()

public void dump (Printer pw, 
                String prefix)

public boolean equals (Object o)

public ComponentName getComponent ()

public int getConfigChanges ()

public String getId ()

public int getIsDefaultResourceId ()

public String getPackageName ()

public ServiceInfo getServiceInfo ()

public String getServiceName ()

public String getSettingsActivity ()

public InputMethodSubtype getSubtypeAt (int index)

public int getSubtypeCount ()

public int hashCode ()

public Drawable loadIcon (PackageManager pm)

public CharSequence loadLabel (PackageManager pm)

public boolean shouldShowInInputMethodPicker ()

public boolean supportsConnectionlessStylusHandwriting ()

public boolean supportsStylusHandwriting ()

public boolean suppressesSpellChecker ()

public String toString ()

public void writeToParcel (Parcel dest, 
                int flags)