001 /* PointerInfo.java -- mouse pointer data
002 Copyright (C) 2006 Free Software Foundation
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package java.awt;
039
040 /**
041 * PointerInfo represents information about the mouse pointer,
042 * i.e. its GraphicsDevice and location.
043 *
044 * PointerInfo objects cannot be instantiated directly, but are
045 * retrieved from MouseInfo.getPointerInfo(). PointerInfo objects
046 * are immutable and will not be updated for future mouse motions.
047 *
048 * @since 1.5
049 * @author Sven de Marothy
050 */
051 public class PointerInfo
052 {
053 private GraphicsDevice gd;
054 private Point p;
055
056 /**
057 * Package-private constructor used by MouseInfo.
058 */
059 PointerInfo( GraphicsDevice gd, Point p )
060 {
061 this.gd = gd;
062 this.p = p;
063 }
064
065 /**
066 * Returns the GraphicsDevice on which the mouse pointer was located
067 *
068 * @return a GraphicsDevice object.
069 */
070 public GraphicsDevice getDevice()
071 {
072 return gd;
073 }
074
075 /**
076 * Returns the coordinates of the mouse pointer.
077 *
078 * @return a Point object containing the pointer coordinates.
079 */
080 public Point getLocation()
081 {
082 return p;
083 }
084 }