001/* InputMethodContext.java -- communication between an input method and client
002   Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt.im.spi;
040
041import java.awt.HeadlessException;
042import java.awt.Rectangle;
043import java.awt.Window;
044import java.awt.font.TextHitInfo;
045import java.awt.im.InputMethodRequests;
046import java.text.AttributedCharacterIterator;
047
048import javax.swing.JFrame;
049
050/**
051 * Provides methods for the communication context between an input method
052 * and the client component. This should be passed to
053 * {@link InputMethod#setInputMethodContext(InputMethodContext)}.
054 *
055 * @author Eric Blake (ebb9@email.byu.edu)
056 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
057 * @since 1.3
058 * @status updated to 1.4
059 */
060public interface InputMethodContext extends InputMethodRequests
061{
062  /**
063   * Create an input method event and dispatch it to the client.
064   *
065   * @param id the event type
066   * @param text an iterator over the text to be committed
067   * @param count the count of characters to be committed
068   * @param caret the insertion point of the commit, or null
069   * @param visiblePosition the best location to make visible, or null
070   */
071  void dispatchInputMethodEvent(int id, AttributedCharacterIterator text,
072                                int count, TextHitInfo caret,
073                                TextHitInfo visiblePosition);
074
075  /**
076   * Creates a top-level window for use by the input method. This window should
077   * float above all document windows and dialogs, not receive focus, and have
078   * lightweight decorations (such as no title, reduced drag regions). But
079   * this behavior may be modified to meet the platform style. The title may
080   * or may not be displayed, depending on the platform.
081   *
082   * <p>If attachToInputContext is true, the new window will share the input
083   * context of the input method, so that events in the new window are
084   * dispatched to the input method. Also, this supresses deactivate and
085   * activate calls to the input method caused by setVisible.
086   *
087   * @param title the window title, if one is displayed; null becomes ""
088   * @param attachToInputContext true for the window to share context with
089   *        the input method
090   * @return the new window for use by the input method
091   * @throws HeadlessException if GraphicsEnvironment.isHeadless is true
092   */
093  Window createInputMethodWindow(String title, boolean attachToInputContext);
094
095  /**
096   * Creates a top-level Swing JFrame for use by the input method. This frame
097   * should float above all document windows and dialogs, not receive focus,
098   * and have lightweight decorations (such as no title, reduced drag
099   * 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