Интерфейс InputMethod

void setInputMethodContext(InputMethodContext context)

Устанавливает контекст метода ввода, который используется для отправки событий метода ввода клиенту-компоненту и для запроса информации от клиента-компонента.

Этот метод вызывается один раз сразу после создания этого метода ввода.

boolean setLocale(Locale locale)

Попытка установить локаль ввода. Если метод ввода поддерживает желаемую локаль, он изменяет свое поведение, чтобы поддерживать ввод для этой локали, и возвращает true. В противном случае он возвращает false и не изменяет свое поведение.

Этот метод вызывается

• методом InputContext.selectInputMethod,
• при переключении на этот метод ввода через пользовательский интерфейс, если пользователь указал локаль или если метод getLocale ранее выбранного метода ввода возвращает значение, отличное от null.

Locale getLocale()

Возвращает текущую локаль ввода. Может вернуть null в исключительных случаях.

Этот метод вызывается

• методом InputContext.getLocale и
• при переключении с этого метода ввода на другой через пользовательский интерфейс.

void setCharacterSubsets(Character.Subset[] subsets)

Устанавливает подмножества набора символов Юникод, которые этому методу ввода разрешено вводить. Null может быть передан, чтобы указать, что разрешены все символы.

Этот метод вызывается

• непосредственно после создания этого метода ввода,
• при переключении на этот метод ввода с другого, и
• методом InputContext.setCharacterSubsets.

void setCompositionEnabled(boolean enable)

Включает или выключает данный метод ввода для составления, в зависимости от значения параметра enable.

Метод ввода, включенный для составления, интерпретирует входящие события как для составления, так и для управления, в то время как выключенный метод ввода не интерпретирует события для составления. Обратите внимание, однако, что события передаются методу ввода независимо от того, включен он или нет, и что метод ввода, выключенный для составления, все еще может интерпретировать события для управления, включая включение или выключение себя для составления.

Для методов ввода, предоставляемых хост-операционными системами, не всегда возможно определить, поддерживается ли эта операция. Например, метод ввода может включить составление только для некоторых локалей и ничего не делать для других локалей. Для таких методов ввода возможно, что этот метод не выбросит UnsupportedOperationException, но также не повлияет на включение составления.

Этот метод вызывается

• методом InputContext.setCompositionEnabled,
• при переключении на этот метод ввода с другого с помощью пользовательского интерфейса или InputContext.selectInputMethod, если метод isCompositionEnabled ранее выбранного метода ввода возвращается без выброса исключения.

boolean isCompositionEnabled()

Определяет, включен ли этот метод ввода. Метод ввода, включенный для составления, интерпретирует входящие события как для составления, так и для управления, в то время как выключенный метод ввода не интерпретирует события для составления.

Этот метод вызывается

• методом InputContext.isCompositionEnabled и
• при переключении с этого метода ввода на другой с помощью пользовательского интерфейса или InputContext.selectInputMethod.

void reconvert()

Запускает операцию преобразования. Метод ввода получает текст, который нужно перевести, от текущего клиента-компонента, используя метод InputMethodRequests.getSelectedText. Он может использовать другие InputMethodRequests методы для запроса дополнительной информации, необходимой для операции преобразования. Составленный и подтвержденный текст, полученный в результате операции, отправляется клиенту-компоненту как последовательность InputMethodEvent. Если данный текст не может быть преобразован, тот же текст должен быть отправлен клиенту-компоненту как подтвержденный текст.

Этот метод вызывается методом InputContext.reconvert.

void dispatchEvent(AWTEvent event)

Отправляет событие методу ввода. Если поддержка метода ввода включена для фокусированного компонента, входящие события определенных типов отправляются текущему методу ввода для этого компонента перед отправкой их методам или обработчикам событий компонента. Метод ввода определяет, нужно ли ему обрабатывать событие. Если нужно, он также вызывает метод consume события; это приводит к тому, что событие не отправляется методам обработки событий или обработчикам событий компонента.

События отправляются, если они являются экземплярами InputEvent или его подклассов. Это включает экземпляры классов AWT KeyEvent и MouseEvent.

Этот метод вызывается методом InputContext.dispatchEvent.

void notifyClientWindowChange(Rectangle bounds)

Уведомляет этот метод ввода об изменениях местоположения или состояния окна клиента. Этот метод вызывается, когда этот метод ввода является текущим методом ввода своего контекста ввода, и уведомления для него включены (см. InputMethodContext.enableClientWindowNotification). Вызовы этого метода временно приостанавливаются, если вызывается метод removeNotify контекста ввода, и возобновляются при активации метода ввода для нового компонента клиента. Он вызывается в следующих ситуациях:

• при изменении местоположения, размера, видимости, состояния иконности окна, содержащего текущий компонент клиента, или при закрытии окна.
• из enableClientWindowNotification(inputMethod, true) если текущий компонент клиента существует,
• при активации метода ввода впервые после вызова enableClientWindowNotification(inputMethod, true) если во время вызова доступный компонент клиента отсутствовал,
• при активации метода ввода для нового компонента клиента после вызова метода removeNotify контекста ввода.

void activate()

Активирует метод ввода для немедленной обработки ввода.

Если метод ввода предоставляет свои собственные окна, он должен убедиться, что все необходимые окна открыты и видны на этом этапе.

Этот метод вызывается

• методом InputContext.dispatchEvent при получении компонентом клиента события FOCUS_GAINED,
• при переключении на этот метод ввода с другого с помощью пользовательского интерфейса или InputContext.selectInputMethod.

Метод вызывается только тогда, когда метод ввода неактивен. Новый созданный метод ввода считается неактивным.

void deactivate(boolean isTemporary)

Деактивирует метод ввода. Аргумент isTemporary имеет то же значение, что и в FocusEvent.isTemporary.

Если метод ввода предоставляет собственные окна, только окна, относящиеся к текущей композиции (например, окно выбора поиска), должны быть закрыты на этом этапе. Возможно, что метод ввода будет немедленно активирован снова для другого компонента клиента, и закрытие и повторное открытие более постоянных окон (например, панели управления) создаст ненужную мерцание экрана. Перед активацией экземпляра другого класса метода ввода, метод hideWindows() вызывается на текущем методе ввода.

Этот метод вызывается

• методом InputContext.dispatchEvent, когда клиентский компонент получает событие FOCUS_LOST,
• при переключении с этого метода ввода на другой с помощью пользовательского интерфейса или InputContext.selectInputMethod,
• перед removeNotify, если текущий клиентский компонент удален.

Метод вызывается только при активном методе ввода.

void hideWindows()

Закрывает или скрывает все окна, открытые этим экземпляром метода ввода или его классом.

Этот метод вызывается

• перед вызовом activate для экземпляра другого класса метода ввода,
• перед вызовом dispose для этого метода ввода.

Метод вызывается только при неактивном методе ввода.

void removeNotify()

Уведомляет метод ввода о том, что клиентский компонент был удален из его иерархии контейнеров или что поддержка метода ввода была отключена для компонента.

Этот метод вызывается InputContext.removeNotify.

Метод вызывается только при неактивном методе ввода.

void endComposition()

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

Компонент редактирования текста может вызвать этот метод в различных ситуациях, например, когда пользователь перемещает точку вставки внутри текста (но вне составленного текста) или когда текст компонента сохраняется в файл или копируется в буфер обмена.

Этот метод вызывается

• методом InputContext.endComposition,
• методом InputContext.dispatchEvent при переключении на другой клиентский компонент
• при переключении с этого метода ввода на другой с помощью пользовательского интерфейса или InputContext.selectInputMethod.

void dispose()

Освобождает ресурсы, используемые этим методом ввода. В частности, метод ввода должен утилизировать окна и закрывать файлы, которые больше не нужны.

Этот метод вызывается InputContext.dispose.

Метод вызывается только при неактивном методе ввода. Ни один метод этого интерфейса не вызывается для этого экземпляра после dispose.

Object getControlObject()

Возвращает объект управления из этого метода ввода или null. Объект управления предоставляет методы для управления поведением метода ввода или получения информации из метода ввода. Тип объекта — специфичный для метода ввода класс. Клиенты должны сравнивать результат с известными классами объектов управления методом ввода и приводить к соответствующему классу, чтобы вызвать предоставленные методы.

Этот метод вызывается InputContext.getInputMethodControlObject.