java.awt.im

Class InputMethodHighlight

public class InputMethodHighlight extends Object

This describes the highlight attributes of text composed in an input method. The description includes an abstract level (whether text has been converted yet, and whether it is selected), and a concrete level (which style attributes are used in rendering). If no concrete level is defined, the renderer should use {@link Toolkit#mapInputMethodHighlight(InputMethodHighlight)}. An example of conversion state is kana -> kanji.

Instances of this class are typically used in AttributedCharacterIterators, and may be wrapped in Annotations to separate text segments.

Since: 1.2

UNKNOWN: updated to 1.4

Field Summary
static int	CONVERTED_TEXT Converted text state (after conversion).
static int	RAW_TEXT Raw text state (before conversion).
static InputMethodHighlight	SELECTED_CONVERTED_TEXT_HIGHLIGHT Default do-nothing highlighting for selected converted text.
static InputMethodHighlight	SELECTED_RAW_TEXT_HIGHLIGHT Default do-nothing highlighting for selected raw text.
static InputMethodHighlight	UNSELECTED_CONVERTED_TEXT_HIGHLIGHT Default do-nothing highlighting for unselected converted text.
static InputMethodHighlight	UNSELECTED_RAW_TEXT_HIGHLIGHT Default do-nothing highlighting for unselected raw text.

Constructor Summary
	InputMethodHighlight(boolean selected, int state) Create an input method highlight style, with variation 0 and null style mapping.
	InputMethodHighlight(boolean selected, int state, int variation) Create an input method highlight style, with null style mapping.
	InputMethodHighlight(boolean selected, int state, int variation, Map<TextAttribute,?> style) Create an input method highlight style.

Method Summary
int	getState() Return the conversion state of the highlighted text.
Map<TextAttribute,?>	getStyle() Return the rendering style attributes map, or null if it should be the default mapping.
int	getVariation() Return the highlighting style variation.
boolean	isSelected() Return whether the highlighting applies to selected text.

Field Detail

CONVERTED_TEXT

public static final int CONVERTED_TEXT

Converted text state (after conversion).

RAW_TEXT

public static final int RAW_TEXT

Raw text state (before conversion).

SELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT

Default do-nothing highlighting for selected converted text.

SELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT

Default do-nothing highlighting for selected raw text.

UNSELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT

Default do-nothing highlighting for unselected converted text.

UNSELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT

Default do-nothing highlighting for unselected raw text.

Constructor Detail

InputMethodHighlight

public InputMethodHighlight(boolean selected, int state)

Create an input method highlight style, with variation 0 and null style mapping.

Parameters: selected whether the text range is selected state either {@link #RAW_TEXT} or {@link #CONVERTED_TEXT}

Throws: IllegalArgumentException if state is invalid

InputMethodHighlight

public InputMethodHighlight(boolean selected, int state, int variation)

Create an input method highlight style, with null style mapping.

Parameters: selected whether the text range is selected state either {@link #RAW_TEXT} or {@link #CONVERTED_TEXT} variation the style variation

Throws: IllegalArgumentException if state is invalid

InputMethodHighlight

public InputMethodHighlight(boolean selected, int state, int variation, Map<TextAttribute,?> style)

Create an input method highlight style.

Parameters: selected whether the text range is selected state either {@link #RAW_TEXT} or {@link #CONVERTED_TEXT} variation the style variation style an unmodifiable map of rendering styles, or null

Throws: IllegalArgumentException if state is invalid

Since: 1.3