Интерфейс InputMethod

void setInputMethodContext(InputMethodContext context)

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

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

boolean setLocale(Locale locale)

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

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

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

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)

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.