fix(space-tool): move text annotations when a participant is resized …

…by space tool Related to camunda/camunda-modeler#4172
bpmn-io · Feb 20, 2025 · f7b6d93 · f7b6d93
1 parent bf76668
commit f7b6d93
Show file tree

Hide file tree

Showing 3 changed files with 171 additions and 4 deletions.
diff --git a/lib/features/space-tool/BpmnSpaceTool.js b/lib/features/space-tool/BpmnSpaceTool.js
@@ -2,7 +2,9 @@ import inherits from 'inherits-browser';
 
 import SpaceTool from 'diagram-js/lib/features/space-tool/SpaceTool';
 
-import { getBusinessObject, is } from '../../util/ModelUtil';
+import { getEnclosedElements, getBBox } from 'diagram-js/lib/util/Elements';
+
+import { getBusinessObject, is, isAny } from '../../util/ModelUtil';
 
 import { isHorizontal } from '../../util/DiUtil';
 
@@ -37,7 +39,32 @@ inherits(BpmnSpaceTool, SpaceTool);
  * @return {Object}
  */
 BpmnSpaceTool.prototype.calculateAdjustments = function(elements, axis, delta, start) {
-  var adjustments = SpaceTool.prototype.calculateAdjustments.call(this, elements, axis, delta, start);
+
+  // Make sure elements positioned on the root (e.g. text annotations)
+  // are moved when the participant enclosing them is resized.
+  const shapesToMove = [ 'bpmn:TextAnnotation' ];
+  const participants = elements.filter(shape => is(shape, 'bpmn:Participant'));
+
+  const rootElements = participants.reduce((result, participant) => {
+
+    const rootChildren = participant.parent.children;
+
+    const elementsToMove = rootChildren.filter(child => isAny(child, shapesToMove));
+
+    if (!elementsToMove.length) {
+      return result;
+    }
+
+    const bbox = getBBox(participant);
+
+    const enclosed = Object.values(getEnclosedElements(elementsToMove, bbox));
+
+    return [ ...result, ...enclosed ];
+  }, []);
+
+  const elementsToMove = [ ...elements, ...rootElements ];
+
+  var adjustments = SpaceTool.prototype.calculateAdjustments.call(this, elementsToMove, axis, delta, start);
 
   // do not resize:
   //

diff --git a/test/spec/features/space-tool/BpmnSpaceTool.participants.bpmn b/test/spec/features/space-tool/BpmnSpaceTool.participants.bpmn
@@ -1,10 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_14kk48y" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.12.1">
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_14kk48y" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.32.0">
   <bpmn:collaboration id="Collaboration_0ci7cuj">
     <bpmn:participant id="Participant_1" name="Expanded Pool" processRef="Process_1" />
     <bpmn:participant id="Participant_2" name="Empty Pool" />
+    <bpmn:participant id="Participant_3" name="Pool with text annotations" processRef="Process_3" />
+    <bpmn:textAnnotation id="TextAnnotation_1">
+      <bpmn:text>text 1</bpmn:text>
+    </bpmn:textAnnotation>
+    <bpmn:textAnnotation id="TextAnnotation_2">
+      <bpmn:text>text 2</bpmn:text>
+    </bpmn:textAnnotation>
+    <bpmn:textAnnotation id="TextAnnotation_3">
+      <bpmn:text>text 3</bpmn:text>
+    </bpmn:textAnnotation>
   </bpmn:collaboration>
   <bpmn:process id="Process_1" isExecutable="true" />
+  <bpmn:process id="Process_3" isExecutable="false">
+    <bpmn:task id="Activity_1" />
+    <bpmn:association id="Association_180iz30" associationDirection="None" sourceRef="Activity_1" targetRef="TextAnnotation_1" />
+    <bpmn:association id="Association_08csipe" associationDirection="None" sourceRef="Activity_1" targetRef="TextAnnotation_2" />
+  </bpmn:process>
   <bpmndi:BPMNDiagram id="BPMNDiagram_1">
     <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Collaboration_0ci7cuj">
       <bpmndi:BPMNShape id="Participant_0f6z5qz_di" bpmnElement="Participant_1" isHorizontal="true">
@@ -15,6 +30,33 @@
         <dc:Bounds x="160" y="170" width="600" height="60" />
         <bpmndi:BPMNLabel />
       </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Participant_0lm71nu_di" bpmnElement="Participant_3" isHorizontal="true">
+        <dc:Bounds x="160" y="250" width="600" height="250" />
+        <bpmndi:BPMNLabel />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Activity_1g8l8sp_di" bpmnElement="Activity_1">
+        <dc:Bounds x="310" y="340" width="100" height="80" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="Association_180iz30_di" bpmnElement="Association_180iz30">
+        <di:waypoint x="410" y="358" />
+        <di:waypoint x="496" y="320" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="Association_08csipe_di" bpmnElement="Association_08csipe">
+        <di:waypoint x="393" y="420" />
+        <di:waypoint x="518" y="570" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNShape id="TextAnnotation_0kurhwc_di" bpmnElement="TextAnnotation_1">
+        <dc:Bounds x="480" y="290" width="100" height="30" />
+        <bpmndi:BPMNLabel />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="TextAnnotation_0r40zjh_di" bpmnElement="TextAnnotation_2">
+        <dc:Bounds x="480" y="570" width="100" height="30" />
+        <bpmndi:BPMNLabel />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="BPMNShape_05zy3rg" bpmnElement="TextAnnotation_3">
+        <dc:Bounds x="200" y="360" width="100" height="30" />
+        <bpmndi:BPMNLabel />
+      </bpmndi:BPMNShape>
     </bpmndi:BPMNPlane>
   </bpmndi:BPMNDiagram>
 </bpmn:definitions>
diff --git a/test/spec/features/space-tool/BpmnSpaceToolSpec.js b/test/spec/features/space-tool/BpmnSpaceToolSpec.js
@@ -551,14 +551,110 @@ describe('features/space-tool - BpmnSpaceTool', function() {
       });
     }));
 
+
+    it('should move text annotations in a participant', inject(function(dragging, elementRegistry, spaceTool) {
+
+      // given
+      var textAnnotation = elementRegistry.get('TextAnnotation_1');
+      var textAnnotationX = textAnnotation.x;
+
+      var task = elementRegistry.get('Activity_1');
+      var taskMid = getMid(task);
+      var rightOfTask = task.x + task.width + 10;
+
+      // when
+      var element = elementRegistry.get('Participant_3');
+      var gfx = elementRegistry.getGraphics(element);
+      var hover = { element, gfx };
+
+      makeSpace({ x: rightOfTask, y: taskMid.y }, { dx: 100 }, false, hover);
+
+      // then
+      expect(textAnnotation.x).to.equal(textAnnotationX + 100);
+    }));
+
+
+    it('should only move text annotations in space tool range', inject(function(dragging, elementRegistry, spaceTool) {
+
+      // given
+      var textAnnotationToMove = elementRegistry.get('TextAnnotation_1');
+      var textAnnotationToMove_X = textAnnotationToMove.x;
+
+      var textAnnotationToStay = elementRegistry.get('TextAnnotation_3');
+      var textAnnotationToStay_X = textAnnotationToStay.x;
+
+      var task = elementRegistry.get('Activity_1');
+      var taskMid = getMid(task);
+      var rightOfTask = task.x + task.width + 10;
+
+      // when
+      var element = elementRegistry.get('Participant_3');
+      var gfx = elementRegistry.getGraphics(element);
+      var hover = { element, gfx };
+
+      makeSpace({ x: rightOfTask, y: taskMid.y }, { dx: 100 }, false, hover);
+
+      // then
+      expect(textAnnotationToMove.x).to.equal(textAnnotationToMove_X + 100);
+      expect(textAnnotationToStay.x).to.equal(textAnnotationToStay_X);
+    }));
+
+
+    it('should only move text annotations in space tool range (inverted)', inject(function(dragging, elementRegistry, spaceTool) {
+
+      // given
+      var textAnnotationToMove = elementRegistry.get('TextAnnotation_3');
+      var textAnnotationToMove_X = textAnnotationToMove.x;
+
+      var textAnnotationToStay = elementRegistry.get('TextAnnotation_1');
+      var textAnnotationToStay_X = textAnnotationToStay.x;
+
+      var task = elementRegistry.get('Activity_1');
+      var taskMid = getMid(task);
+      var rightOfTask = task.x + task.width + 10;
+
+      // when
+      var element = elementRegistry.get('Participant_3');
+      var gfx = elementRegistry.getGraphics(element);
+      var hover = { element, gfx };
+
+      makeSpace({ x: rightOfTask, y: taskMid.y }, { dx: -100 }, true, hover);
+
+      // then
+      expect(textAnnotationToMove.x).to.equal(textAnnotationToMove_X - 100);
+      expect(textAnnotationToStay.x).to.equal(textAnnotationToStay_X);
+    }));
+
+
+    it('should not move text annotations outside of participant', inject(function(dragging, elementRegistry, spaceTool) {
+
+      // given
+      var textAnnotation = elementRegistry.get('TextAnnotation_2');
+      var textAnnotationX = textAnnotation.x;
+
+      var task = elementRegistry.get('Activity_1');
+      var taskMid = getMid(task);
+      var rightOfTask = task.x + task.width + 10;
+
+      // when
+      var element = elementRegistry.get('Participant_3');
+      var gfx = elementRegistry.getGraphics(element);
+      var hover = { element, gfx };
+
+      makeSpace({ x: rightOfTask, y: taskMid.y }, { dx: 100 }, false, hover);
+
+      // then
+      expect(textAnnotation.x).to.equal(textAnnotationX);
+    }));
+
   });
 
 });
 
 
 // helpers //////////
 
-function makeSpace(start, delta, invert) {
+function makeSpace(start, delta, invert, hover) {
   var modifier = invert ? invertModifier : {};
 
   var end = {
@@ -569,6 +665,8 @@ function makeSpace(start, delta, invert) {
   return getBpmnJS().invoke(function(spaceTool, dragging) {
     spaceTool.activateMakeSpace(canvasEvent(start));
 
+    hover && dragging.hover(hover);
+
     dragging.move(canvasEvent(end, modifier));
 
     dragging.end();