01 /*
02 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * 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;
27
28 /**
29 * A class that describes the pointer position.
30 * It provides the <code>GraphicsDevice</code> where the
31 * pointer is and the <code>Point</code> that represents
32 * the coordinates of the pointer.
33 * <p>
34 * Instances of this class should be obtained via
35 * {@link MouseInfo#getPointerInfo}.
36 * The <code>PointerInfo</code> instance is not updated dynamically
37 * as the mouse moves. To get the updated location, you must call
38 * {@link MouseInfo#getPointerInfo} again.
39 *
40 * @see MouseInfo#getPointerInfo
41 * @version 1.9, 05/05/07
42 * @author Roman Poborchiy
43 * @since 1.5
44 */
45
46 public class PointerInfo {
47
48 private GraphicsDevice device;
49 private Point location;
50
51 /**
52 * Package-private constructor to prevent instantiation.
53 */
54 PointerInfo(GraphicsDevice device, Point location) {
55 this .device = device;
56 this .location = location;
57 }
58
59 /**
60 * Returns the <code>GraphicsDevice</code> where the mouse pointer
61 * was at the moment this <code>PointerInfo</code> was created.
62 *
63 * @return <code>GraphicsDevice</code> corresponding to the pointer
64 * @since 1.5
65 */
66 public GraphicsDevice getDevice() {
67 return device;
68 }
69
70 /**
71 * Returns the <code>Point</code> that represents the coordinates
72 * of the pointer on the screen. See {@link MouseInfo#getPointerInfo}
73 * for more information about coordinate calculation for multiscreen
74 * systems.
75 *
76 * @see MouseInfo
77 * @see MouseInfo#getPointerInfo
78 * @return coordinates of mouse pointer
79 * @since 1.5
80 */
81 public Point getLocation() {
82 return location;
83 }
84
85 }
|