public class InputMethodHighlight extends Object
An InputMethodHighlight is used to describe the highlight attributes of text being composed. The description can be at two levels: at the abstract level it specifies the conversion state and whether the text is selected; at the concrete level it specifies style attributes used to render the highlight. An InputMethodHighlight must provide the description at the abstract level; it may or may not provide the description at the concrete level. If no concrete style is provided, a renderer should use Toolkit.mapInputMethodHighlight(java.awt.im.InputMethodHighlight) to map to a concrete style.
The abstract description consists of three fields: selected, state, and variation. selected indicates whether the text range is the one that the input method is currently working on, for example, the segment for which conversion candidates are currently shown in a menu. state represents the conversion state. State values are defined by the input method framework and should be distinguished in all mappings from abstract to concrete styles. Currently defined state values are raw (unconverted) and converted. These state values are recommended for use before and after the main conversion step of text composition, say, before and after kana->kanji or pinyin->hanzi conversion. The variation field allows input methods to express additional information about the conversion results.
InputMethodHighlight instances are typically used as attribute values returned from AttributedCharacterIterator for the INPUT_METHOD_HIGHLIGHT attribute. They may be wrapped into Annotation instances to indicate separate text segments.
AttributedCharacterIteratorpublic static final int RAW_TEXT
Constant for the raw text state.
public static final int CONVERTED_TEXT
Constant for the converted text state.
public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
Constant for the default highlight for unselected raw text.
public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
Constant for the default highlight for selected raw text.
public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
Constant for the default highlight for unselected converted text.
public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
Constant for the default highlight for selected converted text.
public InputMethodHighlight(boolean selected,
int state) Constructs an input method highlight record. The variation is set to 0, the style to null.
selected - Whether the text range is selectedstate - The conversion state for the text range - RAW_TEXT or CONVERTED_TEXTIllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is givenRAW_TEXT, CONVERTED_TEXT
public InputMethodHighlight(boolean selected,
int state,
int variation) Constructs an input method highlight record. The style is set to null.
selected - Whether the text range is selectedstate - The conversion state for the text range - RAW_TEXT or CONVERTED_TEXTvariation - The style variation for the text rangeIllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is givenRAW_TEXT, CONVERTED_TEXT
public InputMethodHighlight(boolean selected,
int state,
int variation,
Map<TextAttribute,?> style) Constructs an input method highlight record. The style attributes map provided must be unmodifiable.
selected - whether the text range is selectedstate - the conversion state for the text range - RAW_TEXT or CONVERTED_TEXTvariation - the variation for the text rangestyle - the rendering style attributes for the text range, or nullIllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is givenRAW_TEXT, CONVERTED_TEXT
public boolean isSelected()
Returns whether the text range is selected.
public int getState()
Returns the conversion state of the text range.
RAW_TEXT, CONVERTED_TEXT
public int getVariation()
Returns the variation of the text range.
public Map<TextAttribute,?> getStyle()
Returns the rendering style attributes for the text range, or null.
© 1993–2017, 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.