001 /* MouseInfo.java -- utility methods for mice.
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 import gnu.java.awt.ClasspathToolkit;
041 import java.awt.peer.MouseInfoPeer;
042
043 /**
044 * MouseInfo is a class containing utility functions for mouse information.
045 *
046 * @author Sven de Marothy
047 * @since 1.5
048 */
049 public class MouseInfo
050 {
051 private static MouseInfoPeer peer;
052
053 /**
054 * Private constructor to prevent instance creation.
055 */
056 private MouseInfo()
057 {
058 }
059
060 /**
061 * Returns a PointerInfo object containing information about the current
062 * location of the mouse pointer
063 *
064 * @throws HeadlessException if the current GraphicsEnvironment is headless.
065 * @return a PointerInfo object.
066 */
067 public static PointerInfo getPointerInfo() throws HeadlessException
068 {
069 SecurityManager sm = System.getSecurityManager();
070 if (sm != null)
071 sm.checkPermission( new AWTPermission("watchMousePointer") );
072
073 if( GraphicsEnvironment.isHeadless() )
074 throw new HeadlessException();
075
076 if( peer == null )
077 peer = Toolkit.getDefaultToolkit().getMouseInfoPeer();
078
079 Point p = new Point();
080 int screen = peer.fillPointWithCoords( p );
081
082 GraphicsDevice[] gds = GraphicsEnvironment.getLocalGraphicsEnvironment().
083 getScreenDevices();
084
085 return new PointerInfo( gds[ screen ], p );
086 }
087
088 /**
089 * Returns the number of mouse buttons, or -1 if no mouse is connected.
090 * (mentioned in the 1.5 release notes)
091 *
092 * @throws HeadlessException if the current GraphicsEnvironment is headless.
093 * @return an integer number of buttons.
094 */
095 public static int getNumberOfButtons() throws HeadlessException
096 {
097 if( GraphicsEnvironment.isHeadless() )
098 throw new HeadlessException();
099 return ((ClasspathToolkit)Toolkit.getDefaultToolkit()).
100 getMouseNumberOfButtons();
101 }
102 }