Интерфейс 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)

Возвращает значок для соответствующего метода ввода. Значок может использоваться интерфейсом пользователя для выбора методов ввода.

Размер значка должен составлять 16×16 пикселей.

Параметры:: inputLocale - языковой вариант, для которого поддерживается ввод текста, или null
Возвращает:: значок для соответствующего метода ввода, или null

createInputMethod

InputMethod createInputMethod()
                       throws Exception

Создаёт новый экземпляр соответствующего метода ввода.

Возвращает:: новый экземпляр соответствующего метода ввода
Исключение:: Exception - любое исключение, которое может возникнуть при создании экземпляра метода ввода