java.lang.Object | |
↳ | java.awt.im.InputMethodHighlight |
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
mapInputMethodHighlight(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.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | CONVERTED_TEXT | Constant for the converted text state. | |||||||||
int | RAW_TEXT | Constant for the raw text state. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
SELECTED_CONVERTED_TEXT_HIGHLIGHT | Constant for the default highlight for selected converted 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. | ||||||||||
UNSELECTED_RAW_TEXT_HIGHLIGHT | Constant for the default highlight for unselected raw text. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs an input method highlight record.
| |||||||||||
Constructs an input method highlight record.
| |||||||||||
Constructs an input method highlight record.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the conversion state of the text range.
| |||||||||||
Returns the rendering style attributes for the text range, or null.
| |||||||||||
Returns the variation of the text range.
| |||||||||||
Returns whether the text range is selected.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Constant for the converted text state.
Constant for the raw text state.
Constant for the default highlight for selected converted text.
Constant for the default highlight for selected raw text.
Constant for the default highlight for unselected converted text.
Constant for the default highlight for unselected raw text.
Constructs an input method highlight record. The variation is set to 0, the style to null.
selected | Whether the text range is selected |
---|---|
state | The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT |
IllegalArgumentException | if a state other than RAW_TEXT or CONVERTED_TEXT is given |
---|
Constructs an input method highlight record. The style is set to null.
selected | Whether the text range is selected |
---|---|
state | The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT |
variation | The style variation for the text range |
IllegalArgumentException | if a state other than RAW_TEXT or CONVERTED_TEXT is given |
---|
Constructs an input method highlight record. The style attributes map provided must be unmodifiable.
selected | whether the text range is selected |
---|---|
state | the conversion state for the text range - RAW_TEXT or CONVERTED_TEXT |
variation | the variation for the text range |
style | the rendering style attributes for the text range, or null |
IllegalArgumentException | if a state other than RAW_TEXT or CONVERTED_TEXT is given |
---|
Returns the conversion state of the text range.
Returns the rendering style attributes for the text range, or null.
Returns the variation of the text range.
Returns whether the text range is selected.