blob: 3cc77c778942188a7caea31d42cb351b536a801a [file] [log] [blame]
/*
* Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.awt.event;
import java.util.EventListener;
/**
* The listener interface for receiving mouse wheel events on a component.
* (For clicks and other mouse events, use the <code>MouseListener</code>.
* For mouse movement and drags, use the <code>MouseMotionListener</code>.)
* <P>
* The class that is interested in processing a mouse wheel event
* implements this interface (and all the methods it contains).
* <P>
* The listener object created from that class is then registered with a
* component using the component's <code>addMouseWheelListener</code>
* method. A mouse wheel event is generated when the mouse wheel is rotated.
* When a mouse wheel event occurs, that object's <code>mouseWheelMoved</code>
* method is invoked.
* <p>
* For information on how mouse wheel events are dispatched, see
* the class description for {@link MouseWheelEvent}.
*
* @author Brent Christian
* @see MouseWheelEvent
* @since 1.4
*/
public interface MouseWheelListener extends EventListener {
/**
* Invoked when the mouse wheel is rotated.
* @see MouseWheelEvent
*/
public void mouseWheelMoved(MouseWheelEvent e);
}