Spec-Zone.ru › OpenJDK 25

Класс InputContext

java.lang.Object
java.awt.im.InputContext
public class InputContext extends Object
Предоставляет методы для управления средствами ввода текста, такими как методы ввода и раскладки клавиатуры. Два метода работают как с методами ввода, так и с раскладками клавиатуры: selectInputMethod позволяет клиентскому компоненту выбрать метод ввода или раскладку клавиатуры по локали, а getLocale позволяет клиентскому компоненту получить локаль текущего метода ввода или раскладки клавиатуры. Остальные методы предназначены для взаимодействия с методами ввода: они позволяют клиентским компонентам управлять поведением методов ввода и передавать им события клиентского компонента.

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

Платформа Java поддерживает методы ввода, разработанные на языке программирования Java с использованием интерфейсов пакета java.awt.im.spi, которые можно сделать доступными, добавив их в путь к классам приложения. Реализации также могут поддерживать использование встроенных методов ввода платформ, на которых они работают; однако не все платформы и локали предоставляют методы ввода. Раскладки клавиатуры предоставляются хост-платформой.

Методы ввода недоступны, если (a) не установлен ни один метод ввода, написанный на языке программирования Java, и (b) реализация платформы Java или базовая платформа не поддерживает встроенные методы ввода. В этом случае контексты ввода по-прежнему можно создавать и использовать; их поведение описано для каждого метода ниже.

С момента:
1.2
См. также:
  • Component.getInputContext()
  • Component.enableInputMethods(boolean)

Краткое описание конструкторов

InputContext()
Модификатор Конструктор Описание
protected
Создает InputContext.

Краткое описание методов

Модификатор и тип Метод Описание
void dispatchEvent(AWTEvent event)
Передает событие активному методу ввода.
void dispose()
Освобождает ресурсы, используемые этим контекстом ввода.
void endComposition()
Завершает любой текущий процесс композиции ввода в этом контексте.
Object getInputMethodControlObject()
Возвращает управляющий объект текущего метода ввода или null.
static InputContext getInstance()
Возвращает новый экземпляр InputContext.
Locale getLocale()
Возвращает текущую локаль текущего метода ввода или раскладки клавиатуры.
boolean isCompositionEnabled()
Определяет, включен ли текущий метод ввода для композиции.
void reconvert()
Запрашивает у текущего метода ввода повторное преобразование текста из текущего клиентского компонента.
void removeNotify(Component client)
Уведомляет контекст ввода о том, что клиентский компонент удален из иерархии контейнеров или для компонента отключена поддержка методов ввода.
boolean selectInputMethod(Locale locale)
Пытается выбрать метод ввода или раскладку клавиатуры, поддерживающие указанную локаль, и возвращает значение, указывающее, удалось ли выбрать такой метод ввода или раскладку клавиатуры.
void setCharacterSubsets(Character.Subset[] subsets)
Задает подмножества набора символов Unicode, ввод которых должен быть разрешен методам ввода этого контекста ввода.
void setCompositionEnabled(boolean enable)
Включает или отключает текущий метод ввода для композиции в зависимости от значения параметра enable.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

InputContext

protected InputContext()
Создает InputContext. Этот метод является защищенным, поэтому клиенты не могут создавать экземпляры InputContext напрямую. Контексты ввода получают с помощью вызова getInstance().

Подробное описание методов

getInstance

public static InputContext getInstance()
Возвращает новый экземпляр InputContext.
Возвращает:
новый экземпляр InputContext

selectInputMethod

public boolean selectInputMethod(Locale locale)
Пытается выбрать метод ввода или раскладку клавиатуры, поддерживающие указанную локаль, и возвращает значение, указывающее, удалось ли выбрать такой метод ввода или раскладку клавиатуры. Выбор выполняется с помощью следующих шагов, пока не будет выбран метод ввода:
  • Если текущий выбранный метод ввода или раскладка клавиатуры поддерживают запрошенную локаль, они остаются выбранными.
  • Если нет доступного метода ввода или раскладки клавиатуры, поддерживающих запрошенную локаль, текущий метод ввода или раскладка клавиатуры остаются выбранными.
  • Если пользователь ранее выбрал метод ввода или раскладку клавиатуры для запрошенной локали в пользовательском интерфейсе, повторно выбирается последний из таких методов ввода или раскладок клавиатуры.
  • В противном случае метод ввода или раскладка клавиатуры, поддерживающие запрошенную локаль, выбираются способом, зависящим от реализации.
Перед переключением с метода ввода фиксируется любой незавершенный текст. Если метод ввода или раскладка клавиатуры, поддерживающие запрошенную локаль, недоступны, возвращается false.

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

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

Параметры:
locale — желаемая новая локаль.
Возвращает:
true, если активный после этого вызова метод ввода или раскладка клавиатуры поддерживают желаемую локаль.
Исключения:
NullPointerException — если locale равен null

getLocale

public Locale getLocale()
Возвращает текущую локаль текущего метода ввода или раскладки клавиатуры. Возвращает null, если у контекста ввода нет текущего метода ввода или раскладки клавиатуры либо если метод InputMethod.getLocale() текущего метода ввода возвращает null.

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

Возвращает:
текущую локаль текущего метода ввода или раскладки клавиатуры
С момента:
1.3

setCharacterSubsets

public void setCharacterSubsets(Character.Subset[] subsets)
Задает подмножества набора символов Unicode, ввод которых должен быть разрешен методам ввода этого контекста ввода. Значение null можно передать, чтобы указать, что разрешены все символы. Начальное значение — null. Настройка применяется как к текущему методу ввода, так и к методам ввода, выбранным после вызова этого метода. Однако приложения не могут рассчитывать на то, что этот вызов даст желаемый результат, поскольку передать эту настройку всем хост-методам ввода невозможно; приложениям по-прежнему необходимо выполнять собственную проверку символов. Если методы ввода недоступны, этот метод ничего не делает.
Параметры:
subsets — подмножества набора символов Unicode, из которых могут вводиться символы

setCompositionEnabled

public void setCompositionEnabled(boolean enable)
Включает или отключает текущий метод ввода для композиции в зависимости от значения параметра enable.

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

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

Параметры:
enable — следует ли включить текущий метод ввода для композиции
Исключения:
UnsupportedOperationException — если текущий метод ввода недоступен или не поддерживает операцию включения/отключения
С момента:
1.3
См. также:
  • isCompositionEnabled()

isCompositionEnabled

public boolean isCompositionEnabled()
Определяет, включен ли текущий метод ввода для композиции. Метод ввода, включенный для композиции, интерпретирует входящие события как для композиции, так и для управления, тогда как отключенный метод ввода не интерпретирует события для композиции.
Возвращает:
true, если текущий метод ввода включен для композиции; false в противном случае
Исключения:
UnsupportedOperationException — если текущий метод ввода недоступен или не поддерживает проверку того, включен ли он для композиции
С момента:
1.3
См. также:
  • setCompositionEnabled(boolean)

reconvert

public void reconvert()
Запрашивает у текущего метода ввода повторное преобразование текста из текущего клиентского компонента. Метод ввода получает текст для повторного преобразования из клиентского компонента с помощью метода InputMethodRequests.getSelectedText. Остальные методы InputMethodRequests должны быть готовы обрабатывать дальнейшие запросы метода ввода. Составленный и/или зафиксированный текст будет передан клиентскому компоненту в виде последовательности объектов InputMethodEvent. Если метод ввода не может выполнить повторное преобразование указанного текста, текст возвращается как зафиксированный текст в объекте InputMethodEvent.
Исключения:
UnsupportedOperationException — если текущий метод ввода недоступен или не поддерживает операцию повторного преобразования.
С момента:
1.3

dispatchEvent

public void dispatchEvent(AWTEvent event)
Передает событие активному методу ввода. Вызывается AWT. Если методы ввода недоступны, событие никогда не будет обработано методом ввода.
Параметры:
event — событие
Исключения:
NullPointerException — если event равен null

removeNotify

public void removeNotify(Component client)
Уведомляет контекст ввода о том, что клиентский компонент удален из иерархии контейнеров или для компонента отключена поддержка методов ввода. Обычно этот метод вызывается из метода Component.removeNotify клиентского компонента. Потенциально ожидающий ввод от методов ввода для этого компонента отбрасывается. Если методы ввода недоступны, этот метод ничего не делает.
Параметры:
client — клиентский компонент
Исключения:
NullPointerException — если client равен null

endComposition

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

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

dispose

public void dispose()
Освобождает ресурсы, используемые этим контекстом ввода. Вызывается AWT для контекста ввода по умолчанию каждого Window. Если методы ввода недоступны, этот метод ничего не делает.

getInputMethodControlObject

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

Если методы ввода недоступны или текущий метод ввода не предоставляет управляющий объект, возвращается null.

Возвращает:
управляющий объект текущего метода ввода или null.

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее дочерних компаний в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее дочерние компании, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/im/InputContext.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API