InputMethodHighlightpublic 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
{@link java.awt.Toolkit#mapInputMethodHighlight} 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 {@link java.text.Annotation Annotation}
instances to indicate separate text segments. |
| Fields Summary |
|---|
| public static final int | RAW_TEXTConstant for the raw text state. | | public static final int | CONVERTED_TEXTConstant for the converted text state. | | public static final InputMethodHighlight | UNSELECTED_RAW_TEXT_HIGHLIGHTConstant for the default highlight for unselected raw text. | | public static final InputMethodHighlight | SELECTED_RAW_TEXT_HIGHLIGHTConstant for the default highlight for selected raw text. | | public static final InputMethodHighlight | UNSELECTED_CONVERTED_TEXT_HIGHLIGHTConstant for the default highlight for unselected converted text. | | public static final InputMethodHighlight | SELECTED_CONVERTED_TEXT_HIGHLIGHTConstant for the default highlight for selected converted text. | | private boolean | selected | | private int | state | | private int | variation | | private Map | style |
| Constructors Summary |
|---|
public InputMethodHighlight(boolean selected, int state)Constructs an input method highlight record.
The variation is set to 0, the style to null.
this(selected, state, 0, null);
| public InputMethodHighlight(boolean selected, int state, int variation)Constructs an input method highlight record.
The style is set to null.
this(selected, state, variation, null);
| public InputMethodHighlight(boolean selected, int state, int variation, Map style)Constructs an input method highlight record.
The style attributes map provided must be unmodifiable.
this.selected = selected;
if (!(state == RAW_TEXT || state == CONVERTED_TEXT)) {
throw new IllegalArgumentException("unknown input method highlight state");
}
this.state = state;
this.variation = variation;
this.style = style;
|
| Methods Summary |
|---|
| public int | getState()Returns the conversion state of the text range.
return state;
| | public java.util.Map | getStyle()Returns the rendering style attributes for the text range, or null.
return style;
| | public int | getVariation()Returns the variation of the text range.
return variation;
| | public boolean | isSelected()Returns whether the text range is selected.
return selected;
|
|
