java.awt.im
public class: InputMethodHighlight [javadoc |
source]
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
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 Annotation
instances to indicate separate text segments.
| Field Summary |
|---|
| public static final int | RAW_TEXT | Constant for the raw text state. |
| public static final int | CONVERTED_TEXT | Constant for the converted text state. |
| public static final InputMethodHighlight | UNSELECTED_RAW_TEXT_HIGHLIGHT | Constant for the default highlight for unselected raw text. |
| public static final InputMethodHighlight | SELECTED_RAW_TEXT_HIGHLIGHT | Constant for the default highlight for selected raw text. |
| public static final InputMethodHighlight | UNSELECTED_CONVERTED_TEXT_HIGHLIGHT | Constant for the default highlight for unselected converted text. |
| public static final InputMethodHighlight | SELECTED_CONVERTED_TEXT_HIGHLIGHT | Constant for the default highlight for selected converted text. |
| Constructor: |
|---|
 public InputMethodHighlight(boolean selected,
int state) {
this(selected, state, 0, null);
}
Constructs an input method highlight record.
The variation is set to 0, the style to null. Parameters:
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
- InputMethodHighlight#RAW_TEXT
- InputMethodHighlight#CONVERTED_TEXT
- exception:
IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given
|
public InputMethodHighlight(boolean selected,
int state,
int variation) {
this(selected, state, variation, null);
} Constructs an input method highlight record.
The style is set to null. Parameters:
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
- InputMethodHighlight#RAW_TEXT
- InputMethodHighlight#CONVERTED_TEXT
- exception:
IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given
|
public InputMethodHighlight(boolean selected,
int state,
int variation,
Map<TextAttribute, ?> style) {
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;
} Constructs an input method highlight record.
The style attributes map provided must be unmodifiable. Parameters:
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
- InputMethodHighlight#RAW_TEXT
- InputMethodHighlight#CONVERTED_TEXT
- exception:
IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given
- since:
1.3 -
|
| Methods from java.lang.Object: |
|---|
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method from java.awt.im.InputMethodHighlight Detail: |
|---|
public int getState() {
return state;
} Returns the conversion state of the text range. |
public Map<TextAttribute, ?> getStyle() {
return style;
} Returns the rendering style attributes for the text range, or null. |
public int getVariation() {
return variation;
} Returns the variation of the text range. |
public boolean isSelected() {
return selected;
} Returns whether the text range is selected. |