jdk.awt.im.InputMethodHighlight — clojure-interop/java.awt 1.0.5

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 Toolkit.mapInputMethodHighlight(java.awt.im.InputMethodHighlight) 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 Annotation instances to indicate separate text segments.

*-converted-text clj

Static Constant.

Constant for the converted text state.

type: int

*-raw-text clj

Static Constant.

Constant for the raw text state.

type: int

*-selected-converted-text-highlight clj

Static Constant.

Constant for the default highlight for selected converted text.

type: java.awt.im.InputMethodHighlight

*-selected-raw-text-highlight clj

Static Constant.

Constant for the default highlight for selected raw text.

type: java.awt.im.InputMethodHighlight

*-unselected-converted-text-highlight clj

Static Constant.

Constant for the default highlight for unselected converted text.

type: java.awt.im.InputMethodHighlight

*-unselected-raw-text-highlight clj

Static Constant.

Constant for the default highlight for unselected raw text.

type: java.awt.im.InputMethodHighlight

->input-method-highlight clj

(->input-method-highlight selected state)

(->input-method-highlight selected state variation)

(->input-method-highlight selected state variation style)

Constructor.

Constructs an input method highlight record. The style attributes map provided must be unmodifiable.

selected - whether the text range is selected - boolean state - the conversion state for the text range - RAW_TEXT or CONVERTED_TEXT - int variation - the variation for the text range - int style - the rendering style attributes for the text range, or null - java.util.Map

throws: java.lang.IllegalArgumentException - if a state other than RAW_TEXT or CONVERTED_TEXT is given

get-state clj

(get-state this)

Returns the conversion state of the text range.

returns: The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT. - int

get-style clj

(get-style this)

Returns the rendering style attributes for the text range, or null.

returns: java.util.Map<java.awt.font.TextAttribute,?>

get-variation clj

(get-variation this)

Returns the variation of the text range.

returns: int

selected? clj

(selected? this)

Returns whether the text range is selected.

returns: boolean