java.awt.im.spi
インタフェース InputMethodContext

すべてのスーパーインタフェース:

InputMethodRequests

public interface InputMethodContext
extends InputMethodRequests

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

導入されたバージョン:

1.3

メソッドの概要

JFrame	createInputMethodJFrame(String title, boolean attachToInputContext) インプットメソッドが使用するトップレベルの Swing JFrame を作成します。
Window	createInputMethodWindow(String title, boolean attachToInputContext) インプットメソッドが使用するトップレベルのウィンドウを作成します。
void	dispatchInputMethodEvent(int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition) 指定された引数でインプットメソッドイベントを作成して、そのイベントをクライアントコンポーネントにディスパッチします。
void	enableClientWindowNotification(InputMethod inputMethod, boolean enable) 指定されたインプットメソッドに対する現在のクライアントウィンドウの位置および状態の通知を使用可能または使用不可能にします。

インタフェース java.awt.im.InputMethodRequests から継承されたメソッド

cancelLatestCommittedText, getCommittedText, getCommittedTextLength, getInsertPositionOffset, getLocationOffset, getSelectedText, getTextLocation

メソッドの詳細

dispatchInputMethodEvent

void dispatchInputMethodEvent(int id,
                              AttributedCharacterIterator text,
                              int committedCharacterCount,
                              TextHitInfo caret,
                              TextHitInfo visiblePosition)

指定された引数でインプットメソッドイベントを作成して、そのイベントをクライアントコンポーネントにディスパッチします。引数については、InputMethodEvent.InputMethodEvent(java.awt.Component, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo) を参照してください。

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