From 755854d3f7c7f35c0fabd0bcb9398adaaaacbcb8 Mon Sep 17 00:00:00 2001 From: Mark Salsbery Date: Mon, 12 Jan 2015 11:02:54 -0800 Subject: [PATCH] Renamed non-primary button events/handlers --- src/mousetracker.js | 54 ++++++++++----------- src/viewer.js | 40 +++++++-------- test/events.js | 116 ++++++++++++++++++++++---------------------- 3 files changed, 105 insertions(+), 105 deletions(-) diff --git a/src/mousetracker.js b/src/mousetracker.js index ff4f15fa..86e23f70 100644 --- a/src/mousetracker.js +++ b/src/mousetracker.js @@ -72,11 +72,11 @@ * An optional handler for pointer exit. * @param {OpenSeadragon.EventHandler} [options.pressHandler=null] * An optional handler for pointer press. - * @param {OpenSeadragon.EventHandler} [options.auxPressHandler=null] + * @param {OpenSeadragon.EventHandler} [options.nonPrimaryPressHandler=null] * An optional handler for pointer non-primary button press. * @param {OpenSeadragon.EventHandler} [options.releaseHandler=null] * An optional handler for pointer release. - * @param {OpenSeadragon.EventHandler} [options.auxReleaseHandler=null] + * @param {OpenSeadragon.EventHandler} [options.nonPrimaryReleaseHandler=null] * An optional handler for pointer non-primary button release. * @param {OpenSeadragon.EventHandler} [options.moveHandler=null] * An optional handler for pointer move. @@ -148,26 +148,26 @@ * @memberof OpenSeadragon.MouseTracker# */ this.dblClickDistThreshold = options.dblClickDistThreshold || $.DEFAULT_SETTINGS.dblClickDistThreshold; - this.userData = options.userData || null; - this.stopDelay = options.stopDelay || 50; + this.userData = options.userData || null; + this.stopDelay = options.stopDelay || 50; - this.enterHandler = options.enterHandler || null; - this.exitHandler = options.exitHandler || null; - this.pressHandler = options.pressHandler || null; - this.auxPressHandler = options.auxPressHandler || null; - this.releaseHandler = options.releaseHandler || null; - this.auxReleaseHandler = options.auxReleaseHandler || null; - this.moveHandler = options.moveHandler || null; - this.scrollHandler = options.scrollHandler || null; - this.clickHandler = options.clickHandler || null; - this.dblClickHandler = options.dblClickHandler || null; - this.dragHandler = options.dragHandler || null; - this.dragEndHandler = options.dragEndHandler || null; - this.pinchHandler = options.pinchHandler || null; - this.stopHandler = options.stopHandler || null; - this.keyHandler = options.keyHandler || null; - this.focusHandler = options.focusHandler || null; - this.blurHandler = options.blurHandler || null; + this.enterHandler = options.enterHandler || null; + this.exitHandler = options.exitHandler || null; + this.pressHandler = options.pressHandler || null; + this.nonPrimaryPressHandler = options.nonPrimaryPressHandler || null; + this.releaseHandler = options.releaseHandler || null; + this.nonPrimaryReleaseHandler = options.nonPrimaryReleaseHandler || null; + this.moveHandler = options.moveHandler || null; + this.scrollHandler = options.scrollHandler || null; + this.clickHandler = options.clickHandler || null; + this.dblClickHandler = options.dblClickHandler || null; + this.dragHandler = options.dragHandler || null; + this.dragEndHandler = options.dragEndHandler || null; + this.pinchHandler = options.pinchHandler || null; + this.stopHandler = options.stopHandler || null; + this.keyHandler = options.keyHandler || null; + this.focusHandler = options.focusHandler || null; + this.blurHandler = options.blurHandler || null; //Store private properties in a scope sealed hash map var _this = this; @@ -424,7 +424,7 @@ * @param {Object} event.userData * Arbitrary user-defined object. */ - auxPressHandler: function () { }, + nonPrimaryPressHandler: function () { }, /** * Implement or assign implementation to these handlers during or after @@ -482,7 +482,7 @@ * @param {Object} event.userData * Arbitrary user-defined object. */ - auxReleaseHandler: function () { }, + nonPrimaryReleaseHandler: function () { }, /** * Implement or assign implementation to these handlers during or after @@ -2494,8 +2494,8 @@ // Only capture and track primary button, pen, and touch contacts if ( buttonChanged !== 0 ) { // Aux Press - if ( tracker.auxPressHandler ) { - propagate = tracker.auxPressHandler( + if ( tracker.nonPrimaryPressHandler ) { + propagate = tracker.nonPrimaryPressHandler( { eventSource: tracker, pointerType: gPoints[ 0 ].type, @@ -2662,8 +2662,8 @@ // Only capture and track primary button, pen, and touch contacts if ( buttonChanged !== 0 ) { // Aux Release - if ( tracker.auxReleaseHandler ) { - propagate = tracker.auxReleaseHandler( + if ( tracker.nonPrimaryReleaseHandler ) { + propagate = tracker.nonPrimaryReleaseHandler( { eventSource: tracker, pointerType: gPoints[ 0 ].type, diff --git a/src/viewer.js b/src/viewer.js index 5c8b45a8..909e65b1 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -380,20 +380,20 @@ $.Viewer = function( options ) { this.innerTracker = new $.MouseTracker({ - element: this.canvas, - clickTimeThreshold: this.clickTimeThreshold, - clickDistThreshold: this.clickDistThreshold, - dblClickTimeThreshold: this.dblClickTimeThreshold, - dblClickDistThreshold: this.dblClickDistThreshold, - clickHandler: $.delegate( this, onCanvasClick ), - dblClickHandler: $.delegate( this, onCanvasDblClick ), - dragHandler: $.delegate( this, onCanvasDrag ), - dragEndHandler: $.delegate( this, onCanvasDragEnd ), - releaseHandler: $.delegate( this, onCanvasRelease ), - auxPressHandler: $.delegate( this, onCanvasAuxPress ), - auxReleaseHandler: $.delegate( this, onCanvasAuxRelease ), - scrollHandler: $.delegate( this, onCanvasScroll ), - pinchHandler: $.delegate( this, onCanvasPinch ) + element: this.canvas, + clickTimeThreshold: this.clickTimeThreshold, + clickDistThreshold: this.clickDistThreshold, + dblClickTimeThreshold: this.dblClickTimeThreshold, + dblClickDistThreshold: this.dblClickDistThreshold, + clickHandler: $.delegate( this, onCanvasClick ), + dblClickHandler: $.delegate( this, onCanvasDblClick ), + dragHandler: $.delegate( this, onCanvasDrag ), + dragEndHandler: $.delegate( this, onCanvasDragEnd ), + releaseHandler: $.delegate( this, onCanvasRelease ), + nonPrimaryPressHandler: $.delegate( this, onCanvasNonPrimaryPress ), + nonPrimaryReleaseHandler: $.delegate( this, onCanvasNonPrimaryRelease ), + scrollHandler: $.delegate( this, onCanvasScroll ), + pinchHandler: $.delegate( this, onCanvasPinch ) }).setTracking( this.mouseNavEnabled ? true : false ); // default state this.outerTracker = new $.MouseTracker({ @@ -2446,11 +2446,11 @@ function onCanvasRelease( event ) { }); } -function onCanvasAuxPress( event ) { +function onCanvasNonPrimaryPress( event ) { /** * Raised when any non-primary pointer button is pressed on the {@link OpenSeadragon.Viewer#canvas} element. * - * @event canvas-aux-press + * @event canvas-nonprimary-press * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. @@ -2464,7 +2464,7 @@ function onCanvasAuxPress( event ) { * @property {Object} originalEvent - The original DOM event. * @property {?Object} userData - Arbitrary subscriber-defined object. */ - this.raiseEvent( 'canvas-aux-press', { + this.raiseEvent( 'canvas-nonprimary-press', { tracker: event.eventSource, position: event.position, pointerType: event.pointerType, @@ -2474,11 +2474,11 @@ function onCanvasAuxPress( event ) { }); } -function onCanvasAuxRelease( event ) { +function onCanvasNonPrimaryRelease( event ) { /** * Raised when any non-primary pointer button is released on the {@link OpenSeadragon.Viewer#canvas} element. * - * @event canvas-aux-release + * @event canvas-nonprimary-release * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. @@ -2492,7 +2492,7 @@ function onCanvasAuxRelease( event ) { * @property {Object} originalEvent - The original DOM event. * @property {?Object} userData - Arbitrary subscriber-defined object. */ - this.raiseEvent( 'canvas-aux-release', { + this.raiseEvent( 'canvas-nonprimary-release', { tracker: event.eventSource, position: event.position, pointerType: event.pointerType, diff --git a/test/events.js b/test/events.js index e9f5074f..43069e96 100644 --- a/test/events.js +++ b/test/events.js @@ -35,8 +35,8 @@ origExitHandler, origPressHandler, origReleaseHandler, - origAuxPressHandler, - origAuxReleaseHandler, + origNonPrimaryPressHandler, + origNonPrimaryReleaseHandler, origMoveHandler, origClickHandler, origDblClickHandler, @@ -48,8 +48,8 @@ releaseCount, rightPressCount, rightReleaseCount, - auxPressCount, - auxReleaseCount, + middlePressCount, + middleReleaseCount, moveCount, clickCount, dblClickCount, @@ -100,32 +100,32 @@ return true; } }; - origAuxPressHandler = tracker.auxPressHandler; - tracker.auxPressHandler = function ( event ) { + origNonPrimaryPressHandler = tracker.nonPrimaryPressHandler; + tracker.nonPrimaryPressHandler = function ( event ) { if (event.button === 0) { pressCount++; } else if (event.button === 1) { - auxPressCount++; + middlePressCount++; } else if (event.button === 2) { rightPressCount++; } - if (origAuxPressHandler) { - return origAuxPressHandler( event ); + if (origNonPrimaryPressHandler) { + return origNonPrimaryPressHandler( event ); } else { return true; } }; - origAuxReleaseHandler = tracker.auxReleaseHandler; - tracker.auxReleaseHandler = function ( event ) { + origNonPrimaryReleaseHandler = tracker.nonPrimaryReleaseHandler; + tracker.nonPrimaryReleaseHandler = function ( event ) { if (event.button === 0) { releaseCount++; } else if (event.button === 1) { - auxReleaseCount++; + middleReleaseCount++; } else if (event.button === 2) { rightReleaseCount++; } - if (origAuxReleaseHandler) { - return origAuxReleaseHandler( event ); + if (origNonPrimaryReleaseHandler) { + return origNonPrimaryReleaseHandler( event ); } else { return true; } @@ -225,14 +225,14 @@ $canvas.simulate( 'mouseup', simEvent ); }; - var simulateAuxDown = function (x, y, button) { + var simulateNonPrimaryDown = function (x, y, button) { simEvent.button = button; simEvent.clientX = offset.left + x; simEvent.clientY = offset.top + y; $canvas.simulate( 'mousedown', simEvent ); }; - var simulateAuxUp = function (x, y, button) { + var simulateNonPrimaryUp = function (x, y, button) { simEvent.button = button; simEvent.clientX = offset.left + x; simEvent.clientY = offset.top + y; @@ -260,8 +260,8 @@ releaseCount = 0; rightPressCount = 0; rightReleaseCount = 0; - auxPressCount = 0; - auxReleaseCount = 0; + middlePressCount = 0; + middleReleaseCount = 0; moveCount = 0; clickCount = 0; dblClickCount = 0; @@ -289,16 +289,16 @@ equal( releaseCount, expected.releaseCount, expected.description + 'releaseHandler event count matches expected (' + expected.releaseCount + ')' ); } if ('rightPressCount' in expected) { - equal( rightPressCount, expected.rightPressCount, expected.description + 'auxPressHandler event count (secondary/right button) matches expected (' + expected.rightPressCount + ')' ); + equal( rightPressCount, expected.rightPressCount, expected.description + 'nonPrimaryPressHandler event count (secondary/right button) matches expected (' + expected.rightPressCount + ')' ); } if ('rightReleaseCount' in expected) { - equal( rightReleaseCount, expected.rightReleaseCount, expected.description + 'auxReleaseHandler event count (secondary/right button) matches expected (' + expected.rightReleaseCount + ')' ); + equal( rightReleaseCount, expected.rightReleaseCount, expected.description + 'nonPrimaryReleaseHandler event count (secondary/right button) matches expected (' + expected.rightReleaseCount + ')' ); } - if ('auxPressCount' in expected) { - equal( auxPressCount, expected.auxPressCount, expected.description + 'auxPressHandler event count (aux/middle button) matches expected (' + expected.auxPressCount + ')' ); + if ('middlePressCount' in expected) { + equal( middlePressCount, expected.middlePressCount, expected.description + 'nonPrimaryPressHandler event count (aux/middle button) matches expected (' + expected.middlePressCount + ')' ); } - if ('auxReleaseCount' in expected) { - equal( auxReleaseCount, expected.auxReleaseCount, expected.description + 'auxReleaseHandler event count (aux/middle button) matches expected (' + expected.auxReleaseCount + ')' ); + if ('middleReleaseCount' in expected) { + equal( middleReleaseCount, expected.middleReleaseCount, expected.description + 'nonPrimaryReleaseHandler event count (aux/middle button) matches expected (' + expected.middleReleaseCount + ')' ); } if ('moveCount' in expected) { equal( moveCount, expected.moveCount, expected.description + 'moveHandler event count matches expected (' + expected.moveCount + ')' ); @@ -361,8 +361,8 @@ releaseCount: 1, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 20, clickCount: 0, dblClickCount: 0, @@ -390,8 +390,8 @@ releaseCount: 0, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 20, clickCount: 0, dblClickCount: 0, @@ -417,8 +417,8 @@ releaseCount: 0, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 20, clickCount: 0, dblClickCount: 0, @@ -447,8 +447,8 @@ releaseCount: 2, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 0, clickCount: 2, dblClickCount: 1, @@ -475,8 +475,8 @@ releaseCount: 1, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 0, clickCount: 1, dblClickCount: 0, @@ -489,22 +489,22 @@ quickClick: true }); - // enter-auxpress-auxrelease-exit (secondary/right click) + // enter-nonprimarypress-nonprimaryrelease-exit (secondary/right click) resetForAssessment(); simulateEnter(0, 0); - simulateAuxDown(0, 0, 2); - simulateAuxUp(0, 0, 2); + simulateNonPrimaryDown(0, 0, 2); + simulateNonPrimaryUp(0, 0, 2); simulateLeave(-1, -1); assessGestureExpectations({ - description: 'enter-auxpress-auxrelease-exit (secondary/right click): ', + description: 'enter-nonprimarypress-nonprimaryrelease-exit (secondary/right click): ', enterCount: 1, exitCount: 1, pressCount: 0, releaseCount: 0, rightPressCount: 1, rightReleaseCount: 1, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 0, clickCount: 0, dblClickCount: 0, @@ -517,22 +517,22 @@ //quickClick: true }); - // enter-auxpress-auxrelease-exit (aux/middle click) + // enter-nonprimarypress-nonprimaryrelease-exit (aux/middle click) resetForAssessment(); simulateEnter(0, 0); - simulateAuxDown(0, 0, 1); - simulateAuxUp(0, 0, 1); + simulateNonPrimaryDown(0, 0, 1); + simulateNonPrimaryUp(0, 0, 1); simulateLeave(-1, -1); assessGestureExpectations({ - description: 'enter-auxpress-auxrelease-exit (aux/middle click): ', + description: 'enter-nonprimarypress-nonprimaryrelease-exit (aux/middle click): ', enterCount: 1, exitCount: 1, pressCount: 0, releaseCount: 0, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 1, - auxReleaseCount: 1, + middlePressCount: 1, + middleReleaseCount: 1, moveCount: 0, clickCount: 0, dblClickCount: 0, @@ -545,24 +545,24 @@ //quickClick: true }); - // enter-auxpress-move-auxrelease-move-exit (secondary/right button drag, release in tracked element) + // enter-nonprimarypress-move-nonprimaryrelease-move-exit (secondary/right button drag, release in tracked element) resetForAssessment(); simulateEnter(0, 0); - simulateAuxDown(0, 0, 2); + simulateNonPrimaryDown(0, 0, 2); simulateMove(1, 1, 100); - simulateAuxUp(10, 10, 2); + simulateNonPrimaryUp(10, 10, 2); simulateMove(-1, -1, 100); simulateLeave(-1, -1); assessGestureExpectations({ - description: 'enter-auxpress-move-auxrelease-move-exit (secondary/right button drag, release in tracked element): ', + description: 'enter-nonprimarypress-move-nonprimaryrelease-move-exit (secondary/right button drag, release in tracked element): ', enterCount: 1, exitCount: 1, pressCount: 0, releaseCount: 0, rightPressCount: 1, rightReleaseCount: 1, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 200, clickCount: 0, dblClickCount: 0, @@ -591,8 +591,8 @@ releaseCount: 1, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 200, clickCount: 1, dblClickCount: 0, @@ -622,8 +622,8 @@ releaseCount: 1, rightPressCount: 0, rightReleaseCount: 0, - auxPressCount: 0, - auxReleaseCount: 0, + middlePressCount: 0, + middleReleaseCount: 0, moveCount: 15, clickCount: 0, dblClickCount: 0, @@ -652,8 +652,8 @@ // releaseCount: 1, // rightPressCount: 0, // rightReleaseCount: 0, - // auxPressCount: 0, - // auxReleaseCount: 0, + // middlePressCount: 0, + // middleReleaseCount: 0, // moveCount: 10, // clickCount: 0, // dblClickCount: 0,