java.awt.im
Class InputMethodHighlight

java.lang.Object
  extended by java.awt.im.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 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
See Also:
AttributedCharacterIterator, Annotation

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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RAW_TEXT

public static final int RAW_TEXT
Raw text state (before conversion).

See Also:
Constant Field Values

CONVERTED_TEXT

public static final int CONVERTED_TEXT
Converted text state (after conversion).

See Also:
Constant Field Values

UNSELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
Default do-nothing highlighting for unselected raw 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.


SELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
Default do-nothing highlighting for selected converted 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 RAW_TEXT or 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 RAW_TEXT or 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 RAW_TEXT or CONVERTED_TEXT
variation - the style variation
style - an unmodifiable map of rendering styles, or null
Throws:
IllegalArgumentException - if state is invalid
Since:
1.3
Method Detail

isSelected

public boolean isSelected()
Return whether the highlighting applies to selected text.

Returns:
the selection status

getState

public int getState()
Return the conversion state of the highlighted text.

Returns:
one of RAW_TEXT or CONVERTED_TEXT

getVariation

public int getVariation()
Return the highlighting style variation.

Returns:
the variation

getStyle

public Map<TextAttribute,?> getStyle()
Return the rendering style attributes map, or null if it should be the default mapping.

Returns:
the style map
Since:
1.3