fnpjs: Action now triggers actionExecuted event instead of using callback

[fnpeditor.git] / src / editor / modules / documentCanvas / canvas / canvas.js

diff --git a/src/editor/modules/documentCanvas/canvas/canvas.js b/src/editor/modules/documentCanvas/canvas/canvas.js
index b217d18..29edbe5 100644 (file)
--- a/src/editor/modules/documentCanvas/canvas/canvas.js
+++ b/src/editor/modules/documentCanvas/canvas/canvas.js
@@ -6,11 +6,16 @@ define([
 'modules/documentCanvas/canvas/documentElement',
 'modules/documentCanvas/canvas/keyboard',
 'modules/documentCanvas/canvas/utils',
 'modules/documentCanvas/canvas/documentElement',
 'modules/documentCanvas/canvas/keyboard',
 'modules/documentCanvas/canvas/utils',

-'modules/documentCanvas/canvas/wlxmlListener'
-], function($, _, Backbone, logging, documentElement, keyboard, utils, wlxmlListener) {
+'modules/documentCanvas/canvas/wlxmlListener',
+'modules/documentCanvas/canvas/elementsRegister',
+'modules/documentCanvas/canvas/genericElement',
+'modules/documentCanvas/canvas/nullElement',
+'modules/documentCanvas/canvas/gutter',
+'libs/text!./canvas.html'
+], function($, _, Backbone, logging, documentElement, keyboard, utils, wlxmlListener, ElementsRegister, genericElement, nullElement, gutter, canvasTemplate) {

     
 'use strict';
     
 'use strict';

-/* global document:false, window:false, Node:false */
+/* global document:false, window:false, Node:false, gettext */

 
 var logger = logging.getLogger('canvas');
 
 
 var logger = logging.getLogger('canvas');
 


@@ -42,24 +47,55 @@ $.extend(TextHandler.prototype, {
     },
     setText: function(text, node) {
         //this.canvas.wlxmlDocument.transform('setText', {node:node, text: text});
     },
     setText: function(text, node) {
         //this.canvas.wlxmlDocument.transform('setText', {node:node, text: text});

-        node.setText(text);
+        node.document.transaction(function() {
+            node.setText(text);
+        }, {
+            metadata:{
+                description: gettext('Changing text')
+            }
+        });

 
     }
 
 });
 
 
 
     }
 
 });
 
 

-var Canvas = function(wlxmlDocument, publisher) {
+var Canvas = function(wlxmlDocument, elements, metadata) {
+    this.metadata = metadata || {};
+    this.elementsRegister = new ElementsRegister(documentElement.DocumentNodeElement, nullElement);
+
+    elements = [
+        {tag: 'section', klass: null, prototype: genericElement},
+        {tag: 'div', klass: null, prototype: genericElement},
+        {tag: 'header', klass: null, prototype: genericElement},
+        {tag: 'span', klass: null, prototype: genericElement},
+        {tag: 'aside', klass: null, prototype: genericElement}
+    ].concat(elements || []);
+
+    (elements).forEach(function(elementDesc) {
+        this.elementsRegister.register(elementDesc);
+    }.bind(this));

     this.eventBus = _.extend({}, Backbone.Events);
     this.eventBus = _.extend({}, Backbone.Events);

-    this.wrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
+    
+    this.dom = $(canvasTemplate);
+    this.rootWrapper = this.dom.find('.root-wrapper');
+    
+
+    this.gutter = gutter.create();
+    this.gutterView = new gutter.GutterView(this.gutter);
+    this.dom.find('.view-row').append(this.gutterView.dom);
+    

     this.wlxmlListener = wlxmlListener.create(this);
     this.loadWlxmlDocument(wlxmlDocument);
     this.setupEventHandling();
     this.wlxmlListener = wlxmlListener.create(this);
     this.loadWlxmlDocument(wlxmlDocument);
     this.setupEventHandling();

-    this.publisher = publisher ? publisher : function() {};

     this.textHandler = new TextHandler(this);
 };
 
     this.textHandler = new TextHandler(this);
 };
 

-$.extend(Canvas.prototype, {
+$.extend(Canvas.prototype, Backbone.Events, {
+
+    getElementOffset: function(element) {
+        return element.dom.offset().top - this.dom.offset().top;
+    },

 
     loadWlxmlDocument: function(wlxmlDocument) {
         if(!wlxmlDocument) {
 
     loadWlxmlDocument: function(wlxmlDocument) {
         if(!wlxmlDocument) {


@@ -72,7 +108,12 @@ $.extend(Canvas.prototype, {
     },
 
     createElement: function(wlxmlNode) {
     },
 
     createElement: function(wlxmlNode) {

-        var Factory = wlxmlNode.nodeType === Node.TEXT_NODE ? documentElement.DocumentTextElement : documentElement.DocumentNodeElement;
+        var Factory;
+        if(wlxmlNode.nodeType === Node.TEXT_NODE) {
+            Factory = documentElement.DocumentTextElement;
+        } else {
+            Factory = this.elementsRegister.getElement({tag: wlxmlNode.getTagName(), klass: wlxmlNode.getClass()});
+        }

         return new Factory(wlxmlNode, this);
     },
 
         return new Factory(wlxmlNode, this);
     },
 


@@ -97,23 +138,30 @@ $.extend(Canvas.prototype, {
     },
 
     reloadRoot: function() {
     },
 
     reloadRoot: function() {

+        if(this.rootElement) {
+            this.rootElement.detach();
+        }

         this.rootElement = this.createElement(this.wlxmlDocument.root);
         this.rootElement = this.createElement(this.wlxmlDocument.root);

-        this.wrapper.empty();
-        this.wrapper.append(this.rootElement.dom());
+        this.rootWrapper.append(this.rootElement.dom);

     },
 
     setupEventHandling: function() {
         var canvas = this;
     },
 
     setupEventHandling: function() {
         var canvas = this;

-        this.wrapper.on('keyup keydown keypress', function(e) {
-            keyboard.handleKey(e, this);
-        }.bind(this));
+
+        this.rootWrapper.on('keyup keydown keypress', function(e) {
+            keyboard.handleKey(e, canvas);
+        });
+
+        this.rootWrapper.on('mouseup', function() {
+            canvas.triggerSelectionChanged();
+        });

 
         var mouseDown;
 
         var mouseDown;

-        this.wrapper.on('mousedown', '[document-node-element], [document-text-element]', function(e) {
+        this.rootWrapper.on('mousedown', '[document-node-element], [document-text-element]', function(e) {

             mouseDown = e.target;
         });
 
             mouseDown = e.target;
         });
 

-        this.wrapper.on('click', '[document-node-element], [document-text-element]', function(e) {
+        this.rootWrapper.on('click', '[document-node-element], [document-text-element]', function(e) {

             e.stopPropagation();
             if(e.originalEvent.detail === 3) {
                 e.preventDefault();
             e.stopPropagation();
             if(e.originalEvent.detail === 3) {
                 e.preventDefault();


@@ -125,7 +173,7 @@ $.extend(Canvas.prototype, {
             }
         });
 
             }
         });
 

-        this.wrapper.on('paste', function(e) {
+        this.rootWrapper.on('paste', function(e) {

             e.preventDefault();
 
             var clipboardData = e.originalEvent.clipboardData;
             e.preventDefault();
 
             var clipboardData = e.originalEvent.clipboardData;


@@ -152,7 +200,7 @@ $.extend(Canvas.prototype, {
         /* globals MutationObserver */
         var observer = new MutationObserver(function(mutations) {
             mutations.forEach(function(mutation) {
         /* globals MutationObserver */
         var observer = new MutationObserver(function(mutations) {
             mutations.forEach(function(mutation) {

-                if(documentElement.DocumentTextElement.isContentContainer(mutation.target)) {
+                if(canvas.dom[0].contains(mutation.target) && documentElement.DocumentTextElement.isContentContainer(mutation.target)) {

                     observer.disconnect();
                     if(mutation.target.data === '') {
                         mutation.target.data = utils.unicode.ZWS;
                     observer.disconnect();
                     if(mutation.target.data === '') {
                         mutation.target.data = utils.unicode.ZWS;


@@ -161,7 +209,7 @@ $.extend(Canvas.prototype, {
                         mutation.target.data = mutation.target.data.replace(utils.unicode.ZWS, '');
                         canvas._moveCaretToTextElement(canvas.getDocumentElement(mutation.target), 'end');
                     }
                         mutation.target.data = mutation.target.data.replace(utils.unicode.ZWS, '');
                         canvas._moveCaretToTextElement(canvas.getDocumentElement(mutation.target), 'end');
                     }

-                    observer.observe(canvas.wrapper[0], config);
+                    observer.observe(canvas.dom[0], config);

 
                     var textElement = canvas.getDocumentElement(mutation.target),
                         toSet = mutation.target.data !== utils.unicode.ZWS ? mutation.target.data : '';
 
                     var textElement = canvas.getDocumentElement(mutation.target),
                         toSet = mutation.target.data !== utils.unicode.ZWS ? mutation.target.data : '';


@@ -175,22 +223,15 @@ $.extend(Canvas.prototype, {
             });
         });
         var config = { attributes: false, childList: false, characterData: true, subtree: true, characterDataOldValue: true};
             });
         });
         var config = { attributes: false, childList: false, characterData: true, subtree: true, characterDataOldValue: true};

-        observer.observe(this.wrapper[0], config);
+        observer.observe(this.rootWrapper[0], config);

 
 
 
 

-        this.wrapper.on('mouseover', '[document-node-element], [document-text-element]', function(e) {
-            var el = canvas.getDocumentElement(e.currentTarget);
-            if(!el) {
-                return;
-            }
-            e.stopPropagation();
-            if(el instanceof documentElement.DocumentTextElement) {
-                el = el.parent();
-            }
-            el.toggleLabel(true);
-        });
-        this.wrapper.on('mouseout', '[document-node-element], [document-text-element]', function(e) {
-            var el = canvas.getDocumentElement(e.currentTarget);
+        var hoverHandler = function(e) {
+            var el = canvas.getDocumentElement(e.currentTarget),
+                expose = {
+                    mouseover: true,
+                    mouseout: false
+                };

             if(!el) {
                 return;
             }
             if(!el) {
                 return;
             }


@@ -198,18 +239,21 @@ $.extend(Canvas.prototype, {
             if(el instanceof documentElement.DocumentTextElement) {
                 el = el.parent();
             }
             if(el instanceof documentElement.DocumentTextElement) {
                 el = el.parent();
             }

-            el.toggleLabel(false);
-        });
+            el.updateState({exposed:expose[e.type]});
+        };
+
+        this.rootWrapper.on('mouseover', '[document-node-element], [document-text-element]', hoverHandler);
+        this.rootWrapper.on('mouseout', '[document-node-element], [document-text-element]', hoverHandler);

 
         this.eventBus.on('elementToggled', function(toggle, element) {
             if(!toggle) {
 
         this.eventBus.on('elementToggled', function(toggle, element) {
             if(!toggle) {

-                canvas.setCurrentElement(element.getPreviousTextElement());
+                canvas.setCurrentElement(canvas.getPreviousTextElement(element));

             }
         });
     },
 
     view: function() {
             }
         });
     },
 
     view: function() {

-        return this.wrapper;
+        return this.dom;

     },
 
     doc: function() {
     },
 
     doc: function() {


@@ -217,8 +261,8 @@ $.extend(Canvas.prototype, {
     },
 
     toggleElementHighlight: function(node, toggle) {
     },
 
     toggleElementHighlight: function(node, toggle) {

-        var element = utils.findCanvasElement(node);
-        element.toggleHighlight(toggle);
+        var element = utils.getElementForNode(node);
+        element.updateState({exposed: toggle});

     },
 
     getCursor: function() {
     },
 
     getCursor: function() {


@@ -227,21 +271,61 @@ $.extend(Canvas.prototype, {
 
     
     getCurrentNodeElement: function() {
 
     
     getCurrentNodeElement: function() {

-        var htmlElement = this.wrapper.find('.current-node-element').parent()[0];
-        if(htmlElement) {
-            return this.getDocumentElement(htmlElement);
-        }
+        return this.currentNodeElement;

     },
 
     getCurrentTextElement: function() {
     },
 
     getCurrentTextElement: function() {

-        var htmlElement = this.wrapper.find('.current-text-element')[0];
+        var htmlElement = this.rootWrapper.find('.current-text-element')[0];

         if(htmlElement) {
             return this.getDocumentElement(htmlElement);
         }
     },
 
         if(htmlElement) {
             return this.getDocumentElement(htmlElement);
         }
     },
 

+    getPreviousTextElement: function(relativeToElement, includeInvisible) {
+        return this.getNearestTextElement('above', relativeToElement, includeInvisible);
+    },
+
+    getNextTextElement: function(relativeToElement, includeInvisible) {
+        return this.getNearestTextElement('below', relativeToElement, includeInvisible);
+    },
+
+    getNearestTextElement: function(direction, relativeToElement, includeInvisible) {
+        includeInvisible = includeInvisible !== undefined ? includeInvisible : false;
+        var selector = '[document-text-element]' + (includeInvisible ? '' : ':visible');
+        return this.getDocumentElement(utils.nearestInDocumentOrder(selector, direction, relativeToElement.dom[0]));
+    },
+

     contains: function(element) {
     contains: function(element) {

-        return element.dom().parents().index(this.wrapper) !== -1;
+        return element && element.dom && element.dom.parents().index(this.rootWrapper) !== -1;
+    },
+
+    triggerSelectionChanged: function() {
+        this.trigger('selectionChanged', this.getSelection());
+        var s = this.getSelection(),
+            f = s.toDocumentFragment();
+        if(f && f instanceof f.RangeFragment) {
+            if(this.currentNodeElement) {
+                this.currentNodeElement.updateState({active: false});
+                this.currentNodeElement = null;
+            }
+        }
+    },
+
+    getSelection: function() {
+        return new Selection(this);
+    },
+
+    select: function(fragment) {
+        if(fragment instanceof this.wlxmlDocument.RangeFragment) {
+            this.setCurrentElement(fragment.endNode, {caretTo: fragment.endOffset});
+        } else if(fragment instanceof this.wlxmlDocument.NodeFragment) {
+            var params = {
+                caretTo: fragment instanceof this.wlxmlDocument.CaretFragment ? fragment.offset : 'start'
+            };
+            this.setCurrentElement(fragment.node, params);
+        } else {
+            logger.debug('Fragment not supported');
+        }

     },
 
     setCurrentElement: function(element, params) {
     },
 
     setCurrentElement: function(element, params) {


@@ -251,7 +335,7 @@ $.extend(Canvas.prototype, {
         }
 
         if(!(element instanceof documentElement.DocumentElement)) {
         }
 
         if(!(element instanceof documentElement.DocumentElement)) {

-            element = utils.findCanvasElement(element);
+            element = utils.getElementForNode(element);

         }
 
         if(!element || !this.contains(element)) {
         }
 
         if(!element || !this.contains(element)) {


@@ -265,21 +349,18 @@ $.extend(Canvas.prototype, {
             if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
                 return byBrowser;
             }
             if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
                 return byBrowser;
             }

-            var children = e.children();
-            for(var i = 0; i < children.length; i++) {
-                if(children[i] instanceof documentElement.DocumentTextElement) {
-                    return children[i];
-                }
-            }
-            return null;
+            return _.isFunction(e.getVerticallyFirstTextElement) ? e.getVerticallyFirstTextElement({considerChildren: false}) : null;

         }.bind(this);
         var _markAsCurrent = function(element) {
             if(element instanceof documentElement.DocumentTextElement) {
         }.bind(this);
         var _markAsCurrent = function(element) {
             if(element instanceof documentElement.DocumentTextElement) {

-                this.wrapper.find('.current-text-element').removeClass('current-text-element');
-                element.dom().addClass('current-text-element');
+                this.rootWrapper.find('.current-text-element').removeClass('current-text-element');
+                element.dom.addClass('current-text-element');

             } else {
             } else {

-                this.wrapper.find('.current-node-element').removeClass('current-node-element');
-                element._container().addClass('current-node-element');
+                if(this.currentNodeElement) {
+                    this.currentNodeElement.updateState({active: false});
+                }
+                element.updateState({active: true});
+                this.currentNodeElement = element;

             }
         }.bind(this);
 
             }
         }.bind(this);
 


@@ -291,7 +372,7 @@ $.extend(Canvas.prototype, {
             currentNodeElement = this.getCurrentNodeElement();
 
         if(currentTextElement && !(currentTextElement.sameNode(textElementToLand))) {
             currentNodeElement = this.getCurrentNodeElement();
 
         if(currentTextElement && !(currentTextElement.sameNode(textElementToLand))) {

-            this.wrapper.find('.current-text-element').removeClass('current-text-element');
+            this.rootWrapper.find('.current-text-element').removeClass('current-text-element');

         }
 
         if(textElementToLand) {
         }
 
         if(textElementToLand) {


@@ -299,28 +380,24 @@ $.extend(Canvas.prototype, {
             if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {
                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
             }
             if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {
                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
             }

-            if(!(textElementToLand.sameNode(currentTextElement))) {
-                this.publisher('currentTextElementSet', textElementToLand.wlxmlNode);
-            }

         } else {
             document.getSelection().removeAllRanges();
         }
 
         if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
             _markAsCurrent(nodeElementToLand);
         } else {
             document.getSelection().removeAllRanges();
         }
 
         if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
             _markAsCurrent(nodeElementToLand);

-
-            this.publisher('currentNodeElementSet', nodeElementToLand.wlxmlNode);

         }
         }

+        this.triggerSelectionChanged();

     },
 
     _moveCaretToTextElement: function(element, where) {
         var range = document.createRange(),
     },
 
     _moveCaretToTextElement: function(element, where) {
         var range = document.createRange(),

-            node = element.dom().contents()[0];
+            node = element.dom.contents()[0];

 
         if(typeof where !== 'number') {
             range.selectNodeContents(node);
         } else {
 
         if(typeof where !== 'number') {
             range.selectNodeContents(node);
         } else {

-            range.setStart(node, where);
+            range.setStart(node, Math.min(node.data.length, where));

         }
         
         if(where !== 'whole') {
         }
         
         if(where !== 'whole') {


@@ -334,7 +411,7 @@ $.extend(Canvas.prototype, {
 
         selection.removeAllRanges();
         selection.addRange(range);
 
         selection.removeAllRanges();
         selection.addRange(range);

-        this.wrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
+        this.rootWrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.

     },
 
     setCursorPosition: function(position) {
     },
 
     setCursorPosition: function(position) {


@@ -345,11 +422,90 @@ $.extend(Canvas.prototype, {
 });
 
 
 });
 
 

+var isText = function(node) {
+    return node && node.nodeType === Node.TEXT_NODE && $(node.parentNode).is('[document-text-element]');
+};
+
+var Selection = function(canvas) {
+    this.canvas = canvas;
+    var nativeSelection = this.nativeSelection = window.getSelection();
+    Object.defineProperty(this, 'type', {
+        get: function() {
+            if(nativeSelection.focusNode) {
+                if(nativeSelection.isCollapsed && isText(nativeSelection.focusNode)) {
+                    return 'caret';
+                }
+                if(isText(nativeSelection.focusNode) && isText(nativeSelection.anchorNode)) {
+                    return 'textSelection';
+                }
+            }
+            if(canvas.getCurrentNodeElement()) {
+                return 'node';
+            }
+        }
+    });
+};
+
+$.extend(Selection.prototype, {
+    toDocumentFragment: function() {
+        var doc = this.canvas.wlxmlDocument,
+            anchorElement = this.canvas.getDocumentElement(this.nativeSelection.anchorNode),
+            focusElement = this.canvas.getDocumentElement(this.nativeSelection.focusNode),
+            anchorNode = anchorElement ? anchorElement.wlxmlNode : null,
+            focusNode = focusElement ? focusElement.wlxmlNode : null;
+        if(this.type === 'caret') {
+            return doc.createFragment(doc.CaretFragment, {node: anchorNode, offset: this.nativeSelection.anchorOffset});
+        }
+        if(this.type === 'textSelection') {
+            if(!anchorNode || !focusNode) {
+                return;
+            }
+            if(anchorNode.isSiblingOf(focusNode)) {
+                return doc.createFragment(doc.TextRangeFragment, {
+                    node1: anchorNode,
+                    offset1: this.nativeSelection.anchorOffset,
+                    node2: focusNode,
+                    offset2: this.nativeSelection.focusOffset,
+                });
+            }
+            else {
+                var siblingParents = doc.getSiblingParents({node1: anchorNode, node2: focusNode});
+                return doc.createFragment(doc.RangeFragment, {
+                    node1: siblingParents.node1,
+                    node2: siblingParents.node2
+                });
+            }
+        }
+        if(this.type === 'node') {
+            return doc.createFragment(doc.NodeFragment, {node: this.canvas.getCurrentNodeElement().wlxmlNode});
+        }
+    },
+    sameAs: function(other) {
+        void(other);
+    }
+});
+

 var Cursor = function(canvas) {
     this.canvas = canvas;
 var Cursor = function(canvas) {
     this.canvas = canvas;

+    this.selection = window.getSelection();

 };
 
 $.extend(Cursor.prototype, {
 };
 
 $.extend(Cursor.prototype, {

+    sameAs: function(other) {
+        var same = true;
+        if(!other) {
+            return false;
+        }
+
+        ['focusNode', 'focusOffset', 'anchorNode', 'anchorOffset'].some(function(prop) {
+            same = same && this.selection[prop] === other.selection[prop];
+            if(!same) {
+                return true; // break
+            }
+        }.bind(this));
+
+        return same;
+    },

     isSelecting: function() {
         var selection = window.getSelection();
         return !selection.isCollapsed;
     isSelecting: function() {
         var selection = window.getSelection();
         return !selection.isCollapsed;


@@ -436,7 +592,7 @@ $.extend(Cursor.prototype, {
             if(selection.anchorNode === selection.focusNode) {
                 anchorFirst = selection.anchorOffset <= selection.focusOffset;
             } else {
             if(selection.anchorNode === selection.focusNode) {
                 anchorFirst = selection.anchorOffset <= selection.focusOffset;
             } else {

-                anchorFirst = parent.childIndex(anchorElement) < parent.childIndex(focusElement);
+                anchorFirst = (parent.getFirst(anchorElement, focusElement) === anchorElement);

             }
             placeData = getPlaceData(anchorFirst);
         } else {
             }
             placeData = getPlaceData(anchorFirst);
         } else {


@@ -456,8 +612,8 @@ $.extend(Cursor.prototype, {
 });
 
 return {
 });
 
 return {

-    fromXMLDocument: function(wlxmlDocument, publisher) {
-        return new Canvas(wlxmlDocument, publisher);
+    fromXMLDocument: function(wlxmlDocument, elements, metadata) {
+        return new Canvas(wlxmlDocument, elements, metadata);

     }
 };
 
     }
 };