Rename ol.interaction.condition to ol.events.condition

src/ol/events/condition.exports

@@ -0,0 +1,7 @@
+@exportSymbol ol.events.condition.altKeyOnly
+@exportSymbol ol.events.condition.altShiftKeysOnly
+@exportSymbol ol.events.condition.always
+@exportSymbol ol.events.condition.noModifierKeys
+@exportSymbol ol.events.condition.platformModifierKeyOnly
+@exportSymbol ol.events.condition.shiftKeyOnly
+@exportSymbol ol.events.condition.targetNotEditable

src/ol/events/condition.js

@@ -0,0 +1,117 @@
+goog.provide('ol.events.ConditionType');
+goog.provide('ol.events.condition');
+
+goog.require('goog.dom.TagName');
+goog.require('goog.events.EventType');
+goog.require('goog.functions');
+
+
+/**
+ * @typedef {function(ol.MapBrowserEvent): boolean}
+ */
+ol.events.ConditionType;
+
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True if only the alt key is pressed.
+ * @todo stability experimental
+ */
+ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
+  var browserEvent = mapBrowserEvent.browserEvent;
+  return (
+      browserEvent.altKey &&
+      !browserEvent.platformModifierKey &&
+      !browserEvent.shiftKey);
+};
+
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True if only the alt and shift keys are pressed.
+ * @todo stability experimental
+ */
+ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
+  var browserEvent = mapBrowserEvent.browserEvent;
+  return (
+      browserEvent.altKey &&
+      !browserEvent.platformModifierKey &&
+      browserEvent.shiftKey);
+};
+
+
+/**
+ * Always true.
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True.
+ * @todo stability experimental
+ */
+ol.events.condition.always = goog.functions.TRUE;
+
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True if the event is a click event.
+ * @todo stability experimental
+ */
+ol.events.condition.clickOnly = function(mapBrowserEvent) {
+  var browserEvent = mapBrowserEvent.browserEvent;
+  return browserEvent.type == goog.events.EventType.CLICK;
+};
+
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True only if there no modifier keys are pressed.
+ * @todo stability experimental
+ */
+ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
+  var browserEvent = mapBrowserEvent.browserEvent;
+  return (
+      !browserEvent.altKey &&
+      !browserEvent.platformModifierKey &&
+      !browserEvent.shiftKey);
+};
+
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True if only the platform modifier key is pressed.
+ * @todo stability experimental
+ */
+ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
+  var browserEvent = mapBrowserEvent.browserEvent;
+  return (
+      !browserEvent.altKey &&
+      browserEvent.platformModifierKey &&
+      !browserEvent.shiftKey);
+};
+
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True if only the shift key is pressed.
+ * @todo stability experimental
+ */
+ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
+  var browserEvent = mapBrowserEvent.browserEvent;
+  return (
+      !browserEvent.altKey &&
+      !browserEvent.platformModifierKey &&
+      browserEvent.shiftKey);
+};
+
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} True only if the target element is not editable.
+ * @todo stability experimental
+ */
+ol.events.condition.targetNotEditable = function(mapBrowserEvent) {
+  var browserEvent = mapBrowserEvent.browserEvent;
+  var tagName = browserEvent.target.tagName;
+  return (
+      tagName !== goog.dom.TagName.INPUT &&
+      tagName !== goog.dom.TagName.SELECT &&
+      tagName !== goog.dom.TagName.TEXTAREA);
+};

src/ol/events/condition.jsdoc

@@ -0,0 +1,3 @@
+/**
+ * @namespace ol.events.condition
+ */