モジュール java.desktop
パッケージ java.awt.im.spi

インタフェースInputMethodContext

  • すべてのスーパー・インタフェース:
    InputMethodRequests
    public interface InputMethodContext
extends InputMethodRequests
    インプット・メソッドが、そのクライアント・コンポーネントとの通信またはほかのサービスの要求のために使用できるメソッドを提供します。 このインタフェースは、インプット・メソッド・フレームワークによって実装され、インプット・メソッドがInputMethod.setInputMethodContext(java.awt.im.spi.InputMethodContext)から受け取るインスタンスのメソッドを呼び出します。 これ以外の実装者または呼出し元はありません。
    導入されたバージョン:
    1.3

    • メソッドの詳細

      • dispatchInputMethodEvent

        void dispatchInputMethodEvent​(int id,
                              AttributedCharacterIterator text,
                              int committedCharacterCount,
                              TextHitInfo caret,
                              TextHitInfo visiblePosition)
        指定された引数でインプット・メソッド・イベントを作成して、そのイベントをクライアント・コンポーネントにディスパッチします。 引数については、InputMethodEvent(java.awt.Component, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo)を参照してください。
        パラメータ:
        id - イベント・タイプ
        text - コミットされたテキストと合成されたテキスト
        committedCharacterCount - テキスト内の確定された文字の数
        caret - キャレット(挿入ポイント)。現在の構成テキストにキャレットがない場合はnull
        visiblePosition - 可視にするもっとも重要な位置。現在の構成テキスト内に可視位置の推奨がない場合はnull

      • createInputMethodWindow

        Window createInputMethodWindow​(String title,
                               boolean attachToInputContext)
        インプット・メソッドが使用するトップ・レベルのウィンドウを作成します。 このウィンドウの動作を次に示します。
        • すべてのドキュメント・ウィンドウとダイアログの上に表示する
        • ウィンドウとその中のすべてのコンポーネントは、フォーカスを受け取らない
        • タイトルのない縮小ドラッグ領域のような軽量の装飾を保持する
        ただし、これらの3つの項目に関する実際の動作はプラットフォームに依存しています。

        タイトルが表示または非表示となるかは、作成されたウィンドウの実際のタイプに依存します。

        attachToInputContextがtrueの場合、新規ウィンドウは、このインプット・メソッド・コンテキストに対応した入力コンテキストを共有できます。これにより、ウィンドウにあるコンポーネントのイベントは自動的にそのインプット・メソッドにディスパッチされます。 さらに、setVisible(true)を使ってウィンドウを開いているときは、入力コンテキストによって、ほかの方法によるインプット・メソッドへの終了および起動の呼出しが防止されます。

        返されたインプット・メソッド・ウィンドウが必要でなくなった場合に、インプット・メソッドは、そのインプット・メソッド・ウィンドウでWindow.disposeを呼び出す必要があります。

        パラメータ:
        title - タイトル・バーが存在する場合、ウィンドウのタイトル・バーに表示されるタイトル。 null値は、空の文字列""として処理されます。
        attachToInputContext - このウィンドウが、インプット・メソッド・コンテキストに対応する入力コンテキストを共有するかどうか
        戻り値:
        インプット・メソッドが使用する特性を保持するウィンドウ
        例外:
        HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返す場合

      • createInputMethodJFrame

        JFrame createInputMethodJFrame​(String title,
                               boolean attachToInputContext)
        インプット・メソッドが使用するトップ・レベルのSwing JFrameを作成します。 このウィンドウの動作を次に示します。
        • すべてのドキュメント・ウィンドウとダイアログの上に表示する
        • ウィンドウとその中のすべてのコンポーネントは、フォーカスを受け取らない
        • タイトルのない縮小ドラッグ領域のような軽量の装飾を保持する
        ただし、これらの3つの項目に関する実際の動作はプラットフォームに依存しています。

        タイトルが表示または非表示となるかは、作成されたウィンドウの実際のタイプに依存します。

        attachToInputContextがtrueの場合、新規ウィンドウは、このインプット・メソッド・コンテキストに対応した入力コンテキストを共有できます。これにより、ウィンドウにあるコンポーネントのイベントは自動的にそのインプット・メソッドにディスパッチされます。 さらに、setVisible(true)を使ってウィンドウを開いているときは、入力コンテキストによって、ほかの方法によるインプット・メソッドへの終了および起動の呼出しが防止されます。

        返されたインプット・メソッド・ウィンドウが必要でなくなった場合に、インプット・メソッドは、そのインプット・メソッド・ウィンドウでWindow.disposeを呼び出す必要があります。

        パラメータ:
        title - タイトル・バーが存在する場合、ウィンドウのタイトル・バーに表示されるタイトル。 null値は、空の文字列""として処理されます。
        attachToInputContext - このウィンドウが、インプット・メソッド・コンテキストに対応する入力コンテキストを共有するかどうか
        戻り値:
        インプット・メソッドが使用する特性を保持するJFrame
        例外:
        HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返す場合
        導入されたバージョン:
        1.4

      • enableClientWindowNotification

        void enableClientWindowNotification​(InputMethod inputMethod,
                                    boolean enable)
        指定されたインプット・メソッドに対する現在のクライアント・ウィンドウの位置および状態の通知を使用可能または使用不可能にします。 通知が使用可能な場合は、インプット・メソッドのnotifyClientWindowChangeメソッドが、そのメソッドの仕様に記述されているとおりに呼び出されます。 インプット・メソッドが破棄されると、通知は自動的に使用不可能になります。
        パラメータ:
        inputMethod - 通知を使用可能または使用不可能にするインプット・メソッド
        enable - 有効にするにはtrue、無効にするにはfalse