| |
|
| java.lang.Object
 java.awt.im.InputMethodHighlight
| InputMethodHighlight | | public class InputMethodHighlight (Code) | | 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
java.text.Annotation Annotation instances to indicate separate text segments.
version:
1.28, 05/05/07
See Also: java.text.AttributedCharacterIterator
since:
1.2 |
| Constructor Summary | |
| public | InputMethodHighlight(boolean selected, int state)
Constructs an input method highlight record. | | public | InputMethodHighlight(boolean selected, int state, int variation)
Constructs an input method highlight record. | | public | InputMethodHighlight(boolean selected, int state, int variation, Map<TextAttribute, ?> style)
Constructs an input method highlight record. |
| Method Summary | |
| public int | getState()
Returns the conversion state of the text range. | | public Map<TextAttribute, ?> | getStyle()
Returns the rendering style attributes for the text range, or null. | | public int | getVariation()
Returns the variation of the text range. | | public boolean | isSelected()
Returns whether the text range is selected. |
| CONVERTED_TEXT | | final public static int CONVERTED_TEXT(Code) | | Constant for the converted text state.
|
| RAW_TEXT | | final public static int RAW_TEXT(Code) | | Constant for the raw text state.
|
| SELECTED_CONVERTED_TEXT_HIGHLIGHT | | final public static InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT(Code) | | Constant for the default highlight for selected converted text.
|
| SELECTED_RAW_TEXT_HIGHLIGHT | | final public static InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT(Code) | | Constant for the default highlight for selected raw text.
|
| UNSELECTED_CONVERTED_TEXT_HIGHLIGHT | | final public static InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT(Code) | | Constant for the default highlight for unselected converted text.
|
| UNSELECTED_RAW_TEXT_HIGHLIGHT | | final public static InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT(Code) | | Constant for the default highlight for unselected raw text.
|
| InputMethodHighlight | | public InputMethodHighlight(boolean selected, int state)(Code) | | Constructs an input method highlight record.
The variation is set to 0, the style to null.
Parameters:
selected - Whether the text range is selected
Parameters:
state - The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
See Also: InputMethodHighlight.RAW_TEXT
See Also: InputMethodHighlight.CONVERTED_TEXT
exception:
IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given |
| InputMethodHighlight | | public InputMethodHighlight(boolean selected, int state, int variation)(Code) | | Constructs an input method highlight record.
The style is set to null.
Parameters:
selected - Whether the text range is selected
Parameters:
state - The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
Parameters:
variation - The style variation for the text range
See Also: InputMethodHighlight.RAW_TEXT
See Also: InputMethodHighlight.CONVERTED_TEXT
exception:
IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given |
| InputMethodHighlight | | public InputMethodHighlight(boolean selected, int state, int variation, Map<TextAttribute, ?> style)(Code) | | Constructs an input method highlight record.
The style attributes map provided must be unmodifiable.
Parameters:
selected - whether the text range is selected
Parameters:
state - the conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
Parameters:
variation - the variation for the text range
Parameters:
style - the rendering style attributes for the text range, or null
See Also: InputMethodHighlight.RAW_TEXT
See Also: InputMethodHighlight.CONVERTED_TEXT
exception:
IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given
since:
1.3 |
| getStyle | | public Map<TextAttribute, ?> getStyle()(Code) | | Returns the rendering style attributes for the text range, or null.
since:
1.3 |
| getVariation | | public int getVariation()(Code) | | Returns the variation of the text range.
|
| isSelected | | public boolean isSelected()(Code) | | Returns whether the text range is selected.
|
|
|
|