001 /* MouseListener.java -- listen for mouse clicks and crossing component edges
002 Copyright (C) 1999, 2002, 2005 Free Software Foundation, Inc.
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
039 package java.awt.event;
040
041 import java.util.EventListener;
042
043 /**
044 * This interface is for classes that wish to receive mouse events other than
045 * simple motion events. This includes clicks (but not mouse wheel events),
046 * and crossing component boundaries without change in button status. To
047 * track moves and drags, use MouseMotionListener, and to track wheel events,
048 * use MouseWheelListener. To watch a subset of these events, use a
049 * MouseAdapter.
050 *
051 * @author Aaron M. Renn (arenn@urbanophile.com)
052 * @see MouseAdapter
053 * @see MouseEvent
054 * @since 1.1
055 * @status updated to 1.4
056 */
057 public interface MouseListener extends EventListener
058 {
059 /**
060 * This method is called when the mouse is clicked (pressed and released
061 * in short succession) on a component.
062 *
063 * @param event the <code>MouseEvent</code> indicating the click
064 */
065 void mouseClicked(MouseEvent event);
066
067 /**
068 * This method is called when the mouse is pressed over a component.
069 *
070 * @param event the <code>MouseEvent</code> for the press
071 */
072 void mousePressed(MouseEvent event);
073
074 /**
075 * This method is called when the mouse is released over a component.
076 *
077 * @param event the <code>MouseEvent</code> for the release
078 */
079 void mouseReleased(MouseEvent event);
080
081 /**
082 * This method is called when the mouse enters a component.
083 *
084 * @param event the <code>MouseEvent</code> for the entry
085 */
086 void mouseEntered(MouseEvent event);
087
088 /**
089 * This method is called when the mouse exits a component.
090 *
091 * @param event the <code>MouseEvent</code> for the exit
092 */
093 void mouseExited(MouseEvent event);
094 } // interface MouseListener