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

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

Параметры:: 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

См. также:

consume()

getWhen

public long getWhen()

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

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

paramString

public String paramString()

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

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

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