Класс InputMethodEvent

java.awt.event.InputMethodEvent

Все реализуемые интерфейсы:: Serializable

public class InputMethodEvent extends AWTEvent

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

Текст, включённый в событие ввода, состоит из двух частей: подтверждённого текста и составленного текста. Любая из этих частей может быть пустой. Обе части вместе заменяют любой неподтверждённый составленный текст, отправленный в предыдущих событиях, или текущий выбранный подтверждённый текст. Подтверждённый текст должен быть интегрирован в постоянные данные текстового компонента; он больше не будет отправлен. Составленный текст может быть отправлен многократно, с изменениями, отражающими действия пользователя по редактированию. Подтверждённый текст всегда предшествует составленному тексту.

Since:

1.2

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`CARET_POSITION_CHANGED`	Тип события, указывающий на изменение точки вставки в тексте метода ввода.
`static final int`	`INPUT_METHOD_FIRST`	Помечает первый целочисленный идентификатор для диапазона идентификаторов событий метода ввода.
`static final int`	`INPUT_METHOD_LAST`	Помечает последний целочисленный идентификатор для диапазона идентификаторов событий метода ввода.
`static final int`	`INPUT_METHOD_TEXT_CHANGED`	Тип события, указывающий на изменённый текст метода ввода.

Поля, объявленные в классе java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Поля, объявленные в классе java.util.EventObject

source

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

Конструктор	Описание
`InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)`	Создаёт `InputMethodEvent` со указанным исходным компонентом, типом, временем, текстом, курсором и видимым положением.
`InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)`	Создаёт `InputMethodEvent` со указанным исходным компонентом, типом, курсором и видимым положением.
`InputMethodEvent(Component source, int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)`	Создаёт `InputMethodEvent` со указанным исходным компонентом, типом, текстом, курсором и видимым положением.

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

Модификатор и тип	Метод	Описание
`void`	`consume()`	Потребляет это событие, чтобы оно не обрабатывалось в стандартном режиме источником, который его породил.
`TextHitInfo`	`getCaret()`	Получает курсор.
`int`	`getCommittedCharacterCount()`	Получает количество подтверждённых символов в тексте.
`AttributedCharacterIterator`	`getText()`	Получает объединённый подтверждённый и составленный текст.
`TextHitInfo`	`getVisiblePosition()`	Получает позицию, которая наиболее важна для отображения.
`long`	`getWhen()`	Возвращает отметку времени возникновения этого события.
`boolean`	`isConsumed()`	Возвращает, было ли это событие поглощено.
`String`	`paramString()`	Возвращает строку параметра, идентифицирующую это событие.

Методы, объявленные в классе java.awt.AWTEvent

getID, setSource, toString

Методы, объявленные в классе java.util.EventObject

getSource

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

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

Подробное описание полей

INPUT_METHOD_FIRST

@Native public static final int INPUT_METHOD_FIRST

Помечает первый целочисленный идентификатор для диапазона идентификаторов событий ввода.

См. также:

INPUT_METHOD_TEXT_CHANGED

@Native public static final int INPUT_METHOD_TEXT_CHANGED

Тип события, указывающий на изменение текста ввода. Это событие генерируется методами ввода во время обработки ввода.

См. также:

CARET_POSITION_CHANGED

@Native public static final int CARET_POSITION_CHANGED

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

См. также:

INPUT_METHOD_LAST

@Native public static final int INPUT_METHOD_LAST

Помечает последний целочисленный идентификатор для диапазона идентификаторов событий ввода.

См. также:

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

InputMethodEvent

public InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)

Создаёт событие InputMethodEvent с указанным компонентом-источником, типом, временем, текстом, курсором и видимым положением.

Смещения курсора и visiblePosition относятся к текущему составленному тексту; то есть к составленному тексту в text, если это событие INPUT_METHOD_TEXT_CHANGED, к составленному тексту в text предыдущего события INPUT_METHOD_TEXT_CHANGED в противном случае.

Обратите внимание, что передача некорректного id приводит к неопределенному поведению. Этот метод выбрасывает IllegalArgumentException, если source равно null.

Параметры:: source - объект, откуда исходит событие; id - тип события; when - целое число с плавающей точкой, указывающее время возникновения события; text - объединённый подтверждённый и составленный текст, подтверждённый текст сначала; должен быть null, когда тип события равен CARET_POSITION_CHANGED; может быть null для INPUT_METHOD_TEXT_CHANGED, если нет подтверждённого или составленного текста; committedCharacterCount - количество подтверждённых символов в тексте; caret - курсор (также известный как точка вставки); null, если нет курсора в текущем составленном тексте; visiblePosition - положение, которое наиболее важно отображать; null, если нет рекомендации по видимому положению в текущем составленном тексте
Исключения:: IllegalArgumentException - если id не находится в диапазоне INPUT_METHOD_FIRST..INPUT_METHOD_LAST; или если id равен CARET_POSITION_CHANGED, и text не равно null; или если committedCharacterCount не находится в диапазоне 0..(text.getEndIndex() - text.getBeginIndex()); IllegalArgumentException - если source равно null
С момента:: 1.4

InputMethodEvent

public InputMethodEvent(Component source, int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)

Создаёт событие InputMethodEvent с указанным компонентом-источником, типом, текстом, курсором и видимым положением.

Параметры:: source - объект, откуда исходит событие; id - тип события; text - объединённый подтверждённый и составленный текст, подтверждённый текст сначала; должен быть null, когда тип события равен CARET_POSITION_CHANGED; может быть null для INPUT_METHOD_TEXT_CHANGED, если нет подтверждённого или составленного текста; committedCharacterCount - количество подтверждённых символов в тексте; caret - курсор (также известный как точка вставки); null, если нет курсора в текущем составленном тексте; visiblePosition - положение, которое наиболее важно отображать; null, если нет рекомендации по видимому положению в текущем составленном тексте
Исключения:: IllegalArgumentException - если id не находится в диапазоне INPUT_METHOD_FIRST..INPUT_METHOD_LAST; или если id равен CARET_POSITION_CHANGED, и text не равно null; или если committedCharacterCount не находится в диапазоне 0..(text.getEndIndex() - text.getBeginIndex()); IllegalArgumentException - если source равно null

InputMethodEvent

public InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)

Создаёт событие InputMethodEvent с указанным компонентом-источником, типом, курсором и видимым положением. Текст установлен на null, committedCharacterCount равно 0.

Смещения caret и visiblePosition относятся к текущему составленному тексту; то есть к составленному тексту в text предыдущего события INPUT_METHOD_TEXT_CHANGED, если создаваемое событие — CARET_POSITION_CHANGED. Для события INPUT_METHOD_TEXT_CHANGED без текста, caret и visiblePosition должны быть null. Отметка времени для этого события инициализируется вызовом EventQueue.getMostRecentEventTime().

Параметры:: source - объект, откуда исходит событие; id - тип события; caret - курсор (также известный как точка вставки); null, если нет курсора в текущем составленном тексте; visiblePosition - положение, которое наиболее важно отображать; null, если нет рекомендации по видимому положению в текущем составленном тексте
Исключения:: IllegalArgumentException - если id не находится в диапазоне INPUT_METHOD_FIRST..INPUT_METHOD_LAST; IllegalArgumentException - если source равно null

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

getText

public AttributedCharacterIterator getText()

Получает объединённый подтверждённый и составленный текст. Символы с индексом от 0 до getCommittedCharacterCount() - 1 — подтверждённый текст, оставшиеся символы — составленный текст.

Возвращает:: текст. Всегда null для CARET_POSITION_CHANGED; может быть null для INPUT_METHOD_TEXT_CHANGED, если нет составленного или подтверждённого текста.

getCommittedCharacterCount

public int getCommittedCharacterCount()

Получает количество подтверждённых символов в тексте.

Возвращает:: количество подтверждённых символов в тексте

getCaret

public TextHitInfo getCaret()

Получает курсор.

Смещение курсора относится к текущему составленному тексту; то есть к составленному тексту в getText(), если это событие INPUT_METHOD_TEXT_CHANGED, к составленному тексту в getText() предыдущего события INPUT_METHOD_TEXT_CHANGED в противном случае.

Возвращает:: курсор (также известный как точка вставки). Null, если нет курсора в текущем составленном тексте.

getVisiblePosition

public TextHitInfo getVisiblePosition()

Получает положение, которое наиболее важно отображать.

Смещение видимого положения относится к текущему составленному тексту; то есть к составленному тексту в getText(), если это событие INPUT_METHOD_TEXT_CHANGED, к составленному тексту в getText() предыдущего события INPUT_METHOD_TEXT_CHANGED в противном случае.

Возвращает:: положение, которое наиболее важно отображать. Null, если нет рекомендации по видимому положению в текущем составленном тексте.

consume

public void consume()

Обрабатывает это событие таким образом, что оно не будет обработано исходным источником стандартным способом.

Переопределяет:: consume в классе AWTEvent

isConsumed

public boolean isConsumed()

Возвращает, был ли этот событие потреблен.

Overrides:

isConsumed в классе AWTEvent

Возвращает:

true, если это событие было потреблено; в противном случае false

См. также:

getWhen

public long getWhen()

Возвращает отметку времени, когда произошло это событие.

Возвращает:: временная метка события
С:: 1.4

paramString

public String paramString()

Возвращает строку параметров, идентифицирующую это событие. Этот метод полезен для ведения журнала событий и для отладки. Он содержит идентификатор события в текстовой форме, символы введённого и составленного текста, разделённые "+", количество введённых символов, курсор и видимое положение.

Overrides:: paramString в классе AWTEvent
Возвращает:: строка, идентифицирующая событие и его атрибуты

© 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/event/InputMethodEvent.html