Класс InputMethodHighlight

java.lang.Object
- java.awt.im.InputMethodHighlight

public class InputMethodHighlight
extends Object

InputMethodHighlight используется для описания атрибутов выделения текста, который вводится. Описание может быть на двух уровнях: на абстрактном уровне он указывает состояние преобразования и выделен ли текст; на конкретном уровне он указывает атрибуты стиля, используемые для отображения выделения. InputMethodHighlight должен предоставить описание на абстрактном уровне; он может или не может предоставить описание на конкретном уровне. Если конкретный стиль не указан, рендерер должен использовать Toolkit.mapInputMethodHighlight(java.awt.im.InputMethodHighlight) для отображения конкретного стиля.

Абстрактное описание состоит из трех полей: selected, state, и variation. selected указывает, является ли диапазон текста тем, над которым в данный момент работает метод ввода, например, сегмент, для которого в настоящее время отображаются кандидаты на преобразование в меню. state представляет собой состояние преобразования. Значения состояния определяются фреймворком метода ввода и должны быть различимы во всех отображениях от абстрактного к конкретному стилю. В настоящее время определены состояния raw (непреобразованный) и converted (преобразованный). Эти значения состояния рекомендуется использовать до и после основного шага преобразования при составлении текста, например, до и после преобразования kana->kanji или pinyin->hanzi. Поле variation позволяет методам ввода выражать дополнительную информацию о результатах преобразования.

Экземпляры InputMethodHighlight обычно используются в качестве значений атрибутов, возвращаемых AttributedCharacterIterator для атрибута INPUT_METHOD_HIGHLIGHT. Они могут быть обернуты в Annotation экземпляры для указания отдельных сегментов текста.

Since:: 1.2
See Also:: AttributedCharacterIterator

Поля

Модификатор и тип	Поле	Описание
`static int`	`CONVERTED_TEXT`	Константа для состояния преобразованного текста.
`static int`	`RAW_TEXT`	Константа для состояния исходного текста.
`static InputMethodHighlight`	`SELECTED_CONVERTED_TEXT_HIGHLIGHT`	Константа для стандартного выделения выделенного преобразованного текста.
`static InputMethodHighlight`	`SELECTED_RAW_TEXT_HIGHLIGHT`	Константа для стандартного выделения выделенного исходного текста.
`static InputMethodHighlight`	`UNSELECTED_CONVERTED_TEXT_HIGHLIGHT`	Константа для стандартного выделения невыделенного преобразованного текста.
`static InputMethodHighlight`	`UNSELECTED_RAW_TEXT_HIGHLIGHT`	Константа для стандартного выделения невыделенного исходного текста.

Краткое описание конструкторов

Конструктор	Описание
`InputMethodHighlight(boolean selected, int state)`	Создаёт запись выделения метода ввода.
`InputMethodHighlight(boolean selected, int state, int variation)`	Создаёт запись выделения метода ввода.
`InputMethodHighlight(boolean selected, int state, int variation, Map<TextAttribute,?> style)`	Создаёт запись выделения метода ввода.

Краткое описание методов

Модификатор и тип	Метод	Описание
`int`	`getState()`	Возвращает состояние преобразования диапазона текста.
`Map<TextAttribute,?>`	`getStyle()`	Возвращает атрибуты стиля рендеринга для диапазона текста или null.
`int`	`getVariation()`	Возвращает вариацию диапазона текста.
`boolean`	`isSelected()`	Возвращает, выделен ли диапазон текста.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

RAW_TEXT

public static final int RAW_TEXT

Константа для состояния исходного текста.

See Also:: Constant Field Values

CONVERTED_TEXT

public static final int CONVERTED_TEXT

Константа для состояния преобразованного текста.

See Also:: Constant Field Values

UNSELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT

Константа для стандартного выделения невыделенного исходного текста.

SELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT

Константа для стандартного выделения выделенного исходного текста.

UNSELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT

Константа для стандартного выделения невыделенного преобразованного текста.

SELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT

Константа для стандартного выделения выделенного преобразованного текста.

Подробное описание конструкторов

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state)

Создаёт запись выделения метода ввода. Вариация установлена в 0, стиль в null.

Parameters:: selected - Выделен ли диапазон текста; state - Состояние преобразования диапазона текста - RAW_TEXT или CONVERTED_TEXT
Throws:: IllegalArgumentException - если задано состояние отличное от RAW_TEXT или CONVERTED_TEXT
See Also:: RAW_TEXT, CONVERTED_TEXT

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state,
                            int variation)

Создаёт запись выделения метода ввода. Стиль установлен в null.

Parameters:: selected - Выделен ли диапазон текста; state - Состояние преобразования диапазона текста - RAW_TEXT или CONVERTED_TEXT; variation - Вариация стиля для диапазона текста
Throws:: IllegalArgumentException - если задано состояние отличное от RAW_TEXT или CONVERTED_TEXT
See Also:: RAW_TEXT, CONVERTED_TEXT

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state,
                            int variation,
                            Map<TextAttribute,?> style)

Создаёт запись выделения метода ввода. Карта атрибутов стиля, предоставленная, должна быть неизменяемой.

Parameters:: selected - выделен ли диапазон текста; state - состояние преобразования диапазона текста - RAW_TEXT или CONVERTED_TEXT; variation - вариация для диапазона текста; style - атрибуты рендеринга стиля для диапазона текста, или null
Throws:: IllegalArgumentException - если задано состояние отличное от RAW_TEXT или CONVERTED_TEXT
Since:: 1.3
See Also:: RAW_TEXT, CONVERTED_TEXT

Подробное описание методов

isSelected

public boolean isSelected()

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

Returns:: выделен ли диапазон текста

getState

public int getState()

Возвращает состояние преобразования диапазона текста.

Returns:: Состояние преобразования диапазона текста - RAW_TEXT или CONVERTED_TEXT.
See Also:: RAW_TEXT, CONVERTED_TEXT

getVariation

public int getVariation()

Возвращает вариацию диапазона текста.

Returns:: вариация диапазона текста

getStyle

public Map<TextAttribute,?> getStyle()

Возвращает атрибуты стиля рендеринга для диапазона текста, или null.

Returns:: атрибуты стиля рендеринга для диапазона текста, или null
Since:: 1.3