libjava/java/awt/event/MouseListener.java

   1 /* MouseListener.java -- listen for mouse clicks and crossing component edges
   2    Copyright (C) 1999, 2002, 2005  Free Software Foundation, Inc.
   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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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
  39 package java.awt.event;
  40
  41 import java.util.EventListener;
  42
  43 /**
  44  * This interface is for classes that wish to receive mouse events other than
  45  * simple motion events. This includes clicks (but not mouse wheel events),
  46  * and crossing component boundaries without change in button status. To
  47  * track moves and drags, use MouseMotionListener, and to track wheel events,
  48  * use MouseWheelListener. To watch a subset of these events, use a
  49  * MouseAdapter.
  50  *
  51  * @author Aaron M. Renn (arenn@urbanophile.com)
  52  * @see MouseAdapter
  53  * @see MouseEvent
  54  * @since 1.1
  55  * @status updated to 1.4
  56  */
  57 public interface MouseListener extends EventListener
  58 {
  59   /**
  60    * This method is called when the mouse is clicked (pressed and released
  61    * in short succession) on a component.
  62    *
  63    * @param event the <code>MouseEvent</code> indicating the click
  64    */
  65   void mouseClicked(MouseEvent event);
  66
  67   /**
  68    * This method is called when the mouse is pressed over a component.
  69    *
  70    * @param event the <code>MouseEvent</code> for the press
  71    */
  72   void mousePressed(MouseEvent event);
  73
  74   /**
  75    * This method is called when the mouse is released over a component.
  76    *
  77    * @param event the <code>MouseEvent</code> for the release
  78    */
  79   void mouseReleased(MouseEvent event);
  80
  81   /**
  82    * This method is called when the mouse enters a component.
  83    *
  84    * @param event the <code>MouseEvent</code> for the entry
  85    */
  86   void mouseEntered(MouseEvent event);
  87
  88   /**
  89    * This method is called when the mouse exits a component.
  90    *
  91    * @param event the <code>MouseEvent</code> for the exit
  92    */
  93   void mouseExited(MouseEvent event);
  94 } // interface MouseListener