| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package java.awt.peer; |
| 27 | |
| 28 | import java.awt.Window; |
| 29 | import java.awt.Point; |
| 30 | |
| 31 | /** |
| 32 | * The peer interfaces are intended only for use in porting |
| 33 | * the AWT. They are not intended for use by application |
| 34 | * developers, and developers should not implement peers |
| 35 | * nor invoke any of the peer methods directly on the peer |
| 36 | * instances. |
| 37 | */ |
| 38 | public interface MouseInfoPeer { |
| 39 | |
| 40 | /** |
| 41 | * This method does two things: it fills the point fields with |
| 42 | * the current coordinates of the mouse cursor and returns the |
| 43 | * number of the screen device where the pointer is located. |
| 44 | * The number of the screen device is only returned for independent |
| 45 | * devices (which are not parts of a virtual screen device). |
| 46 | * For virtual screen devices, 0 is returned. |
| 47 | * Mouse coordinates are also calculated depending on whether |
| 48 | * or not the screen device is virtual. For virtual screen |
| 49 | * devices, pointer coordinates are calculated in the virtual |
| 50 | * coordinate system. Otherwise, coordinates are calculated in |
| 51 | * the coordinate system of the screen device where the pointer |
| 52 | * is located. |
| 53 | * See java.awt.GraphicsConfiguration documentation for more |
| 54 | * details about virtual screen devices. |
| 55 | */ |
| 56 | int fillPointWithCoords(Point point); |
| 57 | |
| 58 | /** |
| 59 | * Returns whether or not the window is located under the mouse |
| 60 | * pointer. The window is considered to be under the mouse pointer |
| 61 | * if it is showing on the screen, and the mouse pointer is above |
| 62 | * the part of the window that is not obscured by any other windows. |
| 63 | */ |
| 64 | boolean isWindowUnderMouse(Window w); |
| 65 | |
| 66 | } |