Changeset 1386

Timestamp:

06/12/08 06:16:51 (4 months ago)

Author:

cederberg@gmail.com

Message:

Added initial support for 'onmousewheel' event in MochiKit.Signal. Based on patch submitted by Simon Cusack. Fixes trac ticket #156.

Files:

• mochikit/trunk/MochiKit/Signal.js (modified) (6 diffs)
• mochikit/trunk/doc/html/MochiKit/Signal.html (modified) (2 diffs)
• mochikit/trunk/doc/rst/MochiKit/Signal.rst (modified) (2 diffs)
• mochikit/trunk/examples/mouse_events (added)
• mochikit/trunk/examples/mouse_events/index.html (added)
• mochikit/trunk/examples/mouse_events/mouse_events.css (added)
• mochikit/trunk/examples/mouse_events/mouse_events.js (added)
• mochikit/trunk/packed/MochiKit/MochiKit.js (modified) (6 diffs)
• mochikit/trunk/tests/test_Signal.js (modified) (3 diffs)

mochikit/trunk/MochiKit/Signal.js

@@ -56 +56 @@
-                ', client: ' + repr(this.mouse().client);
-
-
+ && this.type() != 'mousewheel'
-                str += ', button: {left: ' + repr(this.mouse().button.left) +
-                    ', middle: ' + repr(this.mouse().button.middle) +
-
-
-
-
+
+
+
+
+
+
-        }
-        if (this.type() == 'mouseover' || this.type() == 'mouseout' || 
@@ -89 +91 @@
-    /** @id MochiKit.Signal.Event.prototype.type */
-    type: function () {
-
+
+
+
+
+
-    },
-
@@ -293 +299 @@
-
-            }
-
+ && this.type() != 'mousewheel'
-                m.button = {};
-                m.button.left = false;
@@ -327 +333 @@
-                    m.button.middle = !!(e.button & 4);
-                }
+            }
+            if (this.type() == 'mousewheel') {
+                m.wheel = e.detail ? e.detail : -e.wheelDelta / 40;
-            }
-            this._mouse = m;
@@ -550 +559 @@
-    },
-
+    _browserHasMouseWheelEvent: function () {
+        return /MSIE/.test(navigator.userAgent) || /Opera/.test(navigator.userAgent);
+    },
+
-    _mouseEnterListener: function (src, sig, func, obj) {
-        var E = MochiKit.Signal.Event;
@@ -623 +636 @@
-                sig = "onmouseout";
-            }
+        } else if (isDOM && sig == "onmousewheel" && !self._browserHasMouseWheelEvent()) {
+            var listener = self._listener(src, sig, func, obj, isDOM);
+            sig = "onDOMMouseScroll";
-        } else {
-            var listener = self._listener(src, sig, func, obj, isDOM);

mochikit/trunk/doc/html/MochiKit/Signal.html

@@ -152 +152 @@
-</dl>
-</blockquote>
+<p><tt class="docutils literal"><span class="pre">onmousewheel</span></tt></p>
+<blockquote>
+<p>Not strictly synthesized, but named <tt class="docutils literal"><span class="pre">'DOMMouseScroll'</span></tt> in Firefox
+and Safari browsers. MochiKit translates <tt class="docutils literal"><span class="pre">'onmousewheel'</span></tt> to the
+correct event in these browsers.</p>
+<dl class="docutils">
+<dt><em>Availability:</em></dt>
+<dd>Available in MochiKit 1.4+</dd>
+</dl>
+</blockquote>
-</div>
-<div class="section">
@@ -411 +421 @@
-each property is <tt class="docutils literal"><span class="pre">true</span></tt> if the mouse button was pressed,
-<tt class="docutils literal"><span class="pre">false</span></tt> otherwise.</li>
+</ul>
+</blockquote>
+<p>Properties for <tt class="docutils literal"><span class="pre">'onmousewheel'</span></tt>:</p>
+<blockquote>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">mouse().wheel</span></tt> returns a number for the scroll wheel
+offset. The number will normally be +3 when scrolling down,
+and -3 when scrolling up.</li>
-</ul>
-</blockquote>

mochikit/trunk/doc/rst/MochiKit/Signal.rst

@@ -168 +168 @@
-        Available in MochiKit 1.4+
-
+``onmousewheel``
+
+    Not strictly synthesized, but named ``'DOMMouseScroll'`` in Firefox
+    and Safari browsers. MochiKit translates ``'onmousewheel'`` to the
+    correct event in these browsers.
+
+    *Availability:*
+        Available in MochiKit 1.4+
+
-
-Using Signal for non-DOM objects
@@ -416 +425 @@
-            ``false`` otherwise.
-
+    Properties for ``'onmousewheel'``:
+
+        -   ``mouse().wheel`` returns a number for the scroll wheel
+            offset. The number will normally be +3 when scrolling down,
+            and -3 when scrolling up.
+
-    Known browser bugs:
-

mochikit/trunk/packed/MochiKit/MochiKit.js

@@ -4912 +4912 @@
-if(this.type()&&(this.type().indexOf("mouse")===0||this.type().indexOf("click")!=-1||this.type()=="contextmenu")){
-str+=", mouse(): {page: "+repr(this.mouse().page)+", client: "+repr(this.mouse().client);
-
-
-
+
+
+
+
+
+
-str+="}";
-}
-}
-if(this.type()=="mouseover"||this.type()=="mouseout"||this.type()=="mouseenter"||this.type()=="mouseleave"){
@@ -4930 +4932 @@
-return this._event;
-},type:function(){
+if(this._event.type==="DOMMouseScroll"){
+return "mousewheel";
+}else{
-return this._event.type||undefined;
+}
-},target:function(){
-return this._event.target||this._event.srcElement;
@@ -5014 +5020 @@
-m.page.y=e.clientY+(de.scrollTop||b.scrollTop)-(de.clientTop||0);
-}
-
+&&this.type()!="mousewheel"
-m.button={};
-m.button.left=false;
@@ -5028 +5034 @@
-m.button.middle=!!(e.button&4);
-}
+}
+if(this.type()=="mousewheel"){
+m.wheel=e.detail?e.detail:-e.wheelDelta/40;
-}
-this._mouse=m;
@@ -5139 +5148 @@
-},_browserAlreadyHasMouseEnterAndLeave:function(){
-return /MSIE/.test(navigator.userAgent);
+},_browserHasMouseWheelEvent:function(){
+return /MSIE/.test(navigator.userAgent)||/Opera/.test(navigator.userAgent);
-},_mouseEnterListener:function(src,sig,func,obj){
-var E=MochiKit.Signal.Event;
@@ -5206 +5217 @@
-}
-}else{
+if(_565&&sig=="onmousewheel"&&!self._browserHasMouseWheelEvent()){
-var _566=self._listener(src,sig,func,obj,_565);
+sig="onDOMMouseScroll";
+}else{
+var _566=self._listener(src,sig,func,obj,_565);
+}
-}
-if(src.addEventListener){

mochikit/trunk/tests/test_Signal.js

@@ -60 +60 @@
-                newEvt.clientY = 1;
-                newEvt.button = 1;
+                newEvt.detail = 3;
-                element.fireEvent('on' + eventType, newEvt);
-            } else if (document.createEvent && (typeof(document.createEvent('MouseEvents').initMouseEvent) == 'function')) {
-                var evt = document.createEvent('MouseEvents');
-                evt.initMouseEvent(eventType, canBubble, true, // event, bubbles, cancelable
-1, // view, # of clicks
+3, // view, detail (either scroll or # of clicks)
-                    1, 0, 0, 0, // screenX, screenY, clientX, clientY
-                    false, false, false, false, // ctrlKey, altKey, shiftKey, metaKey
@@ -97 +98 @@
-            t.ok((typeof(e.relatedTarget()) === 'undefined'), 'checking that relatedTarget() is undefined');
-            t.ok((typeof(e.key()) === 'undefined'), 'checking that key() is undefined');
+            t.ok((typeof(e.mouse().wheel) === 'undefined'), 'checking that mouse().wheel is undefined');
-        };
-
@@ -108 +110 @@
-        t.is(i, 3, 'Disconnecting an event to an HTML object and firing a synthetic event');
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    // non-DOM tests