blob: 4508019e10898644575368df8ed345566fb8081c [file] [log] [blame]
/* MouseListener.java -- listen for mouse clicks and crossing component edges
Copyright (C) 1999, 2002, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version. */
package java.awt.event;
import java.util.EventListener;
/**
* This interface is for classes that wish to receive mouse events other than
* simple motion events. This includes clicks (but not mouse wheel events),
* and crossing component boundaries without change in button status. To
* track moves and drags, use MouseMotionListener, and to track wheel events,
* use MouseWheelListener. To watch a subset of these events, use a
* MouseAdapter.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
* @see MouseAdapter
* @see MouseEvent
* @since 1.1
* @status updated to 1.4
*/
public interface MouseListener extends EventListener
{
/**
* This method is called when the mouse is clicked (pressed and released
* in short succession) on a component.
*
* @param event the <code>MouseEvent</code> indicating the click
*/
void mouseClicked(MouseEvent event);
/**
* This method is called when the mouse is pressed over a component.
*
* @param event the <code>MouseEvent</code> for the press
*/
void mousePressed(MouseEvent event);
/**
* This method is called when the mouse is released over a component.
*
* @param event the <code>MouseEvent</code> for the release
*/
void mouseReleased(MouseEvent event);
/**
* This method is called when the mouse enters a component.
*
* @param event the <code>MouseEvent</code> for the entry
*/
void mouseEntered(MouseEvent event);
/**
* This method is called when the mouse exits a component.
*
* @param event the <code>MouseEvent</code> for the exit
*/
void mouseExited(MouseEvent event);
} // interface MouseListener