1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/* * @(#)InputMethodHighlight.java 1.22 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.awt.im; import java.awt.font.TextAttribute; import java.util.Map; /** * 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 * {@link java.awt.Toolkit#mapInputMethodHighlight} to map to a concrete style. * <p> * The abstract description consists of three fields: <code>selected</code>, * <code>state</code>, and <code>variation</code>. * <code>selected</code> 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. * <code>state</code> 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 <code>variation</code> field allows input methods to express additional * information about the conversion results. * <p> * * InputMethodHighlight instances are typically used as attribute values * returned from AttributedCharacterIterator for the INPUT_METHOD_HIGHLIGHT * attribute. They may be wrapped into {@link java.text.Annotation Annotation} * instances to indicate separate text segments. * * @version 1.22, 11/17/05 * @see java.text.AttributedCharacterIterator * @since 1.2 */ public class InputMethodHighlight { /** * Constant for the raw text state. */ public final static int RAW_TEXT = 0; /** * Constant for the converted text state. */ public final static int CONVERTED_TEXT = 1; /** * Constant for the default highlight for unselected raw text. */ public final static InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT = new InputMethodHighlight(false, RAW_TEXT); /** * Constant for the default highlight for selected raw text. */ public final static InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT = new InputMethodHighlight(true, RAW_TEXT); /** * Constant for the default highlight for unselected converted text. */ public final static InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT = new InputMethodHighlight(false, CONVERTED_TEXT); /** * Constant for the default highlight for selected converted text. */ public final static InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT = new InputMethodHighlight(true, CONVERTED_TEXT); /** * Constructs an input method highlight record. * The variation is set to 0, the style to null. * @param selected Whether the text range is selected * @param state The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT * @see InputMethodHighlight#RAW_TEXT * @see InputMethodHighlight#CONVERTED_TEXT * @exception IllegalArgumentException if a state other than RAW_TEXT or CONVERTED_TEXT is given */ public InputMethodHighlight(boolean selected, int state) { this(selected, state, 0, null); } /** * Constructs an input method highlight record. * The style is set to null. * @param selected Whether the text range is selected * @param state The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT * @param variation The style variation for the text range * @see InputMethodHighlight#RAW_TEXT * @see InputMethodHighlight#CONVERTED_TEXT * @exception IllegalArgumentException if a state other than RAW_TEXT or CONVERTED_TEXT is given */ public InputMethodHighlight(boolean selected, int state, int variation) { this(selected, state, variation, null); } /** * Constructs an input method highlight record. * The style attributes map provided must be unmodifiable. * @param selected whether the text range is selected * @param state the conversion state for the text range - RAW_TEXT or CONVERTED_TEXT * @param variation the variation for the text range * @param style the rendering style attributes for the text range, or null * @see InputMethodHighlight#RAW_TEXT * @see InputMethodHighlight#CONVERTED_TEXT * @exception IllegalArgumentException if a state other than RAW_TEXT or CONVERTED_TEXT is given * @since 1.3 */ public InputMethodHighlight(boolean selected, int state, int variation, Map<TextAttribute,?> style) { this.selected = selected; if (!(state == RAW_TEXT || state == CONVERTED_TEXT)) { throw new IllegalArgumentException("unknown input method highlight state"); } this.state = state; this.variation = variation; this.style = style; } /** * Returns whether the text range is selected. */ public boolean isSelected() { return selected; } /** * Returns the conversion state of the text range. * @return The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT. * @see InputMethodHighlight#RAW_TEXT * @see InputMethodHighlight#CONVERTED_TEXT */ public int getState() { return state; } /** * Returns the variation of the text range. */ public int getVariation() { return variation; } /** * Returns the rendering style attributes for the text range, or null. * @since 1.3 */ public Map<TextAttribute,?> getStyle() { return style; } private boolean selected; private int state; private int variation; private Map style; };