java.awt.event.MouseMotionListener Maven / Gradle / Ivy

/*


NOTICE





(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.

Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 217: Personal Basis
Profile 1.1. In the event of a discrepency between this work and the
JSR 217 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence.
*/


  


package java.awt.event;

import java.util.EventListener;

/** 
 * The listener interface for receiving mouse motion events on a component.
 * (For clicks and other mouse events, use the MouseListener.)
 * 

 * The class that is interested in processing a mouse motion event
 * either implements this interface (and all the methods it
 * contains) or extends the abstract MouseMotionAdapter class
 * (overriding only the methods of interest).
 * 
 * The listener object created from that class is then registered with a
 * component using the component's addMouseMotionListener 
 * method. A mouse motion event is generated when the mouse is moved
 * or dragged. (Many such events will be generated). When a mouse motion event
 * occurs, the relevant method in the listener object is invoked, and 
 * the MouseEvent is passed to it.
 *
 * @author Amy Fowler
 * @version 1.14, 01/23/03
 *
 * @see MouseMotionAdapter
 * @see MouseEvent
 * @see Tutorial: Writing a Mouse Motion Listener
 * @see Reference: The Java Class Libraries (update file)
 *
 * @since 1.1
 */
public interface MouseMotionListener extends EventListener
{

    /** 
     * Invoked when a mouse button is pressed on a component and then 
     * dragged.  MOUSE_DRAGGED events will continue to be 
     * delivered to the component where the drag originated until the 
     * mouse button is released (regardless of whether the mouse position 
     * is within the bounds of the component).
     *  
     * Due to platform-dependent Drag&Drop implementations, 
     * MOUSE_DRAGGED events may not be delivered during a native 
     * Drag&Drop operation.  
     */
    public void mouseDragged(MouseEvent e);

    /** 
     * Invoked when the mouse cursor has been moved onto a component
     * but no buttons have been pushed.
     */
    public void mouseMoved(MouseEvent e);
}