Merge branch 'Original-Events-In-Handlers' of github.com:msalsbery/openseadragon into msalsbery-Original-Events-In-Handlers

Fixed Conflicts:
	changelog.txt
This commit is contained in:
Ian Gilman 2013-09-24 10:28:46 -07:00
commit 6396fe1504
11 changed files with 819 additions and 495 deletions

View File

@ -3,6 +3,11 @@ OPENSEADRAGON CHANGELOG
1.0.0: (in progress)
* MouseTracker now passes the original event objects to its handler methods (#23)
* Breaking change: MouseTracker event handler method signatures changed to 'handlerMethod( tracker, eventData)' (#23)
* MouseTracker now supports an optional 'moveHandler' method for tracking mousemove events (#215)
* Fixed: Element-relative mouse coordinates now correct if the element and/or page is scrolled (using new OpenSeadragon.getElementOffset() method) (#131)
0.9.131:
* Fixed: canvas-click event shouldn't fire as you drag (#198)

View File

@ -175,57 +175,57 @@ $.Button = function( options ) {
clickTimeThreshold: this.clickTimeThreshold,
clickDistThreshold: this.clickDistThreshold,
enterHandler: function( tracker, position, buttonDownElement, buttonDownAny ) {
if ( buttonDownElement ) {
enterHandler: function( tracker, eventData ) {
if ( eventData.insideElementPressed ) {
inTo( _this, $.ButtonState.DOWN );
_this.raiseEvent( "onEnter", _this );
} else if ( !buttonDownAny ) {
} else if ( !eventData.buttonDownAny ) {
inTo( _this, $.ButtonState.HOVER );
}
},
focusHandler: function( tracker, position, buttonDownElement, buttonDownAny ) {
this.enterHandler( tracker, position, buttonDownElement, buttonDownAny );
focusHandler: function ( tracker, eventData ) {
this.enterHandler( tracker, eventData );
_this.raiseEvent( "onFocus", _this );
},
exitHandler: function( tracker, position, buttonDownElement, buttonDownAny ) {
exitHandler: function( tracker, eventData ) {
outTo( _this, $.ButtonState.GROUP );
if ( buttonDownElement ) {
if ( eventData.insideElementPressed ) {
_this.raiseEvent( "onExit", _this );
}
},
blurHandler: function( tracker, position, buttonDownElement, buttonDownAny ) {
this.exitHandler( tracker, position, buttonDownElement, buttonDownAny );
blurHandler: function ( tracker, eventData ) {
this.exitHandler( tracker, eventData );
_this.raiseEvent( "onBlur", _this );
},
pressHandler: function( tracker, position ) {
pressHandler: function ( tracker, eventData ) {
inTo( _this, $.ButtonState.DOWN );
_this.raiseEvent( "onPress", _this );
},
releaseHandler: function( tracker, position, insideElementPress, insideElementRelease ) {
if ( insideElementPress && insideElementRelease ) {
releaseHandler: function( tracker, eventData ) {
if ( eventData.insideElementPressed && eventData.insideElementReleased ) {
outTo( _this, $.ButtonState.HOVER );
_this.raiseEvent( "onRelease", _this );
} else if ( insideElementPress ) {
} else if ( eventData.insideElementPressed ) {
outTo( _this, $.ButtonState.GROUP );
} else {
inTo( _this, $.ButtonState.HOVER );
}
},
clickHandler: function( tracker, position, quick, shift ) {
if ( quick ) {
clickHandler: function( tracker, eventData ) {
if ( eventData.quick ) {
_this.raiseEvent("onClick", _this);
}
},
keyHandler: function( tracker, key ){
//console.log( "%s : handling key %s!", _this.tooltip, key);
if( 13 === key ){
keyHandler: function( tracker, eventData ){
//console.log( "%s : handling key %s!", _this.tooltip, eventData.keyCode);
if( 13 === eventData.keyCode ){
_this.raiseEvent( "onClick", _this );
_this.raiseEvent( "onRelease", _this );
return false;

View File

@ -85,29 +85,23 @@ $.ButtonGroup = function( options ) {
element: this.element,
clickTimeThreshold: this.clickTimeThreshold,
clickDistThreshold: this.clickDistThreshold,
enterHandler: function() {
enterHandler: function ( tracker, eventData ) {
var i;
for ( i = 0; i < _this.buttons.length; i++ ) {
_this.buttons[ i ].notifyGroupEnter();
}
},
exitHandler: function() {
var i,
buttonDownElement = arguments.length > 2 ?
arguments[ 2 ] :
null;
if ( !buttonDownElement ) {
exitHandler: function ( tracker, eventData ) {
var i;
if ( !eventData.insideElementPressed ) {
for ( i = 0; i < _this.buttons.length; i++ ) {
_this.buttons[ i ].notifyGroupExit();
}
}
},
releaseHandler: function() {
var i,
insideElementRelease = arguments.length > 3 ?
arguments[ 3 ] :
null;
if ( !insideElementRelease ) {
releaseHandler: function ( tracker, eventData ) {
var i;
if ( !eventData.insideElementReleased ) {
for ( i = 0; i < _this.buttons.length; i++ ) {
_this.buttons[ i ].notifyGroupExit();
}
@ -125,7 +119,7 @@ $.ButtonGroup.prototype = {
* @name OpenSeadragon.ButtonGroup.prototype.emulateEnter
*/
emulateEnter: function() {
this.tracker.enterHandler();
this.tracker.enterHandler( this.tracker, {} );
},
/**
@ -135,7 +129,7 @@ $.ButtonGroup.prototype = {
* @name OpenSeadragon.ButtonGroup.prototype.emulateExit
*/
emulateExit: function() {
this.tracker.exitHandler();
this.tracker.exitHandler( this.tracker, {} );
}
};

View File

@ -55,7 +55,7 @@ $.EventHandler.prototype = {
* @function
* @param {String} eventName - Name of event to register.
* @param {Function} handler - Function to call when event is triggered.
* @param {Object} optional userData - Arbitrary object to be passed to the handler.
* @param {Object} [userData=null] - Arbitrary object to be passed unchanged to the handler.
*/
addHandler: function ( eventName, handler, userData ) {
var events = this.events[ eventName ];

File diff suppressed because it is too large Load Diff

View File

@ -251,13 +251,13 @@ $.extend( $.Navigator.prototype, $.EventHandler.prototype, $.Viewer.prototype, {
* @inner
* @function
*/
function onCanvasClick( tracker, position, quick, shift ) {
function onCanvasClick( tracker, eventData ) {
var newBounds,
viewerPosition,
dimensions;
if (! this.drag) {
if ( this.viewer.viewport ) {
viewerPosition = this.viewport.deltaPointsFromPixels(position);
viewerPosition = this.viewport.deltaPointsFromPixels( eventData.position );
dimensions = this.viewer.viewport.getBounds().getSize();
newBounds = new $.Rect(
viewerPosition.x - dimensions.x/2,
@ -285,18 +285,18 @@ function onCanvasClick( tracker, position, quick, shift ) {
* @inner
* @function
*/
function onCanvasDrag( tracker, position, delta, shift ) {
function onCanvasDrag( tracker, eventData ) {
if ( this.viewer.viewport ) {
this.drag = true;
if( !this.panHorizontal ){
delta.x = 0;
eventData.delta.x = 0;
}
if( !this.panVertical ){
delta.y = 0;
eventData.delta.y = 0;
}
this.viewer.viewport.panBy(
this.viewport.deltaPointsFromPixels(
delta
eventData.delta
)
);
}
@ -308,8 +308,8 @@ function onCanvasDrag( tracker, position, delta, shift ) {
* @inner
* @function
*/
function onCanvasRelease( tracker, position, insideElementPress, insideElementRelease ) {
if ( insideElementPress && this.viewer.viewport ) {
function onCanvasRelease( tracker, eventData ) {
if ( eventData.insideElementPressed && this.viewer.viewport ) {
this.viewer.viewport.applyConstraints();
}
}

View File

@ -699,6 +699,44 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){
},
/**
* Determines the position of the upper-left corner of the element adjusted for current page and/or element scroll.
* @function
* @name OpenSeadragon.getElementOffset
* @param {Element|String} element - the element we want the position for.
* @returns {Point} - the position of the upper left corner of the element adjusted for current page and/or element scroll.
*/
getElementOffset: function( element ) {
element = $.getElement( element );
var doc = element && element.ownerDocument,
docElement,
win,
boundingRect = { top: 0, left: 0 };
if ( !doc ) {
return new $.Point();
}
docElement = doc.documentElement;
if ( typeof element.getBoundingClientRect !== typeof undefined ) {
boundingRect = element.getBoundingClientRect();
}
win = ( doc == doc.window ) ?
doc :
( doc.nodeType === 9 ) ?
doc.defaultView || doc.parentWindow :
false;
return new $.Point(
boundingRect.left + ( win.pageXOffset || docElement.scrollLeft ) - ( docElement.clientLeft || 0 ),
boundingRect.top + ( win.pageYOffset || docElement.scrollTop ) - ( docElement.clientTop || 0 )
);
},
/**
* Determines the height and width of the given element.
* @function

View File

@ -32,7 +32,7 @@
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
(function( $ ){
(function ( $ ) {
// dictionary from id to private properties
var THIS = {};
@ -56,7 +56,7 @@ var THIS = {};
* require better abstraction at those points in order to effeciently
* reuse those paradigms.
*/
$.ReferenceStrip = function( options ){
$.ReferenceStrip = function ( options ) {
var _this = this,
viewer = options.viewer,
@ -67,7 +67,7 @@ $.ReferenceStrip = function( options ){
//We may need to create a new element and id if they did not
//provide the id for the existing element
if( !options.id ){
if ( !options.id ) {
options.id = 'referencestrip-' + $.now();
this.element = $.makeNeutralElement( "div" );
this.element.id = options.id;
@ -88,17 +88,17 @@ $.ReferenceStrip = function( options ){
mouseNavEnabled: false,
showNavigationControl: false,
showSequenceControl: false
});
} );
$.extend( this, options );
//Private state properties
THIS[ this.id ] = {
"animating": false
THIS[this.id] = {
"animating": false
};
this.minPixelRatio = this.viewer.minPixelRatio;
style = this.element.style;
style = this.element.style;
style.marginTop = '0px';
style.marginRight = '0px';
style.marginBottom = '0px';
@ -112,56 +112,56 @@ $.ReferenceStrip = function( options ){
$.setElementOpacity( this.element, 0.8 );
this.viewer = viewer;
this.innerTracker = new $.MouseTracker({
this.innerTracker = new $.MouseTracker( {
element: this.element,
dragHandler: $.delegate( this, onStripDrag ),
scrollHandler: $.delegate( this, onStripScroll ),
enterHandler: $.delegate( this, onStripEnter ),
exitHandler: $.delegate( this, onStripExit ),
keyHandler: $.delegate( this, onKeyPress )
}).setTracking( true );
} ).setTracking( true );
//Controls the position and orientation of the reference strip and sets the
//appropriate width and height
if( options.width && options.height ){
if ( options.width && options.height ) {
this.element.style.width = options.width + 'px';
this.element.style.height = options.height + 'px';
viewer.addControl(
this.element,
{anchor: $.ControlAnchor.BOTTOM_LEFT}
{ anchor: $.ControlAnchor.BOTTOM_LEFT }
);
} else {
if( "horizontal" == options.scroll ){
if ( "horizontal" == options.scroll ) {
this.element.style.width = (
viewerSize.x *
options.sizeRatio *
viewer.tileSources.length
) + ( 12 * viewer.tileSources.length ) + 'px';
this.element.style.height = (
this.element.style.height = (
viewerSize.y *
options.sizeRatio
) + 'px';
viewer.addControl(
this.element,
{anchor: $.ControlAnchor.BOTTOM_LEFT}
{ anchor: $.ControlAnchor.BOTTOM_LEFT }
);
}else {
} else {
this.element.style.height = (
viewerSize.y *
options.sizeRatio *
viewer.tileSources.length
) + ( 12 * viewer.tileSources.length ) + 'px';
this.element.style.width = (
this.element.style.width = (
viewerSize.x *
options.sizeRatio
) + 'px';
viewer.addControl(
this.element,
{anchor: $.ControlAnchor.TOP_LEFT}
{ anchor: $.ControlAnchor.TOP_LEFT }
);
}
@ -172,9 +172,9 @@ $.ReferenceStrip = function( options ){
this.panels = [];
/*jshint loopfunc:true*/
for( i = 0; i < viewer.tileSources.length; i++ ){
for ( i = 0; i < viewer.tileSources.length; i++ ) {
element = $.makeNeutralElement('div');
element = $.makeNeutralElement( 'div' );
element.id = this.element.id + "-" + i;
element.style.width = _this.panelWidth + 'px';
@ -185,27 +185,27 @@ $.ReferenceStrip = function( options ){
element.style.styleFloat = 'left'; //IE
element.style.padding = '2px';
element.innerTracker = new $.MouseTracker({
element.innerTracker = new $.MouseTracker( {
element: element,
clickTimeThreshold: this.clickTimeThreshold,
clickDistThreshold: this.clickDistThreshold,
pressHandler: function( tracker ){
pressHandler: function ( tracker, eventData ) {
tracker.dragging = $.now();
},
releaseHandler: function( tracker, position, insideElementPress, insideElementRelease ){
var id = tracker.element.id,
page = Number( id.split( '-' )[ 2 ] ),
now = $.now();
releaseHandler: function ( tracker, eventData ) {
var id = tracker.element.id,
page = Number( id.split( '-' )[2] ),
now = $.now();
if ( insideElementPress &&
insideElementRelease &&
if ( eventData.insideElementPressed &&
eventData.insideElementReleased &&
tracker.dragging &&
( now - tracker.dragging ) < tracker.clickTimeThreshold ){
( now - tracker.dragging ) < tracker.clickTimeThreshold ) {
tracker.dragging = null;
viewer.goToPage( page );
}
}
}).setTracking( true );
} ).setTracking( true );
this.element.appendChild( element );
@ -214,49 +214,49 @@ $.ReferenceStrip = function( options ){
this.panels.push( element );
}
loadPanels( this, this.scroll == 'vertical' ? viewerSize.y : viewerSize.y, 0);
loadPanels( this, this.scroll == 'vertical' ? viewerSize.y : viewerSize.y, 0 );
this.setFocus( 0 );
};
$.extend( $.ReferenceStrip.prototype, $.EventHandler.prototype, $.Viewer.prototype, {
setFocus: function( page ){
var element = $.getElement( this.element.id + '-' + page ),
viewerSize = $.getElementSize( this.viewer.canvas ),
scrollWidth = Number(this.element.style.width.replace('px','')),
scrollHeight = Number(this.element.style.height.replace('px','')),
offsetLeft = -Number(this.element.style.marginLeft.replace('px','')),
offsetTop = -Number(this.element.style.marginTop.replace('px','')),
setFocus: function ( page ) {
var element = $.getElement( this.element.id + '-' + page ),
viewerSize = $.getElementSize( this.viewer.canvas ),
scrollWidth = Number( this.element.style.width.replace( 'px', '' ) ),
scrollHeight = Number( this.element.style.height.replace( 'px', '' ) ),
offsetLeft = -Number( this.element.style.marginLeft.replace( 'px', '' ) ),
offsetTop = -Number( this.element.style.marginTop.replace( 'px', '' ) ),
offset;
if ( this.currentSelected !== element ){
if( this.currentSelected ){
if ( this.currentSelected !== element ) {
if ( this.currentSelected ) {
this.currentSelected.style.background = '#000';
}
this.currentSelected = element;
this.currentSelected.style.background = '#999';
if( 'horizontal' == this.scroll ){
if ( 'horizontal' == this.scroll ) {
//right left
offset = (Number(page)) * ( this.panelWidth + 3 );
if( offset > offsetLeft + viewerSize.x - this.panelWidth){
offset = Math.min(offset, (scrollWidth - viewerSize.x));
offset = ( Number( page ) ) * ( this.panelWidth + 3 );
if ( offset > offsetLeft + viewerSize.x - this.panelWidth ) {
offset = Math.min( offset, ( scrollWidth - viewerSize.x ) );
this.element.style.marginLeft = -offset + 'px';
loadPanels( this, viewerSize.x, -offset );
}else if( offset < offsetLeft ){
offset = Math.max(0, offset - viewerSize.x / 2);
} else if ( offset < offsetLeft ) {
offset = Math.max( 0, offset - viewerSize.x / 2 );
this.element.style.marginLeft = -offset + 'px';
loadPanels( this, viewerSize.x, -offset );
}
}else{
offset = (Number(page) ) * ( this.panelHeight + 3 );
if( offset > offsetTop + viewerSize.y - this.panelHeight){
offset = Math.min(offset, (scrollHeight - viewerSize.y));
} else {
offset = ( Number( page ) ) * ( this.panelHeight + 3 );
if ( offset > offsetTop + viewerSize.y - this.panelHeight ) {
offset = Math.min( offset, ( scrollHeight - viewerSize.y ) );
this.element.style.marginTop = -offset + 'px';
loadPanels( this, viewerSize.y, -offset );
}else if( offset < offsetTop ){
offset = Math.max(0, offset - viewerSize.y / 2);
} else if ( offset < offsetTop ) {
offset = Math.max( 0, offset - viewerSize.y / 2 );
this.element.style.marginTop = -offset + 'px';
loadPanels( this, viewerSize.y, -offset );
}
@ -264,22 +264,22 @@ $.extend( $.ReferenceStrip.prototype, $.EventHandler.prototype, $.Viewer.prototy
this.currentPage = page;
$.getElement( element.id + '-displayregion' ).focus();
onStripEnter.call( this, this.innerTracker );
onStripEnter.call( this, this.innerTracker, {} );
}
},
/**
* @function
* @name OpenSeadragon.ReferenceStrip.prototype.update
*/
update: function() {
if ( THIS[ this.id ].animating ) {
$.console.log('image reference strip update');
update: function () {
if ( THIS[this.id].animating ) {
$.console.log( 'image reference strip update' );
return true;
}
return false;
}
});
} );
@ -289,41 +289,41 @@ $.extend( $.ReferenceStrip.prototype, $.EventHandler.prototype, $.Viewer.prototy
* @inner
* @function
*/
function onStripDrag( tracker, position, delta, shift ) {
function onStripDrag( tracker, eventData ) {
var offsetLeft = Number(this.element.style.marginLeft.replace('px','')),
offsetTop = Number(this.element.style.marginTop.replace('px','')),
scrollWidth = Number(this.element.style.width.replace('px','')),
scrollHeight = Number(this.element.style.height.replace('px','')),
viewerSize = $.getElementSize( this.viewer.canvas );
var offsetLeft = Number( this.element.style.marginLeft.replace( 'px', '' ) ),
offsetTop = Number( this.element.style.marginTop.replace( 'px', '' ) ),
scrollWidth = Number( this.element.style.width.replace( 'px', '' ) ),
scrollHeight = Number( this.element.style.height.replace( 'px', '' ) ),
viewerSize = $.getElementSize( this.viewer.canvas );
this.dragging = true;
if ( this.element ) {
if( 'horizontal' == this.scroll ){
if ( -delta.x > 0 ) {
if ( 'horizontal' == this.scroll ) {
if ( -eventData.delta.x > 0 ) {
//forward
if( offsetLeft > -(scrollWidth - viewerSize.x)){
this.element.style.marginLeft = ( offsetLeft + (delta.x * 2) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft + (delta.x * 2) );
if ( offsetLeft > -( scrollWidth - viewerSize.x ) ) {
this.element.style.marginLeft = ( offsetLeft + ( eventData.delta.x * 2 ) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft + ( eventData.delta.x * 2 ) );
}
} else if ( -delta.x < 0 ) {
} else if ( -eventData.delta.x < 0 ) {
//reverse
if( offsetLeft < 0 ){
this.element.style.marginLeft = ( offsetLeft + (delta.x * 2) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft + (delta.x * 2) );
if ( offsetLeft < 0 ) {
this.element.style.marginLeft = ( offsetLeft + ( eventData.delta.x * 2 ) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft + ( eventData.delta.x * 2 ) );
}
}
}else{
if ( -delta.y > 0 ) {
} else {
if ( -eventData.delta.y > 0 ) {
//forward
if( offsetTop > -(scrollHeight - viewerSize.y)){
this.element.style.marginTop = ( offsetTop + (delta.y * 2) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + (delta.y * 2) );
if ( offsetTop > -( scrollHeight - viewerSize.y ) ) {
this.element.style.marginTop = ( offsetTop + ( eventData.delta.y * 2 ) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + ( eventData.delta.y * 2 ) );
}
} else if ( -delta.y < 0 ) {
} else if ( -eventData.delta.y < 0 ) {
//reverse
if( offsetTop < 0 ){
this.element.style.marginTop = ( offsetTop + (delta.y * 2) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + (delta.y * 2) );
if ( offsetTop < 0 ) {
this.element.style.marginTop = ( offsetTop + ( eventData.delta.y * 2 ) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + ( eventData.delta.y * 2 ) );
}
}
}
@ -339,39 +339,39 @@ function onStripDrag( tracker, position, delta, shift ) {
* @inner
* @function
*/
function onStripScroll( tracker, position, scroll, shift ) {
var offsetLeft = Number(this.element.style.marginLeft.replace('px','')),
offsetTop = Number(this.element.style.marginTop.replace('px','')),
scrollWidth = Number(this.element.style.width.replace('px','')),
scrollHeight = Number(this.element.style.height.replace('px','')),
viewerSize = $.getElementSize( this.viewer.canvas );
function onStripScroll( tracker, eventData ) {
var offsetLeft = Number( this.element.style.marginLeft.replace( 'px', '' ) ),
offsetTop = Number( this.element.style.marginTop.replace( 'px', '' ) ),
scrollWidth = Number( this.element.style.width.replace( 'px', '' ) ),
scrollHeight = Number( this.element.style.height.replace( 'px', '' ) ),
viewerSize = $.getElementSize( this.viewer.canvas );
if ( this.element ) {
if( 'horizontal' == this.scroll ){
if ( scroll > 0 ) {
if ( 'horizontal' == this.scroll ) {
if ( eventData.scroll > 0 ) {
//forward
if( offsetLeft > -(scrollWidth - viewerSize.x)){
this.element.style.marginLeft = ( offsetLeft - (scroll * 60) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft - (scroll * 60) );
if ( offsetLeft > -( scrollWidth - viewerSize.x ) ) {
this.element.style.marginLeft = ( offsetLeft - ( eventData.scroll * 60 ) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft - ( eventData.scroll * 60 ) );
}
} else if ( scroll < 0 ) {
} else if ( eventData.scroll < 0 ) {
//reverse
if( offsetLeft < 0 ){
this.element.style.marginLeft = ( offsetLeft - (scroll * 60) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft - (scroll * 60) );
if ( offsetLeft < 0 ) {
this.element.style.marginLeft = ( offsetLeft - ( eventData.scroll * 60 ) ) + 'px';
loadPanels( this, viewerSize.x, offsetLeft - ( eventData.scroll * 60 ) );
}
}
}else{
if ( scroll < 0 ) {
} else {
if ( eventData.scroll < 0 ) {
//scroll up
if( offsetTop > viewerSize.y - scrollHeight ){
this.element.style.marginTop = ( offsetTop + (scroll * 60) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + (scroll * 60) );
if ( offsetTop > viewerSize.y - scrollHeight ) {
this.element.style.marginTop = ( offsetTop + ( eventData.scroll * 60 ) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + ( eventData.scroll * 60 ) );
}
} else if ( scroll > 0 ) {
} else if ( eventData.scroll > 0 ) {
//scroll dowm
if( offsetTop < 0 ){
this.element.style.marginTop = ( offsetTop + (scroll * 60) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + (scroll * 60) );
if ( offsetTop < 0 ) {
this.element.style.marginTop = ( offsetTop + ( eventData.scroll * 60 ) ) + 'px';
loadPanels( this, viewerSize.y, offsetTop + ( eventData.scroll * 60 ) );
}
}
}
@ -381,7 +381,7 @@ function onStripScroll( tracker, position, scroll, shift ) {
}
function loadPanels(strip, viewerSize, scroll){
function loadPanels( strip, viewerSize, scroll ) {
var panelSize,
activePanelsStart,
activePanelsEnd,
@ -389,22 +389,22 @@ function loadPanels(strip, viewerSize, scroll){
style,
i,
element;
if( 'horizontal' == strip.scroll ){
if ( 'horizontal' == strip.scroll ) {
panelSize = strip.panelWidth;
}else{
} else {
panelSize = strip.panelHeight;
}
activePanelsStart = Math.ceil( viewerSize / panelSize ) + 5;
activePanelsEnd = Math.ceil( (Math.abs(scroll) + viewerSize ) / panelSize ) + 1;
activePanelsEnd = Math.ceil( ( Math.abs( scroll ) + viewerSize ) / panelSize ) + 1;
activePanelsStart = activePanelsEnd - activePanelsStart;
activePanelsStart = activePanelsStart < 0 ? 0 : activePanelsStart;
for( i = activePanelsStart; i < activePanelsEnd && i < strip.panels.length; i++ ){
element = strip.panels[ i ];
if ( !element.activePanel ){
for ( i = activePanelsStart; i < activePanelsEnd && i < strip.panels.length; i++ ) {
element = strip.panels[i];
if ( !element.activePanel ) {
miniViewer = new $.Viewer( {
id: element.id,
tileSources: [ strip.viewer.tileSources[ i ] ],
tileSources: [strip.viewer.tileSources[i]],
element: element,
navigatorSizeRatio: strip.sizeRatio,
showNavigator: false,
@ -420,7 +420,7 @@ function loadPanels(strip, viewerSize, scroll){
miniViewer.displayRegion.id = element.id + '-displayregion';
miniViewer.displayRegion.className = 'displayregion';
style = miniViewer.displayRegion.style;
style = miniViewer.displayRegion.style;
style.position = 'relative';
style.top = '0px';
style.left = '0px';
@ -434,11 +434,11 @@ function loadPanels(strip, viewerSize, scroll){
style.width = ( strip.panelWidth - 4 ) + 'px';
style.height = ( strip.panelHeight - 4 ) + 'px';
miniViewer.displayRegion.innerTracker = new $.MouseTracker({
element: miniViewer.displayRegion
});
miniViewer.displayRegion.innerTracker = new $.MouseTracker( {
element: miniViewer.displayRegion
} );
element.getElementsByTagName('form')[ 0 ].appendChild(
element.getElementsByTagName( 'form' )[0].appendChild(
miniViewer.displayRegion
);
@ -453,14 +453,14 @@ function loadPanels(strip, viewerSize, scroll){
* @inner
* @function
*/
function onStripEnter( tracker ) {
function onStripEnter( tracker, eventData ) {
//$.setElementOpacity(tracker.element, 0.8);
//tracker.element.style.border = '1px solid #555';
//tracker.element.style.background = '#000';
if( 'horizontal' == this.scroll ){
if ( 'horizontal' == this.scroll ) {
//tracker.element.style.paddingTop = "0px";
tracker.element.style.marginBottom = "0px";
@ -480,7 +480,7 @@ function onStripEnter( tracker ) {
* @inner
* @function
*/
function onStripExit( tracker ) {
function onStripExit( tracker, eventData ) {
if ( 'horizontal' == this.scroll ) {
//tracker.element.style.paddingTop = "10px";
@ -489,7 +489,7 @@ function onStripExit( tracker ) {
} else {
//tracker.element.style.paddingRight = "10px";
tracker.element.style.marginLeft = "-" + ( $.getElementSize( tracker.element ).x / 2 )+ "px";
tracker.element.style.marginLeft = "-" + ( $.getElementSize( tracker.element ).x / 2 ) + "px";
}
return false;
@ -502,41 +502,41 @@ function onStripExit( tracker ) {
* @inner
* @function
*/
function onKeyPress( tracker, keyCode, shiftKey ){
//console.log( keyCode );
function onKeyPress( tracker, eventData ) {
//console.log( eventData.keyCode );
switch( keyCode ){
case 61://=|+
onStripScroll.call(this, this.tracker, null, 1, null);
switch ( eventData.keyCode ) {
case 61: //=|+
onStripScroll.call( this, this.tracker, { position: null, scroll: 1, shift: null } );
return false;
case 45://-|_
onStripScroll.call(this, this.tracker, null, -1, null);
case 45: //-|_
onStripScroll.call( this, this.tracker, { position: null, scroll: -1, shift: null } );
return false;
case 48://0|)
case 119://w
case 87://W
case 38://up arrow
onStripScroll.call(this, this.tracker, null, 1, null);
case 48: //0|)
case 119: //w
case 87: //W
case 38: //up arrow
onStripScroll.call( this, this.tracker, { position: null, scroll: 1, shift: null } );
return false;
case 115://s
case 83://S
case 40://down arrow
onStripScroll.call(this, this.tracker, null, -1, null);
case 115: //s
case 83: //S
case 40: //down arrow
onStripScroll.call( this, this.tracker, { position: null, scroll: -1, shift: null } );
return false;
case 97://a
case 37://left arrow
onStripScroll.call(this, this.tracker, null, -1, null);
case 97: //a
case 37: //left arrow
onStripScroll.call( this, this.tracker, { position: null, scroll: -1, shift: null } );
return false;
case 100://d
case 39://right arrow
onStripScroll.call(this, this.tracker, null, 1, null);
case 100: //d
case 39: //right arrow
onStripScroll.call( this, this.tracker, { position: null, scroll: 1, shift: null } );
return false;
default:
//console.log( 'navigator keycode %s', keyCode );
//console.log( 'navigator keycode %s', eventData.keyCode );
return true;
}
}
}( OpenSeadragon ));
} ( OpenSeadragon ) );

View File

@ -265,8 +265,8 @@ $.Viewer = function( options ) {
window.scrollTo( 0, point.y );
},
keyHandler: function(tracker, keyCode, shiftKey){
switch( keyCode ){
keyHandler: function( tracker, eventData ){
switch( eventData.keyCode ){
case 61://=|+
_this.viewport.zoomBy(1.1);
_this.viewport.applyConstraints();
@ -282,7 +282,7 @@ $.Viewer = function( options ) {
case 119://w
case 87://W
case 38://up arrow
if (shiftKey) {
if ( eventData.shift ) {
_this.viewport.zoomBy(1.1);
} else {
_this.viewport.panBy(new $.Point(0, -0.05));
@ -292,7 +292,7 @@ $.Viewer = function( options ) {
case 115://s
case 83://S
case 40://down arrow
if (shiftKey) {
if ( eventData.shift ) {
_this.viewport.zoomBy(0.9);
} else {
_this.viewport.panBy(new $.Point(0, 0.05));
@ -310,7 +310,7 @@ $.Viewer = function( options ) {
_this.viewport.applyConstraints();
return false;
default:
//console.log( 'navigator keycode %s', keyCode );
//console.log( 'navigator keycode %s', eventData.keyCode );
return true;
}
}
@ -731,7 +731,7 @@ $.extend( $.Viewer.prototype, $.EventHandler.prototype, $.ControlDock.prototype,
THIS[ this.hash ].fullPage = true;
// mouse will be inside container now
$.delegate( this, onContainerEnter )();
$.delegate( this, onContainerEnter )( null, {} );
} else {
@ -790,7 +790,7 @@ $.extend( $.Viewer.prototype, $.EventHandler.prototype, $.ControlDock.prototype,
THIS[ this.hash ].fullPage = false;
// mouse will likely be outside now
$.delegate( this, onContainerExit )();
$.delegate( this, onContainerExit )( null, {} );
}
@ -1427,37 +1427,37 @@ function onBlur(){
}
function onCanvasClick( tracker, position, quick, shift ) {
function onCanvasClick( tracker, eventData ) {
var zoomPerClick,
factor;
if ( this.viewport && quick ) { // ignore clicks where mouse moved
if ( this.viewport && eventData.quick ) { // ignore clicks where mouse moved
zoomPerClick = this.zoomPerClick;
factor = shift ? 1.0 / zoomPerClick : zoomPerClick;
factor = eventData.shift ? 1.0 / zoomPerClick : zoomPerClick;
this.viewport.zoomBy(
factor,
this.viewport.pointFromPixel( position, true )
this.viewport.pointFromPixel( eventData.position, true )
);
this.viewport.applyConstraints();
}
this.raiseEvent( 'canvas-click', {
tracker: tracker,
position: position,
quick: quick,
shift: shift
position: eventData.position,
quick: eventData.quick,
shift: eventData.shift
});
}
function onCanvasDrag( tracker, position, delta, shift ) {
function onCanvasDrag( tracker, eventData ) {
if ( this.viewport ) {
if( !this.panHorizontal ){
delta.x = 0;
eventData.delta.x = 0;
}
if( !this.panVertical ){
delta.y = 0;
eventData.delta.y = 0;
}
this.viewport.panBy(
this.viewport.deltaPointsFromPixels(
delta.negate()
eventData.delta.negate()
)
);
if( this.constrainDuringPan ){
@ -1466,46 +1466,46 @@ function onCanvasDrag( tracker, position, delta, shift ) {
}
this.raiseEvent( 'canvas-drag', {
tracker: tracker,
position: position,
delta: delta,
shift: shift
position: eventData.position,
delta: eventData.delta,
shift: eventData.shift
});
}
function onCanvasRelease( tracker, position, insideElementPress, insideElementRelease ) {
if ( insideElementPress && this.viewport ) {
function onCanvasRelease( tracker, eventData ) {
if ( eventData.insideElementPressed && this.viewport ) {
this.viewport.applyConstraints();
}
this.raiseEvent( 'canvas-release', {
tracker: tracker,
position: position,
insideElementPress: insideElementPress,
insideElementRelease: insideElementRelease
position: eventData.position,
insideElementPressed: eventData.insideElementPressed,
insideElementReleased: eventData.insideElementReleased
});
}
function onCanvasScroll( tracker, position, scroll, shift ) {
function onCanvasScroll( tracker, eventData ) {
var factor;
if ( this.viewport ) {
factor = Math.pow( this.zoomPerScroll, scroll );
factor = Math.pow( this.zoomPerScroll, eventData.scroll );
this.viewport.zoomBy(
factor,
this.viewport.pointFromPixel( position, true )
this.viewport.pointFromPixel( eventData.position, true )
);
this.viewport.applyConstraints();
}
this.raiseEvent( 'canvas-scroll', {
tracker: tracker,
position: position,
scroll: scroll,
shift: shift
position: eventData.position,
scroll: eventData.scroll,
shift: eventData.shift
});
//cancels event
return false;
}
function onContainerExit( tracker, position, buttonDownElement, buttonDownAny ) {
if ( !buttonDownElement ) {
function onContainerExit( tracker, eventData ) {
if ( !eventData.insideElementPressed ) {
THIS[ this.hash ].mouseInside = false;
if ( !THIS[ this.hash ].animating ) {
beginControlsAutoHide( this );
@ -1513,14 +1513,14 @@ function onContainerExit( tracker, position, buttonDownElement, buttonDownAny )
}
this.raiseEvent( 'container-exit', {
tracker: tracker,
position: position,
buttonDownElement: buttonDownElement,
buttonDownAny: buttonDownAny
position: eventData.position,
insideElementPressed: eventData.insideElementPressed,
buttonDownAny: eventData.buttonDownAny
});
}
function onContainerRelease( tracker, position, insideElementPress, insideElementRelease ) {
if ( !insideElementRelease ) {
function onContainerRelease( tracker, eventData ) {
if ( !eventData.insideElementReleased ) {
THIS[ this.hash ].mouseInside = false;
if ( !THIS[ this.hash ].animating ) {
beginControlsAutoHide( this );
@ -1528,20 +1528,20 @@ function onContainerRelease( tracker, position, insideElementPress, insideElemen
}
this.raiseEvent( 'container-release', {
tracker: tracker,
position: position,
insideElementPress: insideElementPress,
insideElementRelease: insideElementRelease
position: eventData.position,
insideElementPressed: eventData.insideElementPressed,
insideElementReleased: eventData.insideElementReleased
});
}
function onContainerEnter( tracker, position, buttonDownElement, buttonDownAny ) {
function onContainerEnter( tracker, eventData ) {
THIS[ this.hash ].mouseInside = true;
abortControlsAutoHide( this );
this.raiseEvent( 'container-enter', {
tracker: tracker,
position: position,
buttonDownElement: buttonDownElement,
buttonDownAny: buttonDownAny
position: eventData.position,
insideElementPressed: eventData.insideElementPressed,
buttonDownAny: eventData.buttonDownAny
});
}

View File

@ -61,19 +61,49 @@
} );
// ----------
asyncTest( 'canvas-drag canvas-release canvas-click', function () {
var dragCount = 10,
dragMovesHandled = 0,
releasesHandled = 0,
releasesExpected = 1;
asyncTest( 'MouseTracker, EventHandler canvas-drag canvas-release canvas-click', function () {
var $canvas = $( viewer.element ).find( '.openseadragon-canvas' ).not( '.navigator .openseadragon-canvas' ),
mouseTracker = null,
userData = { item1: 'Test user data', item2: Math.random() },
originalUserData = { item1: userData.item1, item2: userData.item2 },
dragCount = 10,
dragsHandledEventHandler = 0,
releasesHandledEventHandler = 0,
clicksHandledEventHandler = 0,
eventsHandledMouseTracker = 0,
originalEventsPassedMouseTracker = 0,
releasesExpected = 1,
clicksExpected = 1;
var openHandler = function ( eventSender, eventData ) {
viewer.removeHandler( 'open', openHandler );
var onOpen = function ( eventSender, eventData ) {
viewer.removeHandler( 'open', onOpen );
viewer.addHandler( 'canvas-drag', canvasDragHandler );
viewer.addHandler( 'canvas-release', canvasReleaseHandler );
viewer.addHandler( 'canvas-click', canvasClickHandler );
viewer.addHandler( 'canvas-drag', onEventHandlerDrag );
viewer.addHandler( 'canvas-release', onEventHandlerRelease );
viewer.addHandler( 'canvas-click', onEventHandlerClick );
mouseTracker = new OpenSeadragon.MouseTracker( {
element: $canvas[0],
userData: userData,
clickTimeThreshold: OpenSeadragon.DEFAULT_SETTINGS.clickTimeThreshold,
clickDistThreshold: OpenSeadragon.DEFAULT_SETTINGS.clickDistThreshold,
focusHandler: onMouseTrackerFocus,
blurHandler: onMouseTrackerBlur,
enterHandler: onMouseTrackerEnter,
pressHandler: onMouseTrackerPress,
moveHandler: onMouseTrackerMove,
dragHandler: onMouseTrackerDrag,
releaseHandler: onMouseTrackerRelease,
clickHandler: onMouseTrackerClick,
exitHandler: onMouseTrackerExit
} ).setTracking( true );
var event = {
clientX:1,
clientY:1
};
$canvas.simulate( 'focus', event );
Util.simulateViewerClickWithDrag( {
viewer: viewer,
widthFactor: 0.25,
@ -82,27 +112,80 @@
dragDx: 1,
dragDy: 1
} );
$canvas.simulate( 'blur', event );
};
var canvasDragHandler = function ( eventSender, eventData ) {
dragMovesHandled++;
var onEventHandlerDrag = function ( eventSender, eventData ) {
dragsHandledEventHandler++;
};
var canvasReleaseHandler = function ( eventSender, eventData ) {
releasesHandled++;
var onEventHandlerRelease = function ( eventSender, eventData ) {
releasesHandledEventHandler++;
};
var canvasClickHandler = function ( eventSender, eventData ) {
viewer.removeHandler( 'canvas-drag', canvasDragHandler );
viewer.removeHandler( 'canvas-release', canvasReleaseHandler );
viewer.removeHandler( 'canvas-click', canvasClickHandler );
equal( dragMovesHandled, dragCount, "'canvas-drag' event count matches 'mousemove' event count (" + dragCount + ")" );
equal( releasesHandled, releasesExpected, "'canvas-release' event count matches expected (" + releasesExpected + ")" );
var onEventHandlerClick = function ( eventSender, eventData ) {
clicksHandledEventHandler++;
};
var checkOriginalEventReceived = function ( eventData ) {
eventsHandledMouseTracker++;
if ( eventData && eventData.originalEvent ) {
originalEventsPassedMouseTracker++;
}
};
var onMouseTrackerFocus = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerBlur = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerEnter = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerPress = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerMove = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerDrag = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerRelease = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerClick = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
};
var onMouseTrackerExit = function ( tracker, eventData ) {
checkOriginalEventReceived( eventData );
mouseTracker.destroy();
viewer.removeHandler( 'canvas-drag', onEventHandlerDrag );
viewer.removeHandler( 'canvas-release', onEventHandlerRelease );
viewer.removeHandler( 'canvas-click', onEventHandlerClick );
equal( dragsHandledEventHandler, dragCount, "'canvas-drag' event count matches 'mousemove' event count (" + dragCount + ")" );
equal( releasesHandledEventHandler, releasesExpected, "'canvas-release' event count matches expected (" + releasesExpected + ")" );
equal( clicksHandledEventHandler, releasesExpected, "'canvas-click' event count matches expected (" + releasesExpected + ")" );
equal( originalEventsPassedMouseTracker, eventsHandledMouseTracker, "Original event received count matches expected (" + eventsHandledMouseTracker + ")" );
deepEqual( eventData.userData, originalUserData, 'MouseTracker userData was untouched' );
viewer.close();
start();
};
viewer.addHandler( 'open', openHandler );
viewer.addHandler( 'open', onOpen );
viewer.open( '/test/data/testpattern.dzi' );
} );

View File

@ -46,7 +46,8 @@
.simulate( "mousemove", event );
}
$canvas
.simulate( 'mouseup', event );
.simulate( 'mouseup', event )
.simulate( 'mouseout', event );
},
initializeTestDOM: function () {