UpdatePropertiesHandler.js 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. import {
  2. reduce,
  3. keys,
  4. forEach,
  5. assign
  6. } from 'min-dash';
  7. import {
  8. getBusinessObject,
  9. getDi
  10. } from '../../../util/ModelUtil';
  11. /**
  12. * @typedef {import('diagram-js/lib/command/CommandHandler').default} CommandHandler
  13. * @typedef {import('diagram-js/lib/command/CommandStack').CommandContext} CommandContext
  14. *
  15. * @typedef {import('diagram-js/lib/core/ElementRegistry').default} ElementRegistry
  16. * @typedef {import('../../../model/Types').Moddle} Moddle
  17. * @typedef {import('diagram-js/lib/i18n/translate/translate').default} Translate
  18. * @typedef {import('../Modeling').default} Modeling
  19. * @typedef {import('../../../draw/TextRenderer').default} TextRenderer
  20. *
  21. * @typedef {import('../../../model/Types').Element} Element
  22. */
  23. var DEFAULT_FLOW = 'default',
  24. ID = 'id',
  25. DI = 'di';
  26. var NULL_DIMENSIONS = {
  27. width: 0,
  28. height: 0
  29. };
  30. /**
  31. * A handler that implements a BPMN 2.0 property update.
  32. *
  33. * This should be used to set simple properties on elements with
  34. * an underlying BPMN business object.
  35. *
  36. * Use respective diagram-js provided handlers if you would
  37. * like to perform automated modeling.
  38. *
  39. * @implements {CommandHandler}
  40. *
  41. * @param {ElementRegistry} elementRegistry
  42. * @param {Moddle} moddle
  43. * @param {Translate} translate
  44. * @param {Modeling} modeling
  45. * @param {TextRenderer} textRenderer
  46. */
  47. export default function UpdatePropertiesHandler(
  48. elementRegistry, moddle, translate,
  49. modeling, textRenderer) {
  50. this._elementRegistry = elementRegistry;
  51. this._moddle = moddle;
  52. this._translate = translate;
  53. this._modeling = modeling;
  54. this._textRenderer = textRenderer;
  55. }
  56. UpdatePropertiesHandler.$inject = [
  57. 'elementRegistry',
  58. 'moddle',
  59. 'translate',
  60. 'modeling',
  61. 'textRenderer'
  62. ];
  63. // api //////////////////////
  64. /**
  65. * Update a BPMN element's properties.
  66. *
  67. * @param { {
  68. * element: Element;
  69. * properties: Record<string, any>;
  70. * } & CommandContext } context
  71. *
  72. * @return {Element[]}
  73. */
  74. UpdatePropertiesHandler.prototype.execute = function(context) {
  75. var element = context.element,
  76. changed = [ element ],
  77. translate = this._translate;
  78. if (!element) {
  79. throw new Error(translate('element required'));
  80. }
  81. var elementRegistry = this._elementRegistry,
  82. ids = this._moddle.ids;
  83. var businessObject = element.businessObject,
  84. properties = unwrapBusinessObjects(context.properties),
  85. oldProperties = context.oldProperties || getProperties(element, properties);
  86. if (isIdChange(properties, businessObject)) {
  87. ids.unclaim(businessObject[ID]);
  88. elementRegistry.updateId(element, properties[ID]);
  89. ids.claim(properties[ID], businessObject);
  90. }
  91. // correctly indicate visual changes on default flow updates
  92. if (DEFAULT_FLOW in properties) {
  93. if (properties[DEFAULT_FLOW]) {
  94. changed.push(elementRegistry.get(properties[DEFAULT_FLOW].id));
  95. }
  96. if (businessObject[DEFAULT_FLOW]) {
  97. changed.push(elementRegistry.get(businessObject[DEFAULT_FLOW].id));
  98. }
  99. }
  100. // update properties
  101. setProperties(element, properties);
  102. // store old values
  103. context.oldProperties = oldProperties;
  104. context.changed = changed;
  105. // indicate changed on objects affected by the update
  106. return changed;
  107. };
  108. UpdatePropertiesHandler.prototype.postExecute = function(context) {
  109. var element = context.element,
  110. label = element.label;
  111. var text = label && getBusinessObject(label).name;
  112. if (!text) {
  113. return;
  114. }
  115. // get layouted text bounds and resize external
  116. // external label accordingly
  117. var newLabelBounds = this._textRenderer.getExternalLabelBounds(label, text);
  118. this._modeling.resizeShape(label, newLabelBounds, NULL_DIMENSIONS);
  119. };
  120. /**
  121. * Revert updating a BPMN element's properties.
  122. *
  123. * @param { {
  124. * element: Element;
  125. * properties: Record<string, any>;
  126. * oldProperties: Record<string, any>;
  127. * } & CommandContext } context
  128. *
  129. * @return {Element[]}
  130. */
  131. UpdatePropertiesHandler.prototype.revert = function(context) {
  132. var element = context.element,
  133. properties = context.properties,
  134. oldProperties = context.oldProperties,
  135. businessObject = element.businessObject,
  136. elementRegistry = this._elementRegistry,
  137. ids = this._moddle.ids;
  138. // update properties
  139. setProperties(element, oldProperties);
  140. if (isIdChange(properties, businessObject)) {
  141. ids.unclaim(properties[ID]);
  142. elementRegistry.updateId(element, oldProperties[ID]);
  143. ids.claim(oldProperties[ID], businessObject);
  144. }
  145. return context.changed;
  146. };
  147. function isIdChange(properties, businessObject) {
  148. return ID in properties && properties[ID] !== businessObject[ID];
  149. }
  150. function getProperties(element, properties) {
  151. var propertyNames = keys(properties),
  152. businessObject = element.businessObject,
  153. di = getDi(element);
  154. return reduce(propertyNames, function(result, key) {
  155. // handle DI separately
  156. if (key !== DI) {
  157. result[key] = businessObject.get(key);
  158. } else {
  159. result[key] = getDiProperties(di, keys(properties.di));
  160. }
  161. return result;
  162. }, {});
  163. }
  164. function getDiProperties(di, propertyNames) {
  165. return reduce(propertyNames, function(result, key) {
  166. result[key] = di && di.get(key);
  167. return result;
  168. }, {});
  169. }
  170. function setProperties(element, properties) {
  171. var businessObject = element.businessObject,
  172. di = getDi(element);
  173. forEach(properties, function(value, key) {
  174. if (key !== DI) {
  175. businessObject.set(key, value);
  176. } else {
  177. // only update, if di exists
  178. if (di) {
  179. setDiProperties(di, value);
  180. }
  181. }
  182. });
  183. }
  184. function setDiProperties(di, properties) {
  185. forEach(properties, function(value, key) {
  186. di.set(key, value);
  187. });
  188. }
  189. var referencePropertyNames = [ 'default' ];
  190. /**
  191. * Make sure we unwrap the actual business object behind diagram element that
  192. * may have been passed as arguments.
  193. *
  194. * @param {Record<string, any>} properties
  195. *
  196. * @return {Record<string, any>} unwrappedProps
  197. */
  198. function unwrapBusinessObjects(properties) {
  199. var unwrappedProps = assign({}, properties);
  200. referencePropertyNames.forEach(function(name) {
  201. if (name in properties) {
  202. unwrappedProps[name] = getBusinessObject(unwrappedProps[name]);
  203. }
  204. });
  205. return unwrappedProps;
  206. }