|
JSR 216 (Maintenance Release) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.im.InputMethodHighlight
An InputMethodHighlight is used to describe the highlight attributes of text being composed.
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.
AttributedCharacterIterator
Field Summary | |
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 Summary | |
InputMethodHighlight(boolean selected,
int state)
Constructs an input method highlight record. |
|
InputMethodHighlight(boolean selected,
int state,
int variation)
Constructs an input method highlight record. |
Method Summary | |
int |
getState()
Returns the conversion state of the text range. |
int |
getVariation()
Returns the variation of the text range. |
boolean |
isSelected()
Returns whether the text range is selected. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
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
Constructor Detail |
public InputMethodHighlight(boolean selected, int state)
selected
- Whether the text range is selectedstate
- The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
IllegalArgumentException
- 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 range
IllegalArgumentException
- if a state other than RAW_TEXT or CONVERTED_TEXT is givenRAW_TEXT
,
CONVERTED_TEXT
Method Detail |
public boolean isSelected()
public int getState()
RAW_TEXT
,
CONVERTED_TEXT
public int getVariation()
|
JSR 216 (Maintenance Release) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |