693e6d07e3
hover callbacks; r=ahocevar (Closes #1655) This means that On the SelectFeature control hover can no longer be set on the SelectFeature control after the control has been initialized: must be passed at initialize time. Example has been updated. git-svn-id: http://svn.openlayers.org/trunk/openlayers@7682 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
334 lines
10 KiB
JavaScript
334 lines
10 KiB
JavaScript
/* Copyright (c) 2006-2008 MetaCarta, Inc., published under the Clear BSD
|
|
* license. See http://svn.openlayers.org/trunk/openlayers/license.txt for the
|
|
* full text of the license. */
|
|
|
|
|
|
/**
|
|
* @requires OpenLayers/Handler.js
|
|
*/
|
|
|
|
/**
|
|
* Class: OpenLayers.Handler.Feature
|
|
* Handler to respond to mouse events related to a drawn feature. Callbacks
|
|
* with the following keys will be notified of the following events
|
|
* associated with features: click, clickout, over, out, and dblclick.
|
|
*
|
|
* This handler stops event propagation for mousedown and mouseup if those
|
|
* browser events target features that can be selected.
|
|
*/
|
|
OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
|
|
|
|
/**
|
|
* Property: EVENTMAP
|
|
* {Object} A object mapping the browser events to objects with callback
|
|
* keys for in and out.
|
|
*/
|
|
EVENTMAP: {
|
|
'click': {'in': 'click', 'out': 'clickout'},
|
|
'mousemove': {'in': 'over', 'out': 'out'},
|
|
'dblclick': {'in': 'dblclick', 'out': null},
|
|
'mousedown': {'in': null, 'out': null},
|
|
'mouseup': {'in': null, 'out': null}
|
|
},
|
|
|
|
/**
|
|
* Property: feature
|
|
* {<OpenLayers.Feature.Vector>} The last feature that was hovered.
|
|
*/
|
|
feature: null,
|
|
|
|
/**
|
|
* Property: lastFeature
|
|
* {<OpenLayers.Feature.Vector>} The last feature that was handled.
|
|
*/
|
|
lastFeature: null,
|
|
|
|
/**
|
|
* Property: down
|
|
* {<OpenLayers.Pixel>} The location of the last mousedown.
|
|
*/
|
|
down: null,
|
|
|
|
/**
|
|
* Property: up
|
|
* {<OpenLayers.Pixel>} The location of the last mouseup.
|
|
*/
|
|
up: null,
|
|
|
|
/**
|
|
* Property: clickoutTolerance
|
|
* {Number} The number of pixels the mouse can move during a click that
|
|
* still constitutes a click out. When dragging the map, clicks should
|
|
* not trigger the clickout property unless this tolerance is reached.
|
|
* Default is 4.
|
|
*/
|
|
clickoutTolerance: 4,
|
|
|
|
/**
|
|
* Property: geometryTypes
|
|
* To restrict dragging to a limited set of geometry types, send a list
|
|
* of strings corresponding to the geometry class names.
|
|
*
|
|
* @type Array(String)
|
|
*/
|
|
geometryTypes: null,
|
|
|
|
/**
|
|
* Property: stopClick
|
|
* {Boolean} If stopClick is set to true, handled clicks do not
|
|
* propagate to other click listeners. Otherwise, handled clicks
|
|
* do propagate. Unhandled clicks always propagate, whatever the
|
|
* value of stopClick. Defaults to true.
|
|
*/
|
|
stopClick: true,
|
|
|
|
/**
|
|
* Property: stopDown
|
|
* {Boolean} If stopDown is set to true, handled mousedowns do not
|
|
* propagate to other mousedown listeners. Otherwise, handled
|
|
* mousedowns do propagate. Unhandled mousedowns always propagate,
|
|
* whatever the value of stopDown. Defaults to true.
|
|
*/
|
|
stopDown: true,
|
|
|
|
/**
|
|
* Property: stopUp
|
|
* {Boolean} If stopUp is set to true, handled mouseups do not
|
|
* propagate to other mouseup listeners. Otherwise, handled mouseups
|
|
* do propagate. Unhandled mouseups always propagate, whatever the
|
|
* value of stopUp. Defaults to true.
|
|
*/
|
|
stopUp: true,
|
|
|
|
/**
|
|
* Property: layerIndex
|
|
* {Int}
|
|
*/
|
|
layerIndex: null,
|
|
|
|
/**
|
|
* Constructor: OpenLayers.Handler.Feature
|
|
*
|
|
* Parameters:
|
|
* control - {<OpenLayers.Control>}
|
|
* layers - {Array(<OpenLayers.Layer.Vector>)}
|
|
* callbacks - {Object} An object with a 'over' property whos value is
|
|
* a function to be called when the mouse is over a feature. The
|
|
* callback should expect to recieve a single argument, the feature.
|
|
* options - {Object}
|
|
*/
|
|
initialize: function(control, layer, callbacks, options) {
|
|
OpenLayers.Handler.prototype.initialize.apply(this, [control, callbacks, options]);
|
|
this.layer = layer;
|
|
},
|
|
|
|
|
|
/**
|
|
* Method: mousedown
|
|
* Handle mouse down. Stop propagation if a feature is targeted by this
|
|
* event (stops map dragging during feature selection).
|
|
*
|
|
* Parameters:
|
|
* evt - {Event}
|
|
*/
|
|
mousedown: function(evt) {
|
|
this.down = evt.xy;
|
|
return this.handle(evt) ? !this.stopDown : true;
|
|
},
|
|
|
|
/**
|
|
* Method: mouseup
|
|
* Handle mouse up. Stop propagation if a feature is targeted by this
|
|
* event.
|
|
*
|
|
* Parameters:
|
|
* evt - {Event}
|
|
*/
|
|
mouseup: function(evt) {
|
|
this.up = evt.xy;
|
|
return this.handle(evt) ? !this.stopUp : true;
|
|
},
|
|
|
|
/**
|
|
* Method: click
|
|
* Handle click. Call the "click" callback if click on a feature,
|
|
* or the "clickout" callback if click outside any feature.
|
|
*
|
|
* Parameters:
|
|
* evt - {Event}
|
|
*
|
|
* Returns:
|
|
* {Boolean}
|
|
*/
|
|
click: function(evt) {
|
|
return this.handle(evt) ? !this.stopClick : true;
|
|
},
|
|
|
|
/**
|
|
* Method: mousemove
|
|
* Handle mouse moves. Call the "over" callback if moving in to a feature,
|
|
* or the "out" callback if moving out of a feature.
|
|
*
|
|
* Parameters:
|
|
* evt - {Event}
|
|
*
|
|
* Returns:
|
|
* {Boolean}
|
|
*/
|
|
mousemove: function(evt) {
|
|
if (!this.callbacks['over'] && !this.callbacks['out']) {
|
|
return false;
|
|
}
|
|
this.handle(evt);
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Method: dblclick
|
|
* Handle dblclick. Call the "dblclick" callback if dblclick on a feature.
|
|
*
|
|
* Parameters:
|
|
* evt - {Event}
|
|
*
|
|
* Returns:
|
|
* {Boolean}
|
|
*/
|
|
dblclick: function(evt) {
|
|
return !this.handle(evt);
|
|
},
|
|
|
|
/**
|
|
* Method: geometryTypeMatches
|
|
* Return true if the geometry type of the passed feature matches
|
|
* one of the geometry types in the geometryTypes array.
|
|
*
|
|
* Parameters:
|
|
* feature - {<OpenLayers.Vector.Feature>}
|
|
*
|
|
* Returns:
|
|
* {Boolean}
|
|
*/
|
|
geometryTypeMatches: function(feature) {
|
|
return this.geometryTypes == null ||
|
|
OpenLayers.Util.indexOf(this.geometryTypes,
|
|
feature.geometry.CLASS_NAME) > -1;
|
|
},
|
|
|
|
/**
|
|
* Method: handle
|
|
*
|
|
* Parameters:
|
|
* evt - {Event}
|
|
*
|
|
* Returns:
|
|
* {Boolean} The event occurred over a relevant feature.
|
|
*/
|
|
handle: function(evt) {
|
|
var type = evt.type;
|
|
var handled = false;
|
|
var previouslyIn = !!(this.feature); // previously in a feature
|
|
var click = (type == "click" || type == "dblclick");
|
|
this.feature = this.layer.getFeatureFromEvent(evt);
|
|
if(this.feature) {
|
|
var inNew = (this.feature != this.lastFeature);
|
|
if(this.geometryTypeMatches(this.feature)) {
|
|
// in to a feature
|
|
if(previouslyIn && inNew) {
|
|
// out of last feature and in to another
|
|
this.triggerCallback(type, 'out', [this.lastFeature]);
|
|
this.triggerCallback(type, 'in', [this.feature]);
|
|
} else if(!previouslyIn || click) {
|
|
// in feature for the first time
|
|
this.triggerCallback(type, 'in', [this.feature]);
|
|
}
|
|
this.lastFeature = this.feature;
|
|
handled = true;
|
|
} else {
|
|
// not in to a feature
|
|
if(previouslyIn && inNew || (click && this.lastFeature)) {
|
|
// out of last feature for the first time
|
|
this.triggerCallback(type, 'out', [this.lastFeature]);
|
|
}
|
|
// next time the mouse goes in a feature whose geometry type
|
|
// doesn't match we don't want to call the 'out' callback
|
|
// again, so let's set this.feature to null so that
|
|
// previouslyIn will evaluate to false the next time
|
|
// we enter handle. Yes, a bit hackish...
|
|
this.feature = null;
|
|
}
|
|
} else {
|
|
if(previouslyIn || (click && this.lastFeature)) {
|
|
this.triggerCallback(type, 'out', [this.lastFeature]);
|
|
}
|
|
}
|
|
return handled;
|
|
},
|
|
|
|
/**
|
|
* Method: triggerCallback
|
|
* Call the callback keyed in the event map with the supplied arguments.
|
|
* For click out, the <clickoutTolerance> is checked first.
|
|
*
|
|
* Parameters:
|
|
* type - {String}
|
|
*/
|
|
triggerCallback: function(type, mode, args) {
|
|
var key = this.EVENTMAP[type][mode];
|
|
if(key) {
|
|
if(type == 'click' && mode == 'out' && this.up && this.down) {
|
|
// for clickout, only trigger callback if tolerance is met
|
|
var dpx = Math.sqrt(
|
|
Math.pow(this.up.x - this.down.x, 2) +
|
|
Math.pow(this.up.y - this.down.y, 2)
|
|
);
|
|
if(dpx <= this.clickoutTolerance) {
|
|
this.callback(key, args);
|
|
}
|
|
} else {
|
|
this.callback(key, args);
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Method: activate
|
|
* Turn on the handler. Returns false if the handler was already active.
|
|
*
|
|
* Returns:
|
|
* {Boolean}
|
|
*/
|
|
activate: function() {
|
|
var activated = false;
|
|
if(OpenLayers.Handler.prototype.activate.apply(this, arguments)) {
|
|
this.layerIndex = this.layer.div.style.zIndex;
|
|
this.layer.div.style.zIndex = this.map.Z_INDEX_BASE['Popup'] - 1;
|
|
activated = true;
|
|
}
|
|
return activated;
|
|
},
|
|
|
|
/**
|
|
* Method: activate
|
|
* Turn of the handler. Returns false if the handler was already active.
|
|
*
|
|
* Returns:
|
|
* {Boolean}
|
|
*/
|
|
deactivate: function() {
|
|
var deactivated = false;
|
|
if(OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) {
|
|
if (this.layer && this.layer.div) {
|
|
this.layer.div.style.zIndex = this.layerIndex;
|
|
}
|
|
this.feature = null;
|
|
this.lastFeature = null;
|
|
this.down = null;
|
|
this.up = null;
|
|
deactivated = true;
|
|
}
|
|
return deactivated;
|
|
},
|
|
|
|
CLASS_NAME: "OpenLayers.Handler.Feature"
|
|
});
|