all files / lib/features/interaction-events/ InteractionEvents.js

91.43% Statements 64/70
70.83% Branches 17/24
100% Functions 18/18
91.43% Lines 64/70
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343                                                                                          855×                             16×         12×           12×       12×           12×             855×     5979×         16×         16×     855×                   855×                                                 855×           5990× 13×     5990×       5990×         5979×   5979×       5979×       855× 5985×         854× 5978×       855× 854×     855× 855×       855× 2772× 2772×     2772× 448×   2324× 2324×               2772×   2772×           855×   822× 822× 822×   822×           855×   233× 233× 233×   233×           855×   855×   855×   855× 855×                                                                                                                                                                            
import {
  forEach
} from 'min-dash';
 
import {
  delegate as domDelegate,
  query as domQuery
} from 'min-dom';
 
import { isPrimaryButton } from '../../util/Mouse';
 
import {
  append as svgAppend,
  attr as svgAttr,
  create as svgCreate
} from 'tiny-svg';
 
import {
  createLine,
  updateLine
} from '../../util/RenderUtil';
 
function allowAll(e) { return true; }
 
var LOW_PRIORITY = 500;
 
/**
 * A plugin that provides interaction events for diagram elements.
 *
 * It emits the following events:
 *
 *   * element.hover
 *   * element.out
 *   * element.click
 *   * element.dblclick
 *   * element.mousedown
 *   * element.contextmenu
 *
 * Each event is a tuple { element, gfx, originalEvent }.
 *
 * Canceling the event via Event#preventDefault()
 * prevents the original DOM operation.
 *
 * @param {EventBus} eventBus
 */
export default function InteractionEvents(eventBus, elementRegistry, styles) {
 
  var HIT_STYLE = styles.cls('djs-hit', [ 'no-fill', 'no-border' ], {
    stroke: 'white',
    strokeWidth: 15
  });
 
  /**
   * Fire an interaction event.
   *
   * @param {String} type local event name, e.g. element.click.
   * @param {DOMEvent} event native event
   * @param {djs.model.Base} [element] the diagram element to emit the event on;
   *                                   defaults to the event target
   */
  function fire(type, event, element) {
 
    if (isIgnored(type, event)) {
      return;
    }
 
    var target, gfx, returnValue;
 
    if (!element) {
      target = event.delegateTarget || event.target;
 
      Eif (target) {
        gfx = target;
        element = elementRegistry.get(gfx);
      }
    } else {
      gfx = elementRegistry.getGraphics(element);
    }
 
    Iif (!gfx || !element) {
      return;
    }
 
    returnValue = eventBus.fire(type, {
      element: element,
      gfx: gfx,
      originalEvent: event
    });
 
    Iif (returnValue === false) {
      event.stopPropagation();
      event.preventDefault();
    }
  }
 
  // TODO(nikku): document this
  var handlers = {};
 
  function mouseHandler(localEventName) {
    return handlers[localEventName];
  }
 
  function isIgnored(localEventName, event) {
 
    var filter = ignoredFilters[localEventName] || isPrimaryButton;
 
    // only react on left mouse button interactions
    // except for interaction events that are enabled
    // for secundary mouse button
    return !filter(event);
  }
 
  var bindings = {
    mouseover: 'element.hover',
    mouseout: 'element.out',
    click: 'element.click',
    dblclick: 'element.dblclick',
    mousedown: 'element.mousedown',
    mouseup: 'element.mouseup',
    contextmenu: 'element.contextmenu'
  };
 
  var ignoredFilters = {
    'element.contextmenu': allowAll
  };
 
 
  // manual event trigger
 
  /**
   * Trigger an interaction event (based on a native dom event)
   * on the target shape or connection.
   *
   * @param {String} eventName the name of the triggered DOM event
   * @param {MouseEvent} event
   * @param {djs.model.Base} targetElement
   */
  function triggerMouseEvent(eventName, event, targetElement) {
 
    // i.e. element.mousedown...
    var localEventName = bindings[eventName];
 
    Iif (!localEventName) {
      throw new Error('unmapped DOM event name <' + eventName + '>');
    }
 
    return fire(localEventName, event, targetElement);
  }
 
 
  var elementSelector = 'svg, .djs-element';
 
  // event registration
 
  function registerEvent(node, event, localEvent, ignoredFilter) {
 
    var handler = handlers[localEvent] = function(event) {
      fire(localEvent, event);
    };
 
    Iif (ignoredFilter) {
      ignoredFilters[localEvent] = ignoredFilter;
    }
 
    handler.$delegate = domDelegate.bind(node, elementSelector, event, handler);
  }
 
  function unregisterEvent(node, event, localEvent) {
 
    var handler = mouseHandler(localEvent);
 
    Iif (!handler) {
      return;
    }
 
    domDelegate.unbind(node, event, handler.$delegate);
  }
 
  function registerEvents(svg) {
    forEach(bindings, function(val, key) {
      registerEvent(svg, key, val);
    });
  }
 
  function unregisterEvents(svg) {
    forEach(bindings, function(val, key) {
      unregisterEvent(svg, key, val);
    });
  }
 
  eventBus.on('canvas.destroy', function(event) {
    unregisterEvents(event.svg);
  });
 
  eventBus.on('canvas.init', function(event) {
    registerEvents(event.svg);
  });
 
 
  eventBus.on([ 'shape.added', 'connection.added' ], function(event) {
    var element = event.element,
        gfx = event.gfx,
        hit;
 
    if (element.waypoints) {
      hit = createLine(element.waypoints);
    } else {
      hit = svgCreate('rect');
      svgAttr(hit, {
        x: 0,
        y: 0,
        width: element.width,
        height: element.height
      });
    }
 
    svgAttr(hit, HIT_STYLE);
 
    svgAppend(gfx, hit);
  });
 
  // Update djs-hit on change.
  // A low priortity is necessary, because djs-hit of labels has to be updated
  // after the label bounds have been updated in the renderer.
  eventBus.on('shape.changed', LOW_PRIORITY, function(event) {
 
    var element = event.element,
        gfx = event.gfx,
        hit = domQuery('.djs-hit', gfx);
 
    svgAttr(hit, {
      width: element.width,
      height: element.height
    });
  });
 
  eventBus.on('connection.changed', function(event) {
 
    var element = event.element,
        gfx = event.gfx,
        hit = domQuery('.djs-hit', gfx);
 
    updateLine(hit, element.waypoints);
  });
 
 
  // API
 
  this.fire = fire;
 
  this.triggerMouseEvent = triggerMouseEvent;
 
  this.mouseHandler = mouseHandler;
 
  this.registerEvent = registerEvent;
  this.unregisterEvent = unregisterEvent;
}
 
 
InteractionEvents.$inject = [
  'eventBus',
  'elementRegistry',
  'styles'
];
 
 
/**
 * An event indicating that the mouse hovered over an element
 *
 * @event element.hover
 *
 * @type {Object}
 * @property {djs.model.Base} element
 * @property {SVGElement} gfx
 * @property {Event} originalEvent
 */
 
/**
 * An event indicating that the mouse has left an element
 *
 * @event element.out
 *
 * @type {Object}
 * @property {djs.model.Base} element
 * @property {SVGElement} gfx
 * @property {Event} originalEvent
 */
 
/**
 * An event indicating that the mouse has clicked an element
 *
 * @event element.click
 *
 * @type {Object}
 * @property {djs.model.Base} element
 * @property {SVGElement} gfx
 * @property {Event} originalEvent
 */
 
/**
 * An event indicating that the mouse has double clicked an element
 *
 * @event element.dblclick
 *
 * @type {Object}
 * @property {djs.model.Base} element
 * @property {SVGElement} gfx
 * @property {Event} originalEvent
 */
 
/**
 * An event indicating that the mouse has gone down on an element.
 *
 * @event element.mousedown
 *
 * @type {Object}
 * @property {djs.model.Base} element
 * @property {SVGElement} gfx
 * @property {Event} originalEvent
 */
 
/**
 * An event indicating that the mouse has gone up on an element.
 *
 * @event element.mouseup
 *
 * @type {Object}
 * @property {djs.model.Base} element
 * @property {SVGElement} gfx
 * @property {Event} originalEvent
 */
 
/**
 * An event indicating that the context menu action is triggered
 * via mouse or touch controls.
 *
 * @event element.contextmenu
 *
 * @type {Object}
 * @property {djs.model.Base} element
 * @property {SVGElement} gfx
 * @property {Event} originalEvent
 */