jdk-sandbox: comparison jdk/src/share/classes/java/awt/event/MouseWheelEvent.java

equal deleted inserted replaced

-:98296a9fc072
+:c43b2dfab9ac
 /*
-* Copyright 2000-2006 Sun Microsystems, Inc.  All Rights Reserved.
+* Copyright 2000-2007 Sun Microsystems, Inc.  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.  Sun designates this
 * (commonly lines of text in a text-based component) or an entire "block"
 * (similar to page-up/page-down).  The MouseWheelEvent offers
 * methods for conforming to the underlying platform settings.  These
 * platform settings can be changed at any time by the user.  MouseWheelEvents
 * reflect the most recent settings.
+* <P>
+* The <code>MouseWheelEvent</code> class includes methods for
+* getting the number of "clicks" by which the mouse wheel is rotated.
+* The {@link #getWheelRotation} method returns the integer number
+* of "clicks" corresponding to the number of notches by which the wheel was
+* rotated. In addition to this method, the <code>MouseWheelEvent</code>
+* class provides the {@link #getPreciseWheelRotation} method which returns
+* a double number of "clicks" in case a partial rotation occurred.
+* The {@link #getPreciseWheelRotation} method is useful if a mouse supports
+* a high-resolution wheel, such as a freely rotating wheel with no
+* notches. Applications can benefit by using this method to process
+* mouse wheel events more precisely, and thus, making visual perception
+* smoother.
 *
 * @author Brent Christian
 * @see MouseWheelListener
 * @see java.awt.ScrollPane
 * @see java.awt.ScrollPane#setWheelScrollingEnabled(boolean)
 * Indicates how far the mouse wheel was rotated.
 *
 * @see #getWheelRotation
 */
 int wheelRotation;
+/**
+* Indicates how far the mouse wheel was rotated.
+*
+* @see #getPreciseWheelRotation
+*/
+double preciseWheelRotation;
 /*
 * serialVersionUID
 */
 *                       response to this event;  valid values are
 *                       <code>WHEEL_UNIT_SCROLL</code> and
 *                       <code>WHEEL_BLOCK_SCROLL</code>
 * @param  scrollAmount  for scrollType <code>WHEEL_UNIT_SCROLL</code>,
 *                       the number of units to be scrolled
-* @param wheelRotation  the amount that the mouse wheel was rotated (the
+* @param wheelRotation  the integer number of "clicks" by which the mouse
-*                       number of "clicks")
+*                       wheel was rotated
 *
 * @throws IllegalArgumentException if <code>source</code> is null
 * @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean)
 * @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)
 */
 *                       response to this event;  valid values are
 *                       <code>WHEEL_UNIT_SCROLL</code> and
 *                       <code>WHEEL_BLOCK_SCROLL</code>
 * @param  scrollAmount  for scrollType <code>WHEEL_UNIT_SCROLL</code>,
 *                       the number of units to be scrolled
-* @param wheelRotation  the amount that the mouse wheel was rotated (the
+* @param wheelRotation  the integer number of "clicks" by which the mouse
-*                       number of "clicks")
+*                       wheel was rotated
 *
 * @throws IllegalArgumentException if <code>source</code> is null
 * @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean)
 * @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)
 * @since 1.6
 */
 public MouseWheelEvent (Component source, int id, long when, int modifiers,
 int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger,
 int scrollType, int scrollAmount, int wheelRotation) {
+this(source, id, when, modifiers, x, y, xAbs, yAbs, clickCount, popupTrigger,
+scrollType, scrollAmount, wheelRotation, wheelRotation);
+}
+/**
+* Constructs a <code>MouseWheelEvent</code> object with the specified
+* source component, type, modifiers, coordinates, absolute coordinates,
+* scroll type, scroll amount, and wheel rotation.
+* <p>Note that passing in an invalid <code>id</code> parameter results
+* in unspecified behavior. This method throws an
+* <code>IllegalArgumentException</code> if <code>source</code> equals
+* <code>null</code>.
+* <p>Even if inconsistent values for relative and absolute coordinates
+* are passed to the constructor, a <code>MouseWheelEvent</code> instance
+* is still created and no exception is thrown.
+*
+* @param source         the <code>Component</code> that originated the event
+* @param id             the integer value that identifies the event
+* @param when           a long value that gives the time when the event occurred
+* @param modifiers      the modifier keys down during event
+*                       (shift, ctrl, alt, meta)
+* @param x              the horizontal <code>x</code> coordinate for the
+*                       mouse location
+* @param y              the vertical <code>y</code> coordinate for the
+*                       mouse location
+* @param xAbs           the absolute horizontal <code>x</code> coordinate for
+*                       the mouse location
+* @param yAbs           the absolute vertical <code>y</code> coordinate for
+*                       the mouse location
+* @param clickCount     the number of mouse clicks associated with the event
+* @param popupTrigger   a boolean value, <code>true</code> if this event is a trigger
+*                       for a popup-menu
+* @param scrollType     the type of scrolling which should take place in
+*                       response to this event;  valid values are
+*                       <code>WHEEL_UNIT_SCROLL</code> and
+*                       <code>WHEEL_BLOCK_SCROLL</code>
+* @param  scrollAmount  for scrollType <code>WHEEL_UNIT_SCROLL</code>,
+*                       the number of units to be scrolled
+* @param wheelRotation  the integer number of "clicks" by which the mouse wheel
+*                       was rotated
+* @param preciseWheelRotation the double number of "clicks" by which the mouse wheel
+*                       was rotated
+*
+* @throws IllegalArgumentException if <code>source</code> is null
+* @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean)
+* @see MouseEvent#MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)
+* @since 1.7
+*/
+public MouseWheelEvent (Component source, int id, long when, int modifiers,
+int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger,
+int scrollType, int scrollAmount, int wheelRotation, double preciseWheelRotation) {
 super(source, id, when, modifiers, x, y, xAbs, yAbs, clickCount,
 popupTrigger, MouseEvent.NOBUTTON);
 this.scrollType = scrollType;
 this.scrollAmount = scrollAmount;
 this.wheelRotation = wheelRotation;
+this.preciseWheelRotation = preciseWheelRotation;
 }
 /**
 * Returns the type of scrolling that should take place in response to this
 * event.  This is determined by the native platform.  Legal values are:
 public int getScrollAmount() {
 return scrollAmount;
 }
 /**
-* Returns the number of "clicks" the mouse wheel was rotated.
+* Returns the number of "clicks" the mouse wheel was rotated, as an integer.
+* A partial rotation may occur if the mouse supports a high-resolution wheel.
+* In this case, the method returns zero until a full "click" has been accumulated.
 *
 * @return negative values if the mouse wheel was rotated up/away from
 * the user, and positive values if the mouse wheel was rotated down/
 * towards the user
+* @see #getPreciseWheelRotation
 */
 public int getWheelRotation() {
 return wheelRotation;
+}
+/**
+* Returns the number of "clicks" the mouse wheel was rotated, as a double.
+* A partial rotation may occur if the mouse supports a high-resolution wheel.
+* In this case, the return value will include a fractional "click".
+*
+* @return negative values if the mouse wheel was rotated up or away from
+* the user, and positive values if the mouse wheel was rotated down or
+* towards the user
+* @see #getWheelRotation
+* @since 1.7
+*/
+public double getPreciseWheelRotation() {
+return preciseWheelRotation;
 }
 /**
 * This is a convenience method to aid in the implementation of
 * the common-case MouseWheelListener - to scroll a ScrollPane or
 else {
 scrollTypeStr = "unknown scroll type";
 }
 return super.paramString()+",scrollType="+scrollTypeStr+
 ",scrollAmount="+getScrollAmount()+",wheelRotation="+
-getWheelRotation();
+getWheelRotation()+",preciseWheelRotation="+getPreciseWheelRotation();
 }
 }

changeset 121	c43b2dfab9ac
parent 2	90ce3da70b43
child 440	a3dac373f62d