Интерфейс InputMethodRequests
- Все известные подинтерфейсы:
- InputMethodContext
public interface InputMethodRequests
InputMethodRequests определяет запросы, которые должен обрабатывать компонент редактирования текста, чтобы работать с методами ввода. Компонент может реализовать этот интерфейс самостоятельно или использовать отдельный объект, который его реализует. Объект, реализующий этот интерфейс, должен возвращаться методом компонента getInputMethodRequests.
Компонент редактирования текста также должен предоставить обработчик событий метода ввода.
Интерфейс предназначен для поддержки одного из двух пользовательских интерфейсов ввода:
- непосредственный ввод, где составленный текст отображается как часть тела текста компонента.
- ниже места ввод, где составленный текст отображается в отдельном окне композиции непосредственно под точкой вставки, где текст будет вставлен при подтверждении. Обратите внимание, что если текст выделен в теле текста компонента, этот текст будет заменён подтверждённым текстом при подтверждении; поэтому он не считается частью контекста, в который вводится текст.
- С:
- 1.2
- См. также:
-
Component.getInputMethodRequests(),InputMethodListener
Методы
| Модификатор и тип | Метод и описание |
|---|---|
AttributedCharacterIterator |
cancelLatestCommittedText(AttributedCharacterIterator.Attribute[] attributes) Получает последний подтверждённый текст из компонента редактирования текста и удаляет его из тела текста компонента. |
AttributedCharacterIterator |
getCommittedText(int beginIndex,
int endIndex,
AttributedCharacterIterator.Attribute[] attributes) Получает итератор, предоставляющий доступ ко всему тексту и атрибутам, содержащимся в компоненте редактирования текста, за исключением неподтверждённого текста. |
int |
getCommittedTextLength() Получает длину всего текста, содержащегося в компоненте редактирования текста, за исключением неподтверждённого (составленного) текста. |
int |
getInsertPositionOffset() Получает смещение позиции вставки в подтверждённом тексте, содержащемся в компоненте редактирования текста. |
TextHitInfo |
getLocationOffset(int x,
int y) Получает смещение в составленном тексте для указанных абсолютных координат x и y на экране. |
AttributedCharacterIterator |
getSelectedText(AttributedCharacterIterator.Attribute[] attributes) Получает текущий выделенный текст из компонента редактирования текста. |
Rectangle |
getTextLocation(TextHitInfo offset) Получает расположение указанного смещения в текущем составленном тексте или выделения в подтверждённом тексте. |
Методы
getTextLocation
Rectangle getTextLocation(TextHitInfo offset)
Получает расположение указанного смещения в текущем составленном тексте или выделения в подтверждённом тексте. Эта информация, например, используется для размещения окна кандидатов рядом с составленным текстом или окна композиции рядом с местом, где будет вставлен подтверждённый текст.
Если компонент содержит составленный текст (потому что недавно отправленное ему событие InputMethodEvent содержало составленный текст), тогда смещение относительно составленного текста — смещение 0 указывает на первый символ в составленном тексте. Возвращаемое расположение должно быть для этого символа.
Если у компонента нет составленного текста, смещение должно быть проигнорировано, и возвращаемое расположение должно отражать начало (в направлении строки) выделения в последней строке, содержащей выделенный текст. Например, для горизонтального текста слева направо (такого как английский) возвращается расположение слева от самого левого символа в последней строке, содержащей выделенный текст. Для вертикального текста сверху вниз, с линиями, идущими справа налево, возвращается расположение сверху от самого левого символа в последней строке, содержащей выделенный текст.
Расположение представлено как кэрером толщиной 0, то есть он имеет ширину 0, если текст выводится горизонтально, и высоту 0, если текст выводится вертикально. Другие ориентации текста должны быть отображены горизонтальной или вертикальной ориентацией. Прямоугольник использует абсолютные экранные координаты.
- Параметры:
-
offset- смещение в составленном тексте, если составленный текст есть; в противном случае null - Возвращает:
- прямоугольник, представляющий экранное расположение смещения
getLocationOffset
TextHitInfo getLocationOffset(int x,
int y) Получает смещение в составленном тексте для указанных абсолютных координат x и y на экране. Эта информация используется, например, для обработки щелчков мышью и курсора мыши. Смещение относительно составленного текста, поэтому смещение 0 указывает на начало составленного текста.
Возвращает null, если расположение находится за пределами области, занимаемой составленным текстом.
- Параметры:
-
x- абсолютная координата x на экране -
y- абсолютная координата y на экране - Возвращает:
- информацию о текстовом ударе, описывающую смещение в составленном тексте.
getInsertPositionOffset
int getInsertPositionOffset()
Получает смещение позиции вставки в подтверждённом тексте, содержащемся в компоненте редактирования текста. Это смещение, в которое вставляются символы, введённые через метод ввода. Эта информация используется методом ввода, например, для анализа текста, окружающего позицию вставки.
- Возвращает:
- смещение позиции вставки
getCommittedText
AttributedCharacterIterator getCommittedText(int beginIndex,
int endIndex,
AttributedCharacterIterator.Attribute[] attributes) Получает итератор, предоставляющий доступ ко всему тексту и атрибутам, содержащимся в компоненте редактирования текста, за исключением неподтверждённого текста. Неподтверждённый (составленный) текст должен игнорироваться для расчётов индексов и не должен быть доступен через итератор.
Метод ввода может предоставить список атрибутов, которые его интересуют. В этом случае информация об других атрибутах, которые может потребоваться реализатору, не должна быть доступна через итератор. Если список равен null, вся доступная информация об атрибутах должна быть доступна.
- Параметры:
-
beginIndex- индекс первого символа -
endIndex- индекс символа, следующего за последним символом -
attributes- список атрибутов, которые интересуют метод ввода - Возвращает:
- итератор, предоставляющий доступ к тексту и его атрибутам
getCommittedTextLength
int getCommittedTextLength()
Получает длину всего текста, содержащегося в компоненте редактирования текста, за исключением неподтверждённого (составленного) текста.
- Возвращает:
- длина текста за исключением неподтверждённого текста
cancelLatestCommittedText
AttributedCharacterIterator cancelLatestCommittedText(AttributedCharacterIterator.Attribute[] attributes)
Получает последний подтверждённый текст из компонента редактирования текста и удаляет его из тела текста компонента. Это используется для функции «Отменить подтверждение» в некоторых методах ввода, где подтверждённый текст возвращается в предыдущее состояние составленного текста. Составленный текст будет отправлен компоненту с помощью события InputMethodEvent.
Как правило, эта функция должна поддерживаться только сразу после подтверждения текста, а не после того, как пользователь выполнил другие операции над текстом. Когда функция не поддерживается, возвращается null.
Метод ввода может предоставить список атрибутов, которые его интересуют. В этом случае информация об других атрибутах, которые может потребоваться реализатору, не должна быть доступна через итератор. Если список равен null, вся доступная информация об атрибутах должна быть доступна.
- Параметры:
-
attributes- список атрибутов, которые интересуют метод ввода - Возвращает:
- последний подтверждённый текст или null, когда функция «Отменить подтверждение» не поддерживается
getSelectedText
AttributedCharacterIterator getSelectedText(AttributedCharacterIterator.Attribute[] attributes)
Получает текущий выделенный текст из компонента редактирования текста. Это может использоваться для различных целей. Одна из них — функция «Преобразовать заново» в некоторых методах ввода. В этом случае метод ввода обычно отправляет событие метода ввода для замены выделенного текста составленным текстом. В зависимости от возможностей метода ввода, это может быть исходный составленный текст для выделенного текста, последний составленный текст, введённый где-либо в тексте, или версия текста, преобразованная обратно из выделенного текста.
Метод ввода может предоставить список атрибутов, которые его интересуют. В этом случае информация об других атрибутах, которые может потребоваться реализатору, не должна быть доступна через итератор. Если список равен null, вся доступная информация об атрибутах должна быть доступна.
- Параметры:
-
attributes- список атрибутов, которые интересуют метод ввода - Возвращает:
- текущий выделенный текст
© 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.