Source for java.awt.PointerInfo

   1: /* PointerInfo.java -- mouse pointer data
   2:    Copyright (C) 2006 Free Software Foundation
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.awt;
  39: 
  40: /**
  41:  * PointerInfo represents information about the mouse pointer,
  42:  * i.e. its GraphicsDevice and location.
  43:  *
  44:  * PointerInfo objects cannot be instantiated directly, but are
  45:  * retrieved from MouseInfo.getPointerInfo(). PointerInfo objects
  46:  * are immutable and will not be updated for future mouse motions.
  47:  *
  48:  * @since 1.5
  49:  * @author Sven de Marothy
  50:  */
  51: public class PointerInfo
  52: {
  53:   private GraphicsDevice gd;
  54:   private Point p;
  55: 
  56:   /**
  57:    * Package-private constructor used by MouseInfo.
  58:    */
  59:   PointerInfo( GraphicsDevice gd, Point p )
  60:   {
  61:     this.gd = gd;
  62:     this.p = p;
  63:   }
  64: 
  65:   /**
  66:    * Returns the GraphicsDevice on which the mouse pointer was located
  67:    *
  68:    * @return a GraphicsDevice object.
  69:    */
  70:   public GraphicsDevice getDevice()
  71:   {
  72:     return gd;
  73:   }
  74: 
  75:   /**
  76:    * Returns the coordinates of the mouse pointer.
  77:    *
  78:    * @return a Point object containing the pointer coordinates.
  79:    */
  80:   public Point getLocation()
  81:   {
  82:     return p;
  83:   }
  84: }