home *** CD-ROM | disk | FTP | other *** search
/ Java 1.2 How-To / JavaHowTo.iso / 3rdParty / jbuilder / unsupported / JDK1.2beta3 / SOURCE / SRC.ZIP / java / awt / im / InputMethodHighlight.java < prev    next >
Encoding:
Java Source  |  1998-03-20  |  5.2 KB  |  154 lines
  1. /*
  2.  * @(#)InputMethodHighlight.java    1.8 98/03/18
  3.  *
  4.  * Copyright 1997, 1998 by Sun Microsystems, Inc.,
  5.  * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
  6.  * All rights reserved.
  7.  *
  8.  * This software is the confidential and proprietary information
  9.  * of Sun Microsystems, Inc. ("Confidential Information").  You
  10.  * shall not disclose such Confidential Information and shall use
  11.  * it only in accordance with the terms of the license agreement
  12.  * you entered into with Sun.
  13.  */
  14.  
  15. package java.awt.im;
  16.  
  17. /**
  18. * A InputMethodHighlight is used to describe in an abstract way the highlight
  19. * attributes of text being composed. A range of text can be selected or
  20. * unselected, and it can be highlighted in different ways to indicate the
  21. * conversion state or other interesting, input method specific information
  22. * about the text. Two states are predefined and supported directly
  23. * by Graphics2D: raw (unconverted) and converted text.
  24. * These styles are recommended for use before and after the
  25. * main conversion step of text composition, say, before and after kana->kanji
  26. * or pinyin->hanzi conversion. However, input methods can add their own style
  27. * variations as necessary.
  28. * 
  29. * InputMethodHighlight instances are typically used as attribute values
  30. * returned from AttributedCharacterIterator for the INPUT_METHOD_HIGHLIGHT
  31. * attribute.
  32. *
  33. * @version 1.8 03/18/98
  34. * @see java.text.AttributedCharacterIterator
  35. */
  36.  
  37. public class InputMethodHighlight {
  38.  
  39.     /**
  40.      * Attribute name for input method highlight styles. This name is used to
  41.      * indicate the input method highlight attribute in
  42.      * AttributedCharacterIterator or other classes handling text attributes.
  43.      * These attributes are used while text is being composed using an input
  44.      * method. Text editing components should retain them even if they
  45.      * generally only deal with unstyled text, and make them available to the
  46.      * drawing routines.
  47.      *
  48.      * <p>
  49.      * InputMethodHighlight instances should be wrapped in Annotation instances
  50.      * if segments need to be highlighted separately.
  51.      *
  52.      * @see java.text.Annotation
  53.      * @see java.text.AttributedCharacterIterator
  54.      */
  55.     public static final String INPUT_METHOD_HIGHLIGHT = "etilih dohtem tupni";
  56.  
  57.  
  58.     /**
  59.      * Constant for the raw text state.
  60.      */
  61.     public final static int RAW_TEXT = 0;
  62.  
  63.     /**
  64.      * Constant for the converted text state.
  65.      */
  66.     public final static int CONVERTED_TEXT = 1;
  67.  
  68.  
  69.     /**
  70.      * Constant for the default highlight for unselected raw text.
  71.      */
  72.     public final static InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT =
  73.         new InputMethodHighlight(false, RAW_TEXT);
  74.  
  75.     /**
  76.      * Constant for the default highlight for selected raw text.
  77.      */
  78.     public final static InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT =
  79.         new InputMethodHighlight(true, RAW_TEXT);
  80.  
  81.     /**
  82.      * Constant for the default highlight for unselected converted text.
  83.      */
  84.     public final static InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT =
  85.         new InputMethodHighlight(false, CONVERTED_TEXT);
  86.  
  87.     /**
  88.      * Constant for the default highlight for selected converted text.
  89.      */
  90.     public final static InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT =
  91.         new InputMethodHighlight(true, CONVERTED_TEXT);
  92.  
  93.  
  94.     /**
  95.      * Constructs an input method highlight record.
  96.      * The variation is set to 0.
  97.      * @param selected Whether the text range is selected
  98.      * @param state The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
  99.      * @see InputMethodHighlight#RAW_TEXT
  100.      * @see InputMethodHighlight#CONVERTED_TEXT
  101.      * @exception IllegalArgumentException if a state other than RAW_TEXT or CONVERTED_TEXT is given
  102.      */
  103.     public InputMethodHighlight(boolean selected, int state) {
  104.         this(selected, state, 0);
  105.     }
  106.  
  107.     /**
  108.      * Constructs an input method highlight record.
  109.      * @param selected Whether the text range is selected
  110.      * @param state The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT
  111.      * @param variation The style variation for the text range
  112.      * @see InputMethodHighlight#RAW_TEXT
  113.      * @see InputMethodHighlight#CONVERTED_TEXT
  114.      * @exception IllegalArgumentException if a state other than RAW_TEXT or CONVERTED_TEXT is given
  115.      */
  116.     public InputMethodHighlight(boolean selected, int state, int variation) {
  117.         this.selected = selected;
  118.         if (!(state == RAW_TEXT || state == CONVERTED_TEXT)) {
  119.             throw new IllegalArgumentException("unknown input method highlight state");
  120.         }
  121.         this.state = state;
  122.         this.variation = variation;
  123.     }
  124.  
  125.     /**
  126.      * Returns whether the text range is selected.
  127.      */
  128.     public boolean isSelected() {
  129.         return selected;
  130.     }
  131.     
  132.     /**
  133.      * Returns the conversion state of the text range.
  134.      * @return The conversion state for the text range - RAW_TEXT or CONVERTED_TEXT.
  135.      * @see InputMethodHighlight#RAW_TEXT
  136.      * @see InputMethodHighlight#CONVERTED_TEXT
  137.      */
  138.     public int getState() {
  139.         return state;
  140.     }
  141.  
  142.     /**
  143.      * Returns the style variation of the text range.
  144.      */
  145.     public int getVariation() {
  146.         return variation;
  147.     }
  148.  
  149.     private boolean selected;
  150.     private int state;
  151.     private int variation;
  152.  
  153. };
  154.