jdk/src/share/classes/java/awt/event/MouseAdapter.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1996-2006 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.awt.event;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * An abstract adapter class for receiving mouse events.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * The methods in this class are empty. This class exists as
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * convenience for creating listener objects.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * Mouse events let you track when a mouse is pressed, released, clicked,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * moved, dragged, when it enters a component, when it exits and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * when a mouse wheel is moved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * Extend this class to create a {@code MouseEvent}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * (including drag and motion events) or/and {@code MouseWheelEvent}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * listener and override the methods for the events of interest. (If you implement the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * {@code MouseListener},
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * {@code MouseMotionListener}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * interface, you have to define all of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * the methods in it. This abstract class defines null methods for them
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * all, so you can only have to define methods for events you care about.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * Create a listener object using the extended class and then register it with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * a component using the component's {@code addMouseListener}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * {@code addMouseMotionListener}, {@code addMouseWheelListener}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * methods.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * The relevant method in the listener object is invoked  and the {@code MouseEvent}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * or {@code MouseWheelEvent}  is passed to it in following cases:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * <p><ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * <li>when a mouse button is pressed, released, or clicked (pressed and  released)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * <li>when the mouse cursor enters or exits the component
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * <li>when the mouse wheel rotated, or mouse moved or dragged
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * @author Carl Quinn
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 * @author Andrei Dmitriev
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 * @see MouseEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
 * @see MouseWheelEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
 * @see MouseListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
 * @see MouseMotionListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 * @see MouseWheelListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
 * @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/mouselistener.html">Tutorial: Writing a Mouse Listener</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
 * @since 1.1
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
public abstract class MouseAdapter implements MouseListener, MouseWheelListener, MouseMotionListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    public void mouseClicked(MouseEvent e) {}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    public void mousePressed(MouseEvent e) {}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    public void mouseReleased(MouseEvent e) {}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
    public void mouseEntered(MouseEvent e) {}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
    public void mouseExited(MouseEvent e) {}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
    public void mouseWheelMoved(MouseWheelEvent e){}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
    public void mouseDragged(MouseEvent e){}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     * {@inheritDoc}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
    public void mouseMoved(MouseEvent e){}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
}