Files
openlayers/src/ol/mapbrowserevent.js
2013-01-12 23:12:15 +01:00

309 lines
7.9 KiB
JavaScript

goog.provide('ol.MapBrowserEvent');
goog.provide('ol.MapBrowserEvent.EventType');
goog.provide('ol.MapBrowserEventHandler');
goog.require('goog.asserts');
goog.require('goog.events.BrowserEvent');
goog.require('goog.events.EventTarget');
goog.require('goog.events.EventType');
goog.require('goog.style');
goog.require('ol.BrowserFeature');
goog.require('ol.Coordinate');
goog.require('ol.MapEvent');
goog.require('ol.Pixel');
/**
* @constructor
* @extends {ol.MapEvent}
* @param {string} type Event type.
* @param {ol.Map} map Map.
* @param {goog.events.BrowserEvent} browserEvent Browser event.
*/
ol.MapBrowserEvent = function(type, map, browserEvent) {
goog.base(this, type, map);
/**
* @type {goog.events.BrowserEvent}
*/
this.browserEvent = browserEvent;
/**
* @private
* @type {ol.Coordinate}
*/
this.coordinate_ = null;
/**
* @private
* @type {ol.Pixel}
*/
this.pixel_ = null;
};
goog.inherits(ol.MapBrowserEvent, ol.MapEvent);
/**
* @return {ol.Coordinate} Coordinate.
*/
ol.MapBrowserEvent.prototype.getCoordinate = function() {
if (goog.isNull(this.coordinate_)) {
this.coordinate_ = this.map.getCoordinateFromPixel(this.getPixel());
}
return this.coordinate_;
};
/**
* Get pixel offset of the event from the top-left corner of the map viewport.
* @return {ol.Pixel} Pixel offset.
*/
ol.MapBrowserEvent.prototype.getPixel = function() {
if (goog.isNull(this.pixel_)) {
var eventPosition = goog.style.getRelativePosition(
this.browserEvent, this.map.getViewport());
this.pixel_ = new ol.Pixel(eventPosition.x, eventPosition.y);
}
return this.pixel_;
};
/**
* @return {boolean} Do we have a left click?
*/
ol.MapBrowserEvent.prototype.isMouseActionButton = function() {
// always assume a left-click on touch devices
return ol.BrowserFeature.HAS_TOUCH ||
this.browserEvent.isMouseActionButton();
};
/**
* @param {ol.Map} map The map with the viewport to listen to events on.
* @constructor
* @extends {goog.events.EventTarget}
*/
ol.MapBrowserEventHandler = function(map) {
/**
* This is the element that we will listen to the real events on.
* @type {ol.Map}
* @private
*/
this.map_ = map;
/**
* @type {Object}
* @private
*/
this.previous_ = null;
/**
* @type {boolean}
* @private
*/
this.dragged_ = false;
/**
* Timestamp for the first click of a double click. Will be set back to 0
* as soon as a double click is detected.
* @type {number}
* @private
*/
this.timestamp_ = 0;
/**
* @type {Array.<number>}
* @private
*/
this.dragListenerKeys_ = null;
/**
* @type {goog.events.BrowserEvent}
* @private
*/
this.down_ = null;
var element = this.map_.getViewport();
if (!ol.BrowserFeature.HAS_TOUCH) {
goog.events.listen(element,
[goog.events.EventType.CLICK, goog.events.EventType.DBLCLICK],
this.click_, false, this);
}
goog.events.listen(element,
ol.BrowserFeature.HAS_TOUCH ?
goog.events.EventType.TOUCHSTART :
goog.events.EventType.MOUSEDOWN,
this.handleDown_, false, this);
};
goog.inherits(ol.MapBrowserEventHandler, goog.events.EventTarget);
/**
* @param {goog.events.BrowserEvent} browserEvent Browser event.
* @private
*/
ol.MapBrowserEventHandler.prototype.touchEnableBrowserEvent_ =
function(browserEvent) {
if (ol.BrowserFeature.HAS_TOUCH) {
goog.asserts.assert(browserEvent instanceof goog.events.BrowserEvent);
var nativeEvent = browserEvent.getBrowserEvent();
if (nativeEvent.touches && nativeEvent.touches.length) {
var nativeTouch = nativeEvent.touches[0];
browserEvent.clientX = nativeTouch.clientX;
browserEvent.clientY = nativeTouch.clientY;
}
}
};
/**
* @param {goog.events.BrowserEvent} browserEvent Browser event.
* @private
*/
ol.MapBrowserEventHandler.prototype.click_ = function(browserEvent) {
if (!this.dragged_) {
var newEvent;
if (browserEvent.type !== goog.events.EventType.DBLCLICK) {
newEvent = new ol.MapBrowserEvent(
ol.MapBrowserEvent.EventType.CLICK, this.map_, browserEvent);
this.dispatchEvent(newEvent);
}
if (!this.timestamp_) {
newEvent = new ol.MapBrowserEvent(
ol.MapBrowserEvent.EventType.DBLCLICK, this.map_, browserEvent);
this.dispatchEvent(newEvent);
}
}
};
/**
* @param {goog.events.BrowserEvent} browserEvent Browser event.
* @private
*/
ol.MapBrowserEventHandler.prototype.handleUp_ = function(browserEvent) {
if (this.previous_) {
if (!this.dragged_) {
var now = new Date().getTime();
if (!this.timestamp_ || now - this.timestamp_ > 250) {
this.timestamp_ = now;
} else {
this.timestamp_ = 0;
}
if (ol.BrowserFeature.HAS_TOUCH) {
this.click_(this.down_);
}
}
this.down_ = null;
goog.array.forEach(this.dragListenerKeys_, goog.events.unlistenByKey);
this.dragListenerKeys_ = null;
this.previous_ = null;
if (this.dragged_) {
var newEvent = new ol.MapBrowserEvent(
ol.MapBrowserEvent.EventType.DRAGEND, this.map_, browserEvent);
this.dispatchEvent(newEvent);
}
}
};
/**
* @param {goog.events.BrowserEvent} browserEvent Browser event.
* @private
*/
ol.MapBrowserEventHandler.prototype.handleDown_ = function(browserEvent) {
if (!this.previous_) {
this.touchEnableBrowserEvent_(browserEvent);
this.down_ = browserEvent;
this.previous_ = {
clientX: browserEvent.clientX,
clientY: browserEvent.clientY
};
this.dragged_ = false;
this.dragListenerKeys_ = [
goog.events.listen(document,
ol.BrowserFeature.HAS_TOUCH ?
goog.events.EventType.TOUCHMOVE :
goog.events.EventType.MOUSEMOVE,
this.drag_, false, this),
goog.events.listen(document,
ol.BrowserFeature.HAS_TOUCH ?
goog.events.EventType.TOUCHEND :
goog.events.EventType.MOUSEUP,
this.handleUp_, false, this)
];
if (browserEvent.type === goog.events.EventType.MOUSEDOWN) {
// prevent browser image dragging on pointer devices
browserEvent.preventDefault();
}
}
};
/**
* @param {goog.events.BrowserEvent} browserEvent Browser event.
* @private
*/
ol.MapBrowserEventHandler.prototype.drag_ = function(browserEvent) {
var newEvent;
if (!this.dragged_) {
this.dragged_ = true;
newEvent = new ol.MapBrowserEvent(
ol.MapBrowserEvent.EventType.DRAGSTART, this.map_, this.down_);
this.dispatchEvent(newEvent);
}
this.touchEnableBrowserEvent_(browserEvent);
this.previous_ = {
clientX: browserEvent.clientX,
clientY: browserEvent.clientY
};
// prevent viewport dragging on touch devices
browserEvent.preventDefault();
newEvent = new ol.MapBrowserEvent(
ol.MapBrowserEvent.EventType.DRAG, this.map_, browserEvent);
this.dispatchEvent(newEvent);
};
/**
* FIXME empty description for jsdoc
*/
ol.MapBrowserEventHandler.prototype.disposeInternal = function() {
var element = this.map_.getViewport();
goog.events.unlisten(element,
ol.BrowserFeature.HAS_TOUCH ?
goog.events.EventType.TOUCHSTART :
goog.events.EventType.MOUSEDOWN,
this.handleDown_, false, this);
goog.events.unlisten(element,
ol.BrowserFeature.HAS_TOUCH ?
goog.events.EventType.TOUCHEND :
goog.events.EventType.MOUSEUP,
this.handleUp_, false, this);
goog.events.unlisten(element,
goog.events.EventType.CLICK, this.click_, false, this);
if (!goog.isNull(this.dragListenerKeys_)) {
goog.array.forEach(this.dragListenerKeys_, goog.events.unlistenByKey);
this.dragListenerKeys_ = null;
}
goog.base(this, 'disposeInternal');
};
/**
* Constants for event names.
* @enum {string}
*/
ol.MapBrowserEvent.EventType = {
CLICK: goog.events.EventType.CLICK,
DBLCLICK: goog.events.EventType.DBLCLICK,
DRAGSTART: 'dragstart',
DRAG: 'drag',
DRAGEND: 'dragend'
};