Class InputMethodHighlight
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.
- Since:
- 1.2
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Constant for the converted text state.static final int
Constant for the raw text state.static final InputMethodHighlight
Constant for the default highlight for selected converted text.static final InputMethodHighlight
Constant for the default highlight for selected raw text.static final InputMethodHighlight
Constant for the default highlight for unselected converted text.static final InputMethodHighlight
Constant for the default highlight for unselected raw text. -
Constructor Summary
ConstructorDescriptionInputMethodHighlight
(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. -
Method Summary
Modifier and TypeMethodDescriptionint
getState()
Returns the conversion state of the text range.Map
<TextAttribute, ?> getStyle()
Returns the rendering style attributes for the text range, or null.int
Returns the variation of the text range.boolean
Returns whether the text range is selected.
-
Field Details
-
RAW_TEXT
public static final int RAW_TEXTConstant for the raw text state.- See Also:
-
CONVERTED_TEXT
public static final int CONVERTED_TEXTConstant for the converted text state.- See Also:
-
UNSELECTED_RAW_TEXT_HIGHLIGHT
Constant for the default highlight for unselected raw text. -
SELECTED_RAW_TEXT_HIGHLIGHT
Constant for the default highlight for selected raw text. -
UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
Constant for the default highlight for unselected converted text. -
SELECTED_CONVERTED_TEXT_HIGHLIGHT
Constant for the default highlight for selected converted text.
-
-
Constructor Details
-
InputMethodHighlight
public InputMethodHighlight(boolean selected, int state) Constructs an input method highlight record. The variation is set to 0, the style to null.- Parameters:
selected
- Whether the text range is selectedstate
- The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT- Throws:
IllegalArgumentException
- if a state other than RAW_TEXT or CONVERTED_TEXT is given- See Also:
-
InputMethodHighlight
public InputMethodHighlight(boolean selected, int state, int variation) Constructs an input method highlight record. The style is set to null.- Parameters:
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- Throws:
IllegalArgumentException
- if a state other than RAW_TEXT or CONVERTED_TEXT is given- See Also:
-
InputMethodHighlight
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.- Parameters:
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 null- Throws:
IllegalArgumentException
- if a state other than RAW_TEXT or CONVERTED_TEXT is given- Since:
- 1.3
- See Also:
-
-
Method Details
-
isSelected
public boolean isSelected()Returns whether the text range is selected.- Returns:
- whether the text range is selected
-
getState
public int getState()Returns the conversion state of the text range.- Returns:
- The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT.
- See Also:
-
getVariation
public int getVariation()Returns the variation of the text range.- Returns:
- the variation of the text range
-
getStyle
Returns the rendering style attributes for the text range, or null.- Returns:
- the rendering style attributes for the text range, or null
- Since:
- 1.3
-