Класс InputMethodEvent

java.lang.Object
- java.util.EventObject
- - java.awt.AWTEvent
  - - java.awt.event.InputMethodEvent

Все реализованные интерфейсы:: Serializable

public class InputMethodEvent
extends AWTEvent

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

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

С тех пор:: 1.2
См. также:: Сериализованная форма

Поля

Модификатор и тип	Поле и описание
`static int`	`CARET_POSITION_CHANGED` Тип события, указывающий на изменение точки вставки в тексте метода ввода.
`static int`	`INPUT_METHOD_FIRST` Помечает первый целочисленный идентификатор для диапазона идентификаторов событий метода ввода.
`static int`	`INPUT_METHOD_LAST` Помечает последний целочисленный идентификатор для диапазона идентификаторов событий метода ввода.
`static 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, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)` Создает `InputMethodEvent` с указанным исходным компонентом, типом, текстом, курсором и видимым положением.
`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` с указанным исходным компонентом, типом, курсором и видимым положением.

Методы

Модификатор и тип	Метод и описание
`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
См. также:: consume()

getWhen

public long getWhen()

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

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

paramString

public String paramString()

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

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

© 1993, 2020, 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.