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
/* * @(#)InputMethodContext.java 1.17 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.awt.im.spi; import java.awt.HeadlessException; import java.awt.Window; import java.awt.font.TextHitInfo; import java.awt.im.InputMethodRequests; import java.text.AttributedCharacterIterator; import javax.swing.JFrame; /** * Provides methods that input methods * can use to communicate with their client components or to request * other services. This interface is implemented by the input method * framework, and input methods call its methods on the instance they * receive through * {@link java.awt.im.spi.InputMethod#setInputMethodContext}. * There should be no other implementors or callers. * * @since 1.3 * * @version 1.17, 11/17/05 * @author JavaSoft International */ public interface InputMethodContext extends InputMethodRequests { /** * Creates an input method event from the arguments given * and dispatches it to the client component. For arguments, * see {@link java.awt.event.InputMethodEvent#InputMethodEvent}. */ public void dispatchInputMethodEvent(int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition); /** * Creates a top-level window for use by the input method. * The intended behavior of this window is: * <ul> * <li>it floats above all document windows and dialogs * <li>it and all components that it contains do not receive the focus * <li>it has lightweight decorations, such as a reduced drag region without title * </ul> * However, the actual behavior with respect to these three items is platform dependent. * <p> * The title may or may not be displayed, depending on the actual type of window created. * <p> * If attachToInputContext is true, the new window will share the input context that * corresponds to this input method context, so that events for components in the window * are automatically dispatched to the input method. * Also, when the window is opened using setVisible(true), the input context will prevent * deactivate and activate calls to the input method that might otherwise be caused. * <p> * Input methods must call {@link java.awt.Window#dispose() Window.dispose} on the * returned input method window when it is no longer needed. * <p> * @param title the title to be displayed in the window's title bar, * if there is such a title bar. * A <code>null</code> value is treated as an empty string, "". * @param attachToInputContext whether this window should share the input context * that corresponds to this input method context * @return a window with special characteristics for use by input methods * @exception HeadlessException if <code>GraphicsEnvironment.isHeadless * </code> returns <code>true</code> */ public Window createInputMethodWindow(String title, boolean attachToInputContext); /** * Creates a top-level Swing JFrame for use by the input method. * The intended behavior of this window is: * <ul> * <li>it floats above all document windows and dialogs * <li>it and all components that it contains do not receive the focus * <li>it has lightweight decorations, such as a reduced drag region without title * </ul> * However, the actual behavior with respect to these three items is platform dependent. * <p> * The title may or may not be displayed, depending on the actual type of window created. * <p> * If attachToInputContext is true, the new window will share the input context that * corresponds to this input method context, so that events for components in the window * are automatically dispatched to the input method. * Also, when the window is opened using setVisible(true), the input context will prevent * deactivate and activate calls to the input method that might otherwise be caused. * <p> * Input methods must call {@link java.awt.Window#dispose() Window.dispose} on the * returned input method window when it is no longer needed. * <p> * @param title the title to be displayed in the window's title bar, * if there is such a title bar. * A <code>null</code> value is treated as an empty string, "". * @param attachToInputContext whether this window should share the input context * that corresponds to this input method context * @return a JFrame with special characteristics for use by input methods * @exception HeadlessException if <code>GraphicsEnvironment.isHeadless * </code> returns <code>true</code> * * @since 1.4 */ public JFrame createInputMethodJFrame(String title, boolean attachToInputContext); /** * Enables or disables notification of the current client window's * location and state for the specified input method. When * notification is enabled, the input method's {@link * java.awt.im.spi.InputMethod#notifyClientWindowChange * notifyClientWindowChange} method is called as described in that * method's specification. Notification is automatically disabled * when the input method is disposed. * * @param inputMethod the input method for which notifications are * enabled or disabled * @param enable true to enable, false to disable */ public void enableClientWindowNotification(InputMethod inputMethod, boolean enable); }