Class java.awt.im.InputMethodHighlight
java.lang.Object
|
+----java.awt.im.InputMethodHighlight
- public class InputMethodHighlight
- extends Object
A InputMethodHighlight is used to describe in an abstract way the highlight
attributes of text being composed. A range of text can be selected or
unselected, and it can be highlighted in different ways to indicate the
conversion state or other interesting, input method specific information
about the text. Two states are predefined and supported directly
by Graphics2D: raw (unconverted) and converted text.
These styles are recommended for use before and after the
main conversion step of text composition, say, before and after kana->kanji
or pinyin->hanzi conversion. However, input methods can add their own style
variations as necessary.
InputMethodHighlight instances are typically used as attribute values
returned from AttributedCharacterIterator for the INPUT_METHOD_HIGHLIGHT
attribute.
- See Also:
- AttributedCharacterIterator
Constructor Summary
|
InputMethodHighlight(boolean selected,
int state)
Constructs an input method highlight record.
|
InputMethodHighlight(boolean selected,
int state,
int variation)
Constructs an input method highlight record.
|
Method Summary
|
int
|
getState()
Returns the conversion state of the text range.
|
int
|
getVariation()
Returns the style variation of the text range.
|
boolean
|
isSelected()
Returns whether the text range is selected.
|
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
INPUT_METHOD_HIGHLIGHT
public static final String INPUT_METHOD_HIGHLIGHT
- Attribute name for input method highlight styles. This name is used to
indicate the input method highlight attribute in
AttributedCharacterIterator or other classes handling text attributes.
These attributes are used while text is being composed using an input
method. Text editing components should retain them even if they
generally only deal with unstyled text, and make them available to the
drawing routines.
InputMethodHighlight instances should be wrapped in Annotation instances
if segments need to be highlighted separately.
- See Also:
- Annotation, AttributedCharacterIterator
RAW_TEXT
public static final int RAW_TEXT
- Constant for the raw text state.
CONVERTED_TEXT
public static final int CONVERTED_TEXT
- Constant for the converted text state.
UNSELECTED_RAW_TEXT_HIGHLIGHT
public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
- Constant for the default highlight for unselected raw text.
SELECTED_RAW_TEXT_HIGHLIGHT
public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
- Constant for the default highlight for selected raw text.
UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
- Constant for the default highlight for unselected converted text.
SELECTED_CONVERTED_TEXT_HIGHLIGHT
public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
- Constant for the default highlight for selected converted text.
InputMethodHighlight
public InputMethodHighlight(boolean selected,
int state)
- Constructs an input method highlight record.
The variation is set to 0.
- Parameters:
selected
- Whether the text range is selected
state
- The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
- Throws:
- IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given
- See Also:
- RAW_TEXT, CONVERTED_TEXT
InputMethodHighlight
public InputMethodHighlight(boolean selected,
int state,
int variation)
- Constructs an input method highlight record.
- 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
- Throws:
- IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given
- See Also:
- RAW_TEXT, CONVERTED_TEXT
isSelected
public boolean isSelected()
- Returns whether the text range is selected.
getState
public int getState()
- Returns the conversion state of the text range.
- Returns:
- The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT.
- See Also:
- RAW_TEXT, CONVERTED_TEXT
getVariation
public int getVariation()
- Returns the style variation of the text range.
Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.