public class InputMethodHighlight extends Object
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.
AttributedCharacterIterator
Modifier and Type | Field | Description |
---|---|---|
static int |
CONVERTED_TEXT |
Constant for the converted text state.
|
static int |
RAW_TEXT |
Constant for the raw text state.
|
static InputMethodHighlight |
SELECTED_CONVERTED_TEXT_HIGHLIGHT |
Constant for the default highlight for selected converted text.
|
static InputMethodHighlight |
SELECTED_RAW_TEXT_HIGHLIGHT |
Constant for the default highlight for selected raw text.
|
static InputMethodHighlight |
UNSELECTED_CONVERTED_TEXT_HIGHLIGHT |
Constant for the default highlight for unselected converted text.
|
static InputMethodHighlight |
UNSELECTED_RAW_TEXT_HIGHLIGHT |
Constant for the default highlight for unselected raw text.
|
Constructor | Description |
---|---|
InputMethodHighlight(boolean selected,
int state) |
Constructs an input method highlight record.
|
InputMethodHighlight(boolean selected,
int state,
int variation) |
Constructs an input method highlight record.
|
InputMethodHighlight(boolean selected,
int state,
int variation,
Map<TextAttribute,?> style) |
Constructs an input method highlight record.
|
Modifier and Type | Method | Description |
---|---|---|
int |
getState() |
Returns the conversion state of the text range.
|
Map<TextAttribute,?> |
getStyle() |
Returns the rendering style attributes for the text range, or null.
|
int |
getVariation() |
Returns the variation of the text range.
|
boolean |
isSelected() |
Returns whether the text range is selected.
|
public static final int RAW_TEXT
public static final int CONVERTED_TEXT
public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
public InputMethodHighlight(boolean selected, int state)
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)
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)
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()
public int getState()
RAW_TEXT
,
CONVERTED_TEXT
public int getVariation()
public Map<TextAttribute,?> getStyle()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps