Класс InputMethodEvent

java.awt.event.InputMethodEvent

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

public class InputMethodEvent extends AWTEvent

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

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

Начиная с:

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`	Тип события, указывающий на изменение текста метода ввода.

Поля, объявленные в классе 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

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

source

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

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

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

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

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

getID, setSource, toString

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

getSource

Методы, объявленные в классе 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.

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

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

Параметры:: source — объект, в котором возникло событие; id — тип события; when — целое число типа long, указывающее время возникновения события; 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 с указанными исходным компонентом, типом, текстом, кареткой и visiblePosition.

Параметры:: 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 с указанными исходным компонентом, типом, кареткой и visiblePosition. Тексту присваивается значение 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()

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

Переопределяет:

isConsumed в классе AWTEvent

Возвращает:

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

См. также:

getWhen

public long getWhen()

Возвращает отметку времени возникновения этого события.

Возвращает:: отметку времени этого события
Начиная с:: 1.4

paramString

public String paramString()

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

Переопределяет:: 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/event/InputMethodEvent.html