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 - インプット・メソッドのインスタンスの生成中に起こるすべての例外

インタフェースInputMethodDescriptor

メソッドのサマリー

メソッドの詳細

getAvailableLocales

hasDynamicLocaleList

getInputMethodDisplayName

getInputMethodIcon

createInputMethod