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

Смещения курсора и видимой позиции относятся к текущему составленному тексту; то есть к составленному тексту в text если это событие INPUT_METHOD_TEXT_CHANGED, составленному тексту в text предыдущего события INPUT_METHOD_TEXT_CHANGED в противном случае. Отметка времени для этого события инициализируется вызовом EventQueue.getMostRecentEventTime().

Обратите внимание, что передача недопустимого 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().

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

Параметры:
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, 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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/event/InputMethodEvent.html

Spec-Zone .ru
спецификации, руководства, описания, API