Defines the interface for an input method that supports complex text input.
Provides methods that input methods can use to communicate with their client components or to request other services.
Defines methods that provide sufficient information about an input method to enable selection and loading of that input method.
Provides interfaces that enable the development of input methods that can be used with any Java runtime environment. Input methods are software components that let the user enter text in ways other than simple typing on a keyboard. They are commonly used to enter Japanese, Chinese, or Korean - languages using thousands of different characters - on keyboards with far fewer keys. However, this package also allows the development of input methods for other languages and the use of entirely different input mechanisms, such as handwriting recognition.
Input methods are packaged as installed extensions, as specified by the Extension Mechanism. The main JAR file of an input method must contain the file:
The file should contain a list of fully-qualified class names, one
per line, of classes implementing the
java.awt.im.spi.InputMethodDescriptor interface. Space
and tab characters surrounding each name, as well as blank lines, are
ignored. The comment character is
\u0023); on each line all characters following the
first comment character are ignored. The file must be encoded in
For example, if the fully-qualified name of the class that
java.awt.im.spi.InputMethodDesciptor for the
Foo input method is
com.sun.ime.FooInputMethodDescriptor, the file
contains a line:
The input method must also provide at least two classes: one class
interface, one class implementing the
java.awt.im.spi.InputMethod interface. The input method
should separate the implementations for these interfaces, so that
loading of the class implementing
InputMethod can be
deferred until actually needed.
The input method framework will usually defer loading of input
method classes until they are absolutely needed. It loads only the
InputMethodDescriptor implementations during AWT
initialization. It loads an
when the input method has been selected.
The Java input method framework intends to support all combinations of input methods (host input methods and Java input methods) and components (peered and lightweight). However, because of limitations in the underlying platform, it may not always be possible to enable the communication between Java input methods and peered AWT components. Support for this specific combination is therefore platform dependent. In Sun's Java SE Runtime Environments, this combination is supported on Windows, but not on Solaris.
For overviews, tutorials, examples, guides, and tool documentation, please see:
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.