libjava/java/awt/im/spi/InputMethodContext.java

   1 /* InputMethodContext.java -- communication between an input method and client
   2    Copyright (C) 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.awt.im.spi;
  39
  40 import java.awt.HeadlessException;
  41 import java.awt.Window;
  42 import java.awt.font.TextHitInfo;
  43 import java.awt.im.InputMethodRequests;
  44 import java.text.AttributedCharacterIterator;
  45 import javax.swing.JFrame;
  46
  47 /**
  48  * Provides methods for the communication context between an input method
  49  * and the client component. This should be passed to
  50  * {@link InputMethod#setInputMethodContext(InputMethodContext)}.
  51  *
  52  * @author Eric Blake <ebb9@email.byu.edu>
  53  * @since 1.3
  54  * @status updated to 1.4
  55  */
  56 public interface InputMethodContext extends InputMethodRequests
  57 {
  58   /**
  59    * Create an input method event and dispatch it to the client.
  60    *
  61    * @param id the event type
  62    * @param text an iterator over the text to be committed
  63    * @param count the count of characters to be committed
  64    * @param caret the insertion point of the commit, or null
  65    * @param visiblePosition the best location to make visible, or null
  66    */
  67   void dispatchInputMethodEvent(int id, AttributedCharacterIterator text,
  68                                 int count, TextHitInfo caret,
  69                                 TextHitInfo visiblePosition);
  70
  71   /**
  72    * Creates a top-level window for use by the input method. This window should
  73    * float above all document windows and dialogs, not receive focus, and have
  74    * lightweight decorations (such as no title, reduced drag regions). But
  75    * this behavior may be modified to meet the platform style. The title may
  76    * or may not be displayed, depending on the platform.
  77    *
  78    * <p>If attachToInputContext is true, the new window will share the input
  79    * context of the input method, so that events in the new window are
  80    * dispatched to the input method. Also, this supresses deactivate and
  81    * activate calls to the input method caused by setVisible.
  82    *
  83    * @param title the window title, if one is displayed; null becomes ""
  84    * @param attachToInputContext true for the window to share context with
  85    *        the input method
  86    * @return the new window for use by the input method
  87    * @throws HeadlessException if GraphicsEnvironment.isHeadless is true
  88    */
  89   Window createInputMethodWindow(String title, boolean attachToInputContext);
  90
  91   /**
  92    * Creates a top-level Swing JFrame for use by the input method. This frame
  93    * should float above all document windows and dialogs, not receive focus,
  94    * and have lightweight decorations (such as no title, reduced drag
  95    * regions). But this behavior may be modified to meet the platform style.
  96    * The title may or may not be displayed, depending on the platform.
  97    *
  98    * <p>If attachToInputContext is true, the new window will share the input
  99    * context of the input method, so that events in the new window are
 100    * dispatched to the input method. Also, this supresses deactivate and
 101    * activate calls to the input method caused by setVisible.
 102    *
 103    * @param title the window title, if one is displayed; null becomes ""
 104    * @param attachToInputContext true for the window to share context with
 105    *        the input method
 106    * @return the new window for use by the input method
 107    * @throws HeadlessException if GraphicsEnvironment.isHeadless is true
 108    * @since 1.4
 109    */
 110   JFrame createInputMethodJFrame(String title, boolean attachToInputContext);
 111
 112   /**
 113    * Sets whether notification of the client window's location and state should
 114    * be enabled for the input method. When enabled, the input method's
 115    * {@link #notifyClientWindowChange(Rectangle)} method is called.
 116    * Notification is automatically disabled when the input method is disposed.
 117    *
 118    * @param inputMethod the method to change status of
 119    * @param enable true to enable notification
 120    */
 121   void enableClientWindowNotification(InputMethod inputMethod, boolean enable);
 122 } // interface InputMethodContext