ContextPadProvider.js 10 KB

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