Let events about added/removed steps part be part of operation event stack

Author: Friedrich W. H. Kossebau

webodf/lib/ops/OdtDocument.js

@@ -984,27 +984,35 @@ ops.OdtDocument = function OdtDocument(odfCanvas) {
     };
 
     /**
-     * Process steps being inserted into the document. Will emit a steps inserted signal on
-     * behalf of the caller
+     * Process steps being inserted into the document. Will add a steps inserted signal
+     * to the passed events list
      * @param {!{position: !number}} args
+     * @param {!Array.<!ops.Operation.Event>} events
      * @return {undefined}
      */
-    this.handleStepsInserted = function(args) {
+    this.handleStepsInserted = function(args, events) {
         stepsTranslator.handleStepsInserted(args);
         // signal not used in webodf, but 3rd-party (NVivo)
-        eventNotifier.emit(ops.OdtDocument.signalStepsInserted, args);
+        events.push({
+            eventid: ops.OdtDocument.signalStepsInserted,
+            args: args
+        });
     };
 
     /**
      * Process steps being removed from the document. Will emit a steps removed signal on
      * behalf of the caller
      * @param {!{position: !number}} args
+     * @param {!Array.<!ops.Operation.Event>} events
      * @return {undefined}
      */
-    this.handleStepsRemoved = function(args) {
+    this.handleStepsRemoved = function(args, events) {
         stepsTranslator.handleStepsRemoved(args);
         // signal not used in webodf, but 3rd-party (NVivo)
-        eventNotifier.emit(ops.OdtDocument.signalStepsRemoved, args);
+        events.push({
+            eventid: ops.OdtDocument.signalStepsRemoved,
+            args: args
+        });
     };
 
     /**

webodf/lib/ops/OpAddAnnotation.js

@@ -160,7 +160,7 @@ ops.OpAddAnnotation = function OpAddAnnotation() {
             insertNodeAtPosition(odtDocument, annotationEnd, position + length);
         }
         insertNodeAtPosition(odtDocument, annotation, position);
-        odtDocument.handleStepsInserted({position: position});
+        odtDocument.handleStepsInserted({position: position}, events);
 
         // Move the cursor inside the new annotation,
         // by selecting the paragraph's range.

webodf/lib/ops/OpInsertImage.js

@@ -86,7 +86,8 @@ ops.OpInsertImage = function OpInsertImage() {
         var odtDocument = /**@type{ops.OdtDocument}*/(document),
             odfCanvas = odtDocument.getOdfCanvas(),
             domPosition = odtDocument.getTextNodeAtStep(position, memberid),
-            textNode, refNode, paragraphElement, frameElement;
+            textNode, refNode, paragraphElement, frameElement,
+            events = [];
 
         if (!domPosition) {
             return null;
@@ -98,7 +99,7 @@ ops.OpInsertImage = function OpInsertImage() {
             textNode.splitText(domPosition.offset) : textNode.nextSibling;
         frameElement = createFrameElement(odtDocument.getDOMDocument());
         textNode.parentNode.insertBefore(frameElement, refNode);
-        odtDocument.handleStepsInserted({position: position});
+        odtDocument.handleStepsInserted({position: position}, events);
 
         // clean up any empty text node which was created by odtDocument.getTextNodeAtStep
         if (textNode.length === 0) {
@@ -109,14 +110,16 @@ ops.OpInsertImage = function OpInsertImage() {
         odfCanvas.refreshCSS();
         odfCanvas.rerenderAnnotations();
 
-        return [{
+        events.push({
             eventid: ops.OdtDocument.signalParagraphChanged,
             args: {
                 paragraphElement: paragraphElement,
                 memberId: memberid,
                 timeStamp: timestamp
             }
-        }];
+        });
+
+        return events;
     };
 
     /**

webodf/lib/ops/OpInsertTable.js

@@ -149,7 +149,8 @@ ops.OpInsertTable = function OpInsertTable() {
             domPosition = odtDocument.getTextNodeAtStep(position),
             rootNode = odtDocument.getRootNode(),
             previousSibling,
-            tableNode;
+            tableNode,
+            events = [];
 
         if (domPosition) {
             tableNode = createTableNode(odtDocument.getDOMDocument());
@@ -158,18 +159,20 @@ ops.OpInsertTable = function OpInsertTable() {
             previousSibling = odfUtils.getParagraphElement(domPosition.textNode);
             rootNode.insertBefore(tableNode, previousSibling.nextSibling);
             // The parent table counts for 1 position, and 1 paragraph is added per cell
-            odtDocument.handleStepsInserted({position: position});
+            odtDocument.handleStepsInserted({position: position}, events);
 
             odtDocument.getOdfCanvas().refreshSize();
             odtDocument.getOdfCanvas().rerenderAnnotations();
-            return [{
+            events.push({
                 eventid: ops.OdtDocument.signalTableAdded,
                 args: {
                     tableElement: tableNode,
                     memberId: memberid,
                     timeStamp: timestamp
                 }
-            }];
+            });
+
+            return events;
         }
         return null;
     };

webodf/lib/ops/OpInsertText.js

@@ -188,7 +188,7 @@ ops.OpInsertText = function OpInsertText() {
                 previousNode.parentNode.removeChild(previousNode);
             }
 
-            odtDocument.handleStepsInserted({position: position});
+            odtDocument.handleStepsInserted({position: position}, events);
 
             if (cursor && moveCursor) {
                 // Explicitly place the cursor in the desired position after insertion

webodf/lib/ops/OpMergeParagraph.js

@@ -245,7 +245,7 @@ ops.OpMergeParagraph = function OpMergeParagraph() {
         collapseRules.mergeChildrenIntoParent(sourceParagraph);
 
         // Merging removes a single step between the boundary of the two paragraphs
-        odtDocument.handleStepsRemoved({position: sourceStartPosition - 1});
+        odtDocument.handleStepsRemoved({position: sourceStartPosition - 1}, events);
 
         // Downgrade trailing spaces at the end of the destination paragraph, and the beginning of the source paragraph.
         // These are the only two places that might need downgrading as a result of the merge.

webodf/lib/ops/OpRemoveAnnotation.js

@@ -59,7 +59,8 @@ ops.OpRemoveAnnotation = function OpRemoveAnnotation() {
             iterator = odtDocument.getIteratorAtPosition(position),
             container = iterator.container(),
             annotationNode,
-            annotationEnd;
+            annotationEnd,
+            events = [];
 
         while (!(container.namespaceURI === odf.Namespaces.officens
             && container.localName === 'annotation')) {
@@ -91,12 +92,12 @@ ops.OpRemoveAnnotation = function OpRemoveAnnotation() {
             annotationEnd.parentNode.removeChild(annotationEnd);
         }
         // The specified position is the first walkable step in the annotation. The position is always just before the first point of change
-        odtDocument.handleStepsRemoved({position: position > 0 ? position - 1 : position});
+        odtDocument.handleStepsRemoved({position: position > 0 ? position - 1 : position}, events);
 
         odtDocument.getOdfCanvas().rerenderAnnotations();
         odtDocument.fixCursorPositions();
 
-        return [];
+        return events;
     };
 
     /**

webodf/lib/ops/OpRemoveText.js

@@ -93,7 +93,7 @@ ops.OpRemoveText = function OpRemoveText() {
             }
         });
 
-        odtDocument.handleStepsRemoved({position: position});
+        odtDocument.handleStepsRemoved({position: position}, events);
         odtDocument.downgradeWhitespacesAtPosition(position);
         odtDocument.fixCursorPositions();
         odtDocument.getOdfCanvas().refreshSize();

webodf/lib/ops/OpSplitParagraph.js

@@ -170,7 +170,7 @@ ops.OpSplitParagraph = function OpSplitParagraph() {
         if (domPosition.textNode.length === 0) {
             domPosition.textNode.parentNode.removeChild(domPosition.textNode);
         }
-        odtDocument.handleStepsInserted({position: position});
+        odtDocument.handleStepsInserted({position: position}, events);
 
         if (cursor && moveCursor) {
             odtDocument.moveCursor(memberid, position + 1, 0);