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

Поля, объявленные в классе 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 со специфицированным компонентом источника, типом, временем, текстом, точкой вставки и видимой позицией.

Смещения точки вставки и видимой позиции относятся к текущему составленному тексту; то есть, составленному тексту в 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()

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

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

isConsumed в классе AWTEvent

Возвращает:

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

См. также:

getWhen

public long getWhen()

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

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

paramString

public String paramString()

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

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

© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/event/InputMethodEvent.html