View Javadoc
1   /*
2    * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package java.awt.event;
27  
28  /**
29   * An abstract adapter class for receiving mouse motion events.
30   * The methods in this class are empty. This class exists as
31   * convenience for creating listener objects.
32   * <P>
33   * Mouse motion events occur when a mouse is moved or dragged.
34   * (Many such events will be generated in a normal program.
35   * To track clicks and other mouse events, use the MouseAdapter.)
36   * <P>
37   * Extend this class to create a <code>MouseEvent</code> listener
38   * and override the methods for the events of interest. (If you implement the
39   * <code>MouseMotionListener</code> interface, you have to define all of
40   * the methods in it. This abstract class defines null methods for them
41   * all, so you can only have to define methods for events you care about.)
42   * <P>
43   * Create a listener object using the extended class and then register it with
44   * a component using the component's <code>addMouseMotionListener</code>
45   * method. When the mouse is moved or dragged, the relevant method in the
46   * listener object is invoked and the <code>MouseEvent</code> is passed to it.
47   *
48   * @author Amy Fowler
49   *
50   * @see MouseEvent
51   * @see MouseMotionListener
52   * @see <a href="http://docs.oracle.com/javase/tutorial/uiswing/events/mousemotionlistener.html">Tutorial: Writing a Mouse Motion Listener</a>
53   *
54   * @since 1.1
55   */
56  public abstract class MouseMotionAdapter implements MouseMotionListener {
57      /**
58       * Invoked when a mouse button is pressed on a component and then
59       * dragged.  Mouse drag events will continue to be delivered to
60       * the component where the first originated until the mouse button is
61       * released (regardless of whether the mouse position is within the
62       * bounds of the component).
63       */
64      public void mouseDragged(MouseEvent e) {}
65  
66      /**
67       * Invoked when the mouse button has been moved on a component
68       * (with no buttons no down).
69       */
70      public void mouseMoved(MouseEvent e) {}
71  }