ContextPadProvider.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  1. import {
  2. assign,
  3. forEach,
  4. isArray
  5. } from 'min-dash';
  6. import {
  7. is
  8. } from '../../util/ModelUtil';
  9. import {
  10. isExpanded,
  11. isEventSubProcess
  12. } from '../../util/DiUtil';
  13. import {
  14. isAny
  15. } from '../modeling/util/ModelingUtil';
  16. import {
  17. getChildLanes
  18. } from '../modeling/util/LaneUtil';
  19. import {
  20. hasPrimaryModifier
  21. } from 'diagram-js/lib/util/Mouse';
  22. /**
  23. * A provider for BPMN 2.0 elements context pad
  24. */
  25. export default function ContextPadProvider(
  26. config, injector, eventBus,
  27. contextPad, modeling, elementFactory,
  28. connect, create, popupMenu,
  29. canvas, rules, translate) {
  30. config = config || {};
  31. contextPad.registerProvider(this);
  32. this._contextPad = contextPad;
  33. this._modeling = modeling;
  34. this._elementFactory = elementFactory;
  35. this._connect = connect;
  36. this._create = create;
  37. this._popupMenu = popupMenu;
  38. this._canvas = canvas;
  39. this._rules = rules;
  40. this._translate = translate;
  41. if (config.autoPlace !== false) {
  42. this._autoPlace = injector.get('autoPlace', false);
  43. }
  44. eventBus.on('create.end', 250, function(event) {
  45. var context = event.context,
  46. shape = context.shape;
  47. if (!hasPrimaryModifier(event) || !contextPad.isOpen(shape)) {
  48. return;
  49. }
  50. var entries = contextPad.getEntries(shape);
  51. if (entries.replace) {
  52. entries.replace.action.click(event, shape);
  53. }
  54. });
  55. }
  56. ContextPadProvider.$inject = [
  57. 'config.contextPad',
  58. 'injector',
  59. 'eventBus',
  60. 'contextPad',
  61. 'modeling',
  62. 'elementFactory',
  63. 'connect',
  64. 'create',
  65. 'popupMenu',
  66. 'canvas',
  67. 'rules',
  68. 'translate'
  69. ];
  70. ContextPadProvider.prototype.getContextPadEntries = function(element) {
  71. var contextPad = this._contextPad,
  72. modeling = this._modeling,
  73. elementFactory = this._elementFactory,
  74. connect = this._connect,
  75. create = this._create,
  76. popupMenu = this._popupMenu,
  77. canvas = this._canvas,
  78. rules = this._rules,
  79. autoPlace = this._autoPlace,
  80. translate = this._translate;
  81. var actions = {};
  82. if (element.type === 'label') {
  83. return actions;
  84. }
  85. var businessObject = element.businessObject;
  86. function startConnect(event, element) {
  87. connect.start(event, element);
  88. }
  89. function removeElement(e) {
  90. modeling.removeElements([ element ]);
  91. }
  92. function getReplaceMenuPosition(element) {
  93. var Y_OFFSET = 5;
  94. var diagramContainer = canvas.getContainer(),
  95. pad = contextPad.getPad(element).html;
  96. var diagramRect = diagramContainer.getBoundingClientRect(),
  97. padRect = pad.getBoundingClientRect();
  98. var top = padRect.top - diagramRect.top;
  99. var left = padRect.left - diagramRect.left;
  100. var pos = {
  101. x: left,
  102. y: top + padRect.height + Y_OFFSET
  103. };
  104. return pos;
  105. }
  106. /**
  107. * Create an append action
  108. *
  109. * @param {string} type
  110. * @param {string} className
  111. * @param {string} [title]
  112. * @param {Object} [options]
  113. *
  114. * @return {Object} descriptor
  115. */
  116. function appendAction(type, className, title, options) {
  117. if (typeof title !== 'string') {
  118. options = title;
  119. title = translate('Append {type}', { type: type.replace(/^bpmn:/, '') });
  120. }
  121. function appendStart(event, element) {
  122. var shape = elementFactory.createShape(assign({ type: type }, options));
  123. create.start(event, shape, {
  124. source: element
  125. });
  126. }
  127. var append = autoPlace ? function(event, element) {
  128. var shape = elementFactory.createShape(assign({ type: type }, options));
  129. autoPlace.append(element, shape);
  130. } : appendStart;
  131. return {
  132. group: 'model',
  133. className: className,
  134. title: title,
  135. action: {
  136. dragstart: appendStart,
  137. click: append
  138. }
  139. };
  140. }
  141. function splitLaneHandler(count) {
  142. return function(event, element) {
  143. // actual split
  144. modeling.splitLane(element, count);
  145. // refresh context pad after split to
  146. // get rid of split icons
  147. contextPad.open(element, true);
  148. };
  149. }
  150. if (isAny(businessObject, [ 'bpmn:Lane', 'bpmn:Participant' ]) && isExpanded(businessObject)) {
  151. var childLanes = getChildLanes(element);
  152. assign(actions, {
  153. 'lane-insert-above': {
  154. group: 'lane-insert-above',
  155. className: 'bpmn-icon-lane-insert-above',
  156. title: translate('Add Lane above'),
  157. action: {
  158. click: function(event, element) {
  159. modeling.addLane(element, 'top');
  160. }
  161. }
  162. }
  163. });
  164. if (childLanes.length < 2) {
  165. if (element.height >= 120) {
  166. assign(actions, {
  167. 'lane-divide-two': {
  168. group: 'lane-divide',
  169. className: 'bpmn-icon-lane-divide-two',
  170. title: translate('Divide into two Lanes'),
  171. action: {
  172. click: splitLaneHandler(2)
  173. }
  174. }
  175. });
  176. }
  177. if (element.height >= 180) {
  178. assign(actions, {
  179. 'lane-divide-three': {
  180. group: 'lane-divide',
  181. className: 'bpmn-icon-lane-divide-three',
  182. title: translate('Divide into three Lanes'),
  183. action: {
  184. click: splitLaneHandler(3)
  185. }
  186. }
  187. });
  188. }
  189. }
  190. assign(actions, {
  191. 'lane-insert-below': {
  192. group: 'lane-insert-below',
  193. className: 'bpmn-icon-lane-insert-below',
  194. title: translate('Add Lane below'),
  195. action: {
  196. click: function(event, element) {
  197. modeling.addLane(element, 'bottom');
  198. }
  199. }
  200. }
  201. });
  202. }
  203. if (is(businessObject, 'bpmn:FlowNode')) {
  204. if (is(businessObject, 'bpmn:EventBasedGateway')) {
  205. assign(actions, {
  206. 'append.receive-task': appendAction(
  207. 'bpmn:ReceiveTask',
  208. 'bpmn-icon-receive-task',
  209. translate('Append ReceiveTask')
  210. ),
  211. 'append.message-intermediate-event': appendAction(
  212. 'bpmn:IntermediateCatchEvent',
  213. 'bpmn-icon-intermediate-event-catch-message',
  214. translate('Append MessageIntermediateCatchEvent'),
  215. { eventDefinitionType: 'bpmn:MessageEventDefinition' }
  216. ),
  217. 'append.timer-intermediate-event': appendAction(
  218. 'bpmn:IntermediateCatchEvent',
  219. 'bpmn-icon-intermediate-event-catch-timer',
  220. translate('Append TimerIntermediateCatchEvent'),
  221. { eventDefinitionType: 'bpmn:TimerEventDefinition' }
  222. ),
  223. 'append.condition-intermediate-event': appendAction(
  224. 'bpmn:IntermediateCatchEvent',
  225. 'bpmn-icon-intermediate-event-catch-condition',
  226. translate('Append ConditionIntermediateCatchEvent'),
  227. { eventDefinitionType: 'bpmn:ConditionalEventDefinition' }
  228. ),
  229. 'append.signal-intermediate-event': appendAction(
  230. 'bpmn:IntermediateCatchEvent',
  231. 'bpmn-icon-intermediate-event-catch-signal',
  232. translate('Append SignalIntermediateCatchEvent'),
  233. { eventDefinitionType: 'bpmn:SignalEventDefinition' }
  234. )
  235. });
  236. } else
  237. if (isEventType(businessObject, 'bpmn:BoundaryEvent', 'bpmn:CompensateEventDefinition')) {
  238. assign(actions, {
  239. 'append.compensation-activity':
  240. appendAction(
  241. 'bpmn:Task',
  242. 'bpmn-icon-task',
  243. translate('Append compensation activity'),
  244. {
  245. isForCompensation: true
  246. }
  247. )
  248. });
  249. } else
  250. if (!is(businessObject, 'bpmn:EndEvent') &&
  251. !businessObject.isForCompensation &&
  252. !isEventType(businessObject, 'bpmn:IntermediateThrowEvent', 'bpmn:LinkEventDefinition') &&
  253. !isEventSubProcess(businessObject)) {
  254. assign(actions, {
  255. 'append.end-event': appendAction(
  256. 'bpmn:EndEvent',
  257. 'bpmn-icon-end-event-none',
  258. translate('Append EndEvent')
  259. ),
  260. 'append.gateway': appendAction(
  261. 'bpmn:ExclusiveGateway',
  262. 'bpmn-icon-gateway-none',
  263. translate('Append Gateway')
  264. ),
  265. 'append.append-task': appendAction(
  266. 'bpmn:Task',
  267. 'bpmn-icon-task',
  268. translate('Append Task')
  269. ),
  270. 'append.intermediate-event': appendAction(
  271. 'bpmn:IntermediateThrowEvent',
  272. 'bpmn-icon-intermediate-event-none',
  273. translate('Append Intermediate/Boundary Event')
  274. )
  275. });
  276. }
  277. }
  278. if (!popupMenu.isEmpty(element, 'bpmn-replace')) {
  279. // Replace menu entry
  280. assign(actions, {
  281. 'replace': {
  282. group: 'edit',
  283. className: 'bpmn-icon-screw-wrench',
  284. title: translate('Change type'),
  285. action: {
  286. click: function(event, element) {
  287. var position = assign(getReplaceMenuPosition(element), {
  288. cursor: { x: event.x, y: event.y }
  289. });
  290. popupMenu.open(element, 'bpmn-replace', position);
  291. }
  292. }
  293. }
  294. });
  295. }
  296. if (isAny(businessObject, [
  297. 'bpmn:FlowNode',
  298. 'bpmn:InteractionNode',
  299. 'bpmn:DataObjectReference',
  300. 'bpmn:DataStoreReference'
  301. ])) {
  302. assign(actions, {
  303. 'append.text-annotation': appendAction('bpmn:TextAnnotation', 'bpmn-icon-text-annotation'),
  304. 'connect': {
  305. group: 'connect',
  306. className: 'bpmn-icon-connection-multi',
  307. title: translate('Connect using ' +
  308. (businessObject.isForCompensation ? '' : 'Sequence/MessageFlow or ') +
  309. 'Association'),
  310. action: {
  311. click: startConnect,
  312. dragstart: startConnect
  313. }
  314. }
  315. });
  316. }
  317. if (isAny(businessObject, [ 'bpmn:DataObjectReference', 'bpmn:DataStoreReference' ])) {
  318. assign(actions, {
  319. 'connect': {
  320. group: 'connect',
  321. className: 'bpmn-icon-connection-multi',
  322. title: translate('Connect using DataInputAssociation'),
  323. action: {
  324. click: startConnect,
  325. dragstart: startConnect
  326. }
  327. }
  328. });
  329. }
  330. // delete element entry, only show if allowed by rules
  331. var deleteAllowed = rules.allowed('elements.delete', { elements: [ element ] });
  332. if (isArray(deleteAllowed)) {
  333. // was the element returned as a deletion candidate?
  334. deleteAllowed = deleteAllowed[0] === element;
  335. }
  336. if (deleteAllowed) {
  337. assign(actions, {
  338. 'delete': {
  339. group: 'edit',
  340. className: 'bpmn-icon-trash',
  341. title: translate('Remove'),
  342. action: {
  343. click: removeElement
  344. }
  345. }
  346. });
  347. }
  348. return actions;
  349. };
  350. // helpers /////////
  351. function isEventType(eventBo, type, definition) {
  352. var isType = eventBo.$instanceOf(type);
  353. var isDefinition = false;
  354. var definitions = eventBo.eventDefinitions || [];
  355. forEach(definitions, function(def) {
  356. if (def.$type === definition) {
  357. isDefinition = true;
  358. }
  359. });
  360. return isType && isDefinition;
  361. }