1/*
2 * Copyright (c) 2003, 2014, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package java.awt.peer;
27
28import java.awt.Window;
29import java.awt.Point;
30
31/**
32 * Peer interface for {@link java.awt.MouseInfo}. This is used to get
33 * some additional information about the mouse.
34 *
35 * The peer interfaces are intended only for use in porting
36 * the AWT. They are not intended for use by application
37 * developers, and developers should not implement peers
38 * nor invoke any of the peer methods directly on the peer
39 * instances.
40 */
41public interface MouseInfoPeer {
42
43    /**
44     * This method does two things: it fills the point fields with
45     * the current coordinates of the mouse cursor and returns the
46     * number of the screen device where the pointer is located.
47     * The number of the screen device is only returned for independent
48     * devices (which are not parts of a virtual screen device).
49     * For virtual screen devices, 0 is returned.
50     * Mouse coordinates are also calculated depending on whether
51     * or not the screen device is virtual. For virtual screen
52     * devices, pointer coordinates are calculated in the virtual
53     * coordinate system. Otherwise, coordinates are calculated in
54     * the coordinate system of the screen device where the pointer
55     * is located.
56     * See java.awt.GraphicsConfiguration documentation for more
57     * details about virtual screen devices.
58     * @param point holder for the current coordinates of the mouse
59     * cursor
60     * @return the number of the screen device where the pointer is
61     * located
62     */
63    int fillPointWithCoords(Point point);
64
65    /**
66     * Returns whether or not the window is located under the mouse
67     * pointer. The window is considered to be under the mouse pointer
68     * if it is showing on the screen, and the mouse pointer is above
69     * the part of the window that is not obscured by any other windows.
70     * @param w the window to check
71     * @return whether or not the window is located under the mouse
72     * pointer
73     */
74    boolean isWindowUnderMouse(Window w);
75
76}
77