| 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; |
| 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 | * @author Roman Poborchiy |
| 42 | * @since 1.5 |
| 43 | */ |
| 44 | |
| 45 | public class PointerInfo { |
| 46 | |
| 47 | private GraphicsDevice device; |
| 48 | private Point location; |
| 49 | |
| 50 | /** |
| 51 | * Package-private constructor to prevent instantiation. |
| 52 | */ |
| 53 | PointerInfo(GraphicsDevice device, Point location) { |
| 54 | this.device = device; |
| 55 | this.location = location; |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Returns the <code>GraphicsDevice</code> where the mouse pointer |
| 60 | * was at the moment this <code>PointerInfo</code> was created. |
| 61 | * |
| 62 | * @return <code>GraphicsDevice</code> corresponding to the pointer |
| 63 | * @since 1.5 |
| 64 | */ |
| 65 | public GraphicsDevice getDevice() { |
| 66 | return device; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Returns the <code>Point</code> that represents the coordinates |
| 71 | * of the pointer on the screen. See {@link MouseInfo#getPointerInfo} |
| 72 | * for more information about coordinate calculation for multiscreen |
| 73 | * systems. |
| 74 | * |
| 75 | * @see MouseInfo |
| 76 | * @see MouseInfo#getPointerInfo |
| 77 | * @return coordinates of mouse pointer |
| 78 | * @since 1.5 |
| 79 | */ |
| 80 | public Point getLocation() { |
| 81 | return location; |
| 82 | } |
| 83 | |
| 84 | } |