Overview  Package   Class  Use  Deprecated  Index
Home >> All >> java >> awt >> [ im overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

java.awt.im
Class InputMethodHighlight  

java.lang.Object
  java.awt.im.InputMethodHighlight

---

public class InputMethodHighlight

extends java.lang.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)>Toolkit.mapInputMethodHighlight(InputMethodHighlight) 55 . 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

---

Field Summary
static int	CONVERTED_TEXT           Converted text state (after conversion).
static int	RAW_TEXT           Raw text state (before conversion).
private  boolean	selected           Whether the highlighting applies to selected text.
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.
private  int	state           The state of highlighted text.
private  java.util.Map	style           The unmodifiable map of rendering styles.
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.
private  int	variation           Any variation on the highlighting style.

 

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, java.util.Map style)           Create an input method highlight style.

 

Method Summary
int	getState()           Return the conversion state of the highlighted text.
java.util.Map	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.

---

selected

private final boolean selected

Whether the highlighting applies to selected text.

---

state

private final int state

The state of highlighted text.

---

variation

private final int variation

Any variation on the highlighting style.

---

style

private final java.util.Map style

The unmodifiable map of rendering styles.

Constructor Detail

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state)

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

---

InputMethodHighlight

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

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

---

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state,
                            int variation,
                            java.util.Map style)

Create an input method highlight style.

Since:

1.3

Method Detail

isSelected

public boolean isSelected()

Return whether the highlighting applies to selected text.

---

getState

public int getState()

Return the conversion state of the highlighted text.

---

getVariation

public int getVariation()

Return the highlighting style variation.

---

getStyle

public java.util.Map getStyle()

Return the rendering style attributes map, or null if it should be the default mapping.

Since:

1.3

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> java >> awt >> [ im overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---