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 - 可能在創建輸入方法實例時發生的任何異常