Source for java.awt.im.spi.InputMethodContext

   1: /* InputMethodContext.java -- communication between an input method and client
   2:    Copyright (C) 2002, 2004, 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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: 
  39: package java.awt.im.spi;
  40: 
  41: import java.awt.HeadlessException;
  42: import java.awt.Rectangle;
  43: import java.awt.Window;
  44: import java.awt.font.TextHitInfo;
  45: import java.awt.im.InputMethodRequests;
  46: import java.text.AttributedCharacterIterator;
  47: 
  48: import javax.swing.JFrame;
  49: 
  50: /**
  51:  * Provides methods for the communication context between an input method
  52:  * and the client component. This should be passed to
  53:  * {@link InputMethod#setInputMethodContext(InputMethodContext)}.
  54:  *
  55:  * @author Eric Blake (ebb9@email.byu.edu)
  56:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  57:  * @since 1.3
  58:  * @status updated to 1.4
  59:  */
  60: public interface InputMethodContext extends InputMethodRequests
  61: {
  62:   /**
  63:    * Create an input method event and dispatch it to the client.
  64:    *
  65:    * @param id the event type
  66:    * @param text an iterator over the text to be committed
  67:    * @param count the count of characters to be committed
  68:    * @param caret the insertion point of the commit, or null
  69:    * @param visiblePosition the best location to make visible, or null
  70:    */
  71:   void dispatchInputMethodEvent(int id, AttributedCharacterIterator text,
  72:                                 int count, TextHitInfo caret,
  73:                                 TextHitInfo visiblePosition);
  74: 
  75:   /**
  76:    * Creates a top-level window for use by the input method. This window should
  77:    * float above all document windows and dialogs, not receive focus, and have
  78:    * lightweight decorations (such as no title, reduced drag regions). But
  79:    * this behavior may be modified to meet the platform style. The title may
  80:    * or may not be displayed, depending on the platform.
  81:    *
  82:    * <p>If attachToInputContext is true, the new window will share the input
  83:    * context of the input method, so that events in the new window are
  84:    * dispatched to the input method. Also, this supresses deactivate and
  85:    * activate calls to the input method caused by setVisible.
  86:    *
  87:    * @param title the window title, if one is displayed; null becomes ""
  88:    * @param attachToInputContext true for the window to share context with
  89:    *        the input method
  90:    * @return the new window for use by the input method
  91:    * @throws HeadlessException if GraphicsEnvironment.isHeadless is true
  92:    */
  93:   Window createInputMethodWindow(String title, boolean attachToInputContext);
  94: 
  95:   /**
  96:    * Creates a top-level Swing JFrame for use by the input method. This frame
  97:    * should float above all document windows and dialogs, not receive focus,
  98:    * and have lightweight decorations (such as no title, reduced drag
  99:    * regions). But this behavior may be modified to meet the platform style.
 100:    * The title may or may not be displayed, depending on the platform.
 101:    *
 102:    * <p>If attachToInputContext is true, the new window will share the input
 103:    * context of the input method, so that events in the new window are
 104:    * dispatched to the input method. Also, this supresses deactivate and
 105:    * activate calls to the input method caused by setVisible.
 106:    *
 107:    * @param title the window title, if one is displayed; null becomes ""
 108:    * @param attachToInputContext true for the window to share context with
 109:    *        the input method
 110:    * @return the new window for use by the input method
 111:    * @throws HeadlessException if GraphicsEnvironment.isHeadless is true
 112:    * @since 1.4
 113:    */
 114:   JFrame createInputMethodJFrame(String title, boolean attachToInputContext);
 115: 
 116:   /**
 117:    * Sets whether notification of the client window's location and state should
 118:    * be enabled for the input method. When enabled, the input method's
 119:    * {@link InputMethod#notifyClientWindowChange(Rectangle)} method is called.
 120:    * Notification is automatically disabled when the input method is disposed.
 121:    *
 122:    * @param inputMethod the method to change status of
 123:    * @param enable true to enable notification
 124:    */
 125:   void enableClientWindowNotification(InputMethod inputMethod, boolean enable);
 126: } // interface InputMethodContext