001 /*
002 * Copyright 1996-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.awt.event;
027
028 /**
029 * An abstract adapter class for receiving mouse events.
030 * The methods in this class are empty. This class exists as
031 * convenience for creating listener objects.
032 * <P>
033 * Mouse events let you track when a mouse is pressed, released, clicked,
034 * moved, dragged, when it enters a component, when it exits and
035 * when a mouse wheel is moved.
036 * <P>
037 * Extend this class to create a {@code MouseEvent}
038 * (including drag and motion events) or/and {@code MouseWheelEvent}
039 * listener and override the methods for the events of interest. (If you implement the
040 * {@code MouseListener},
041 * {@code MouseMotionListener}
042 * interface, you have to define all of
043 * the methods in it. This abstract class defines null methods for them
044 * all, so you can only have to define methods for events you care about.)
045 * <P>
046 * Create a listener object using the extended class and then register it with
047 * a component using the component's {@code addMouseListener}
048 * {@code addMouseMotionListener}, {@code addMouseWheelListener}
049 * methods.
050 * The relevant method in the listener object is invoked and the {@code MouseEvent}
051 * or {@code MouseWheelEvent} is passed to it in following cases:
052 * <p><ul>
053 * <li>when a mouse button is pressed, released, or clicked (pressed and released)
054 * <li>when the mouse cursor enters or exits the component
055 * <li>when the mouse wheel rotated, or mouse moved or dragged
056 * </ul>
057 *
058 * @author Carl Quinn
059 * @author Andrei Dmitriev
060 * @version 1.8 08/02/97
061 *
062 * @see MouseEvent
063 * @see MouseWheelEvent
064 * @see MouseListener
065 * @see MouseMotionListener
066 * @see MouseWheelListener
067 * @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/mouselistener.html">Tutorial: Writing a Mouse Listener</a>
068 *
069 * @since 1.1
070 */
071 public abstract class MouseAdapter implements MouseListener,
072 MouseWheelListener, MouseMotionListener {
073 /**
074 * {@inheritDoc}
075 */
076 public void mouseClicked(MouseEvent e) {
077 }
078
079 /**
080 * {@inheritDoc}
081 */
082 public void mousePressed(MouseEvent e) {
083 }
084
085 /**
086 * {@inheritDoc}
087 */
088 public void mouseReleased(MouseEvent e) {
089 }
090
091 /**
092 * {@inheritDoc}
093 */
094 public void mouseEntered(MouseEvent e) {
095 }
096
097 /**
098 * {@inheritDoc}
099 */
100 public void mouseExited(MouseEvent e) {
101 }
102
103 /**
104 * {@inheritDoc}
105 * @since 1.6
106 */
107 public void mouseWheelMoved(MouseWheelEvent e) {
108 }
109
110 /**
111 * {@inheritDoc}
112 * @since 1.6
113 */
114 public void mouseDragged(MouseEvent e) {
115 }
116
117 /**
118 * {@inheritDoc}
119 * @since 1.6
120 */
121 public void mouseMoved(MouseEvent e) {
122 }
123 }
|