java.awt.im.spi

インタフェース InputMethodDescriptor

public interface InputMethodDescriptor

インプットメソッドの選択およびロードを可能にするために、そのインプットメソッドに関する十分な情報を提供するメソッドを定義します。インプットメソッド自体は実際に使用するときだけロードされます。

導入されたバージョン:

1.3

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
InputMethod	createInputMethod() 対応するインプットメソッドの新しいインスタンスを生成します。
Locale[]	getAvailableLocales() 対応するインプットメソッドがサポートするロケールを返します。
String	getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage) 指定された入力ロケールのインプットメソッドに対応する、ユーザーに表示される名前を、その名前が表示される言語で返します。
Image	getInputMethodIcon(Locale inputLocale) インプットメソッドに対応するアイコンを返します。
boolean	hasDynamicLocaleList() 実行時に使用できるロケールのリストが変更される可能性があるかどうかを返します。

メソッドの詳細

getAvailableLocales

Locale[] getAvailableLocales()
                             throws AWTException

対応するインプットメソッドがサポートするロケールを返します。ロケールには言語だけを記述することもでき、必要に応じて国やバリアント情報も記述できます。この情報はロケール (InputContext.selectInputMethod(Locale)) によってインプットメソッドを選択するときに使用します。また、ロケールによりユーザーに表示するインプットメソッドをソートする際にも使用できます。

インプットメソッドのプライマリロケールだけが返されます。たとえば、日本語のインプットメソッドがローマ字のパススルーモードを備えている場合でも、通常、日本語だけが返されます。したがって、返されるロケールのリストは、通常、ロケールのサブセットで、それに対応するインプットメソッドの実装 InputMethod.setLocale(java.util.Locale) は true を返します。

hasDynamicLocaleList() が true を返すと、このメソッドは情報が必要になるたびに呼び出されます。こうして、ネットワークリソースに依存しているインプットメソッドに対してリソースが利用できるときはロケールを追加し、リソースが利用できないときはロケールを削除する機会が与えられます。

戻り値:

インプットメソッドがサポートするロケール

例外:

AWTException - インプットメソッドが、インストールが不完全であるなどの理由で使用できない場合。

hasDynamicLocaleList

boolean hasDynamicLocaleList()

実行時に使用できるロケールのリストが変更される可能性があるかどうかを返します。たとえば、アダプタがネットワーク上の実際のインプットメソッドにアクセスする場合などです。

getInputMethodDisplayName

String getInputMethodDisplayName(Locale inputLocale,
                               Locale displayLanguage)

指定された入力ロケールのインプットメソッドに対応する、ユーザーに表示される名前を、その名前が表示される言語で返します。

inputLocale パラメータはテキストを入力するロケールを指定します。このパラメータはこの記述子の getAvailableLocales() メソッドから取得した値、または null だけをとることができます。null の場合は、入力ロケールに依存しないインプットメソッド名を返します。

指定された言語表示が使用できない場合は、ほかの言語を使用します。

パラメータ:

inputLocale - テキスト入力をサポートするロケール、または null

displayLanguage - 名前を表示する言語

getInputMethodIcon

Image getInputMethodIcon(Locale inputLocale)

インプットメソッドに対応するアイコンを返します。アイコンはユーザーインタフェースがインプットメソッドを選択するときに使用します。

inputLocale パラメータはテキストを入力するロケールを指定します。このパラメータはこの記述子の getAvailableLocales() メソッドから取得した値、または null だけをとることができます。null の場合は、入力ロケールに依存しないインプットメソッドアイコンを返します。

アイコンのサイズは 16×16 ピクセルとします。

パラメータ:

inputLocale - テキスト入力をサポートするロケール、または null

戻り値:

対応するインプットメソッドのアイコン、または null

createInputMethod

InputMethod createInputMethod()
                              throws Exception

対応するインプットメソッドの新しいインスタンスを生成します。

戻り値:

対応するインプットメソッドの新しいインスタンス

例外:

Exception - インプットメソッドのインスタンスの生成中に起こるすべての例外