J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2000-2003 Sun Microsystems, Inc. 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. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package java.awt.event; |
| 27 | |
| 28 | import java.util.EventListener; |
| 29 | |
| 30 | /** |
| 31 | * The listener interface for receiving mouse wheel events on a component. |
| 32 | * (For clicks and other mouse events, use the <code>MouseListener</code>. |
| 33 | * For mouse movement and drags, use the <code>MouseMotionListener</code>.) |
| 34 | * <P> |
| 35 | * The class that is interested in processing a mouse wheel event |
| 36 | * implements this interface (and all the methods it contains). |
| 37 | * <P> |
| 38 | * The listener object created from that class is then registered with a |
| 39 | * component using the component's <code>addMouseWheelListener</code> |
| 40 | * method. A mouse wheel event is generated when the mouse wheel is rotated. |
| 41 | * When a mouse wheel event occurs, that object's <code>mouseWheelMoved</code> |
| 42 | * method is invoked. |
| 43 | * <p> |
| 44 | * For information on how mouse wheel events are dispatched, see |
| 45 | * the class description for {@link MouseWheelEvent}. |
| 46 | * |
| 47 | * @author Brent Christian |
| 48 | * @see MouseWheelEvent |
| 49 | * @since 1.4 |
| 50 | */ |
| 51 | public interface MouseWheelListener extends EventListener { |
| 52 | |
| 53 | /** |
| 54 | * Invoked when the mouse wheel is rotated. |
| 55 | * @see MouseWheelEvent |
| 56 | */ |
| 57 | public void mouseWheelMoved(MouseWheelEvent e); |
| 58 | } |