InteractionEvents.js 7.2 KB

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