001/* PointerInfo.java -- mouse pointer data
002   Copyright (C) 2006 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package 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 */
051public 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}