better placement of the comment tutorial

[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 8ca71ac..fa6d27b 100644 (file)
--- a/src/editor/modules/documentCanvas/canvas/canvas.js
+++ b/src/editor/modules/documentCanvas/canvas/canvas.js
@@ -3,6 +3,7 @@ define([
 'libs/underscore',
 'libs/backbone',
 'fnpjs/logging/logging',
 'libs/underscore',
 'libs/backbone',
 'fnpjs/logging/logging',

+'views/menu/menu',

 'modules/documentCanvas/canvas/documentElement',
 'modules/documentCanvas/canvas/keyboard',
 'modules/documentCanvas/canvas/utils',
 'modules/documentCanvas/canvas/documentElement',
 'modules/documentCanvas/canvas/keyboard',
 'modules/documentCanvas/canvas/utils',


@@ -11,9 +12,11 @@ define([
 'modules/documentCanvas/canvas/genericElement',
 'modules/documentCanvas/canvas/nullElement',
 'modules/documentCanvas/canvas/gutter',
 'modules/documentCanvas/canvas/genericElement',
 'modules/documentCanvas/canvas/nullElement',
 'modules/documentCanvas/canvas/gutter',

+'modules/documentCanvas/canvas/selection',
+'modules/documentCanvas/canvas/keyEvent',

 'libs/text!./canvas.html'
 'libs/text!./canvas.html'

-], function($, _, Backbone, logging, documentElement, keyboard, utils, wlxmlListener, ElementsRegister, genericElement, nullElement, gutter, canvasTemplate) {
-    
+], function($, _, Backbone, logging, Menu, documentElement, keyboard, utils, wlxmlListener, ElementsRegister, genericElement, nullElement, gutter, selection, keyEvent, canvasTemplate) {
+

 'use strict';
 /* global document:false, window:false, Node:false, gettext */
 
 'use strict';
 /* global document:false, window:false, Node:false, gettext */
 


@@ -60,9 +63,10 @@ $.extend(TextHandler.prototype, {
 });
 
 
 });
 
 

-var Canvas = function(wlxmlDocument, elements, metadata) {
+var Canvas = function(wlxmlDocument, elements, metadata, sandbox) {

     this.metadata = metadata || {};
     this.metadata = metadata || {};

-    this.elementsRegister = new ElementsRegister(documentElement.DocumentNodeElement, nullElement);
+    this.sandbox = sandbox;
+    this.elementsRegister = this.createElementsRegister();

 
     elements = [
         {tag: 'section', klass: null, prototype: genericElement},
 
     elements = [
         {tag: 'section', klass: null, prototype: genericElement},


@@ -82,7 +86,7 @@ var Canvas = function(wlxmlDocument, elements, metadata) {
     
 
     this.gutter = gutter.create();
     
 
     this.gutter = gutter.create();

-    this.gutterView = new gutter.GutterView(this.gutter);
+    this.gutterView = new gutter.GutterView(this.gutter, sandbox.getTutorialItem('comment'));

     this.dom.find('.view-row').append(this.gutterView.dom);
     
     this.wlxmlListener = wlxmlListener.create(this);
     this.dom.find('.view-row').append(this.gutterView.dom);
     
     this.wlxmlListener = wlxmlListener.create(this);


@@ -93,6 +97,15 @@ var Canvas = function(wlxmlDocument, elements, metadata) {
 
 $.extend(Canvas.prototype, Backbone.Events, {
 
 
 $.extend(Canvas.prototype, Backbone.Events, {
 

+    createElementType: function(elementPrototype) {
+        /* TODO: reconcile this with ElementsRegister behavior */
+        var Constructor = function() {
+            documentElement.DocumentNodeElement.apply(this, Array.prototype.slice.call(arguments, 0));
+        };
+        Constructor.prototype = elementPrototype;
+        return Constructor;
+    },
+

     getElementOffset: function(element) {
         return element.dom.offset().top - this.dom.offset().top;
     },
     getElementOffset: function(element) {
         return element.dom.offset().top - this.dom.offset().top;
     },


@@ -107,14 +120,28 @@ $.extend(Canvas.prototype, Backbone.Events, {
         this.reloadRoot();
     },
 
         this.reloadRoot();
     },
 

-    createElement: function(wlxmlNode) {
+    createElement: function(wlxmlNode, register, useRoot) {

         var Factory;
         var Factory;

+        register = register || this.elementsRegister;

         if(wlxmlNode.nodeType === Node.TEXT_NODE) {
             Factory = documentElement.DocumentTextElement;
         } else {
         if(wlxmlNode.nodeType === Node.TEXT_NODE) {
             Factory = documentElement.DocumentTextElement;
         } else {

+            Factory = register.getElement({tag: wlxmlNode.getTagName(), klass: wlxmlNode.getClass()});
+        }
+        if(!Factory && useRoot) {

             Factory = this.elementsRegister.getElement({tag: wlxmlNode.getTagName(), klass: wlxmlNode.getClass()});
             Factory = this.elementsRegister.getElement({tag: wlxmlNode.getTagName(), klass: wlxmlNode.getClass()});

+            if(!Factory) {
+                Factory = documentElement.DocumentNodeElement;
+            }

         }
         }

-        return new Factory(wlxmlNode, this);
+
+        if(Factory) {
+            return new Factory(wlxmlNode, this);
+        }
+    },
+
+    createElementsRegister: function() {
+        return new ElementsRegister(documentElement.DocumentNodeElement, nullElement);

     },
 
     getDocumentElement: function(htmlElement) {
     },
 
     getDocumentElement: function(htmlElement) {


@@ -135,19 +162,40 @@ $.extend(Canvas.prototype, Backbone.Events, {
             //return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
             return $element.data('canvas-element');
         }
             //return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
             return $element.data('canvas-element');
         }

+
+        /* experimental */
+        if($element.parent().data('canvas-element')) {
+            return $element.parent().data('canvas-element');
+        }

     },
 
     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.rootWrapper.empty();

         this.rootWrapper.append(this.rootElement.dom);
     },
 
         this.rootWrapper.append(this.rootElement.dom);
     },
 

+    triggerKeyEvent: function(keyEvent, selection) {
+        selection = selection || this.getSelection();
+        if(selection && (
+            (selection.type === 'caret' || selection.type === 'textSelection') && selection.toDocumentFragment().isValid()
+            || selection.type == 'nodeSelection')) {
+            keyboard.handleKeyEvent(keyEvent, selection);
+        }
+    },
+
+    createAction: function(fqName, config) {
+        return this.sandbox.createAction(fqName, config);
+    },
+

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

-        this.rootWrapper.on('keyup keydown keypress', function(e) {
-            keyboard.handleKey(e, canvas);
+        /* globals document */
+        $(document.body).on('keydown', function(e) {
+            canvas.triggerKeyEvent(keyEvent.fromNativeEvent(e));

         });
 
         this.rootWrapper.on('mouseup', function() {
         });
 
         this.rootWrapper.on('mouseup', function() {


@@ -157,20 +205,43 @@ $.extend(Canvas.prototype, Backbone.Events, {
         var mouseDown;
         this.rootWrapper.on('mousedown', '[document-node-element], [document-text-element]', function(e) {
             mouseDown = e.target;
         var mouseDown;
         this.rootWrapper.on('mousedown', '[document-node-element], [document-text-element]', function(e) {
             mouseDown = e.target;

+            canvas.rootWrapper.find('[contenteditable]').attr('contenteditable', null);

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

+            var position, element;

             e.stopPropagation();
             if(e.originalEvent.detail === 3) {
                 e.preventDefault();
                 canvas._moveCaretToTextElement(canvas.getDocumentElement(e.currentTarget), 'whole');
             } else {
                 if(mouseDown === e.target) {
             e.stopPropagation();
             if(e.originalEvent.detail === 3) {
                 e.preventDefault();
                 canvas._moveCaretToTextElement(canvas.getDocumentElement(e.currentTarget), 'whole');
             } else {
                 if(mouseDown === e.target) {

-                    canvas.setCurrentElement(canvas.getDocumentElement(e.currentTarget), {caretTo: false});
+                    element = canvas.getDocumentElement(e.target);
+                    if(element && element.wlxmlNode.nodeType === Node.ELEMENT_NODE) {
+                        if(element.getVerticallyFirstTextElement && !element.getVerticallyFirstTextElement({considerChildren: false})) {
+                            canvas.setCurrentElement(element);
+                            return;
+                        }
+                    }
+                    if(window.getSelection().isCollapsed) {
+                        position = utils.caretPositionFromPoint(e.clientX, e.clientY);
+                        canvas.setCurrentElement(canvas.getDocumentElement(position.textNode), {caretTo: position.offset});
+                    }

                 }
             }
         });
 
                 }
             }
         });
 

+        this.rootWrapper.on('contextmenu', function(e) {
+            var el = canvas.getDocumentElement(e.target);
+            
+            if(!el) {
+                return;
+            }
+
+            e.preventDefault();
+            this.showContextMenu(el, {x: e.clientX, y: e.clientY});
+        }.bind(this));
+

         this.rootWrapper.on('paste', function(e) {
             e.preventDefault();
 
         this.rootWrapper.on('paste', function(e) {
             e.preventDefault();
 


@@ -198,12 +269,15 @@ $.extend(Canvas.prototype, Backbone.Events, {
         /* 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;
                     }

-                    else if(mutation.oldValue === utils.unicode.ZWS) {
+                    if(mutation.target.data === mutation.oldValue) {
+                        return; // shouldn't happen, but better be safe
+                    }
+                    if(mutation.oldValue === utils.unicode.ZWS) {

                         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');
                     }


@@ -298,9 +372,14 @@ $.extend(Canvas.prototype, Backbone.Events, {
     },
 
     triggerSelectionChanged: function() {
     },
 
     triggerSelectionChanged: function() {

-        this.trigger('selectionChanged', this.getSelection());

         var s = this.getSelection(),
         var s = this.getSelection(),

-            f = s.toDocumentFragment();
+            f;
+        if(!s) {
+            return;
+        }
+        this.trigger('selectionChanged', s);
+        f = s.toDocumentFragment();
+

         if(f && f instanceof f.RangeFragment) {
             if(this.currentNodeElement) {
                 this.currentNodeElement.updateState({active: false});
         if(f && f instanceof f.RangeFragment) {
             if(this.currentNodeElement) {
                 this.currentNodeElement.updateState({active: false});


@@ -310,7 +389,7 @@ $.extend(Canvas.prototype, Backbone.Events, {
     },
 
     getSelection: function() {
     },
 
     getSelection: function() {

-        return new Selection(this);
+        return selection.fromNativeSelection(this);

     },
 
     select: function(fragment) {
     },
 
     select: function(fragment) {


@@ -326,6 +405,13 @@ $.extend(Canvas.prototype, Backbone.Events, {
         }
     },
 
         }
     },
 

+    setSelection: function(selection) {
+        this.select(this, selection.toDocumentFragment());
+    },
+
+    createSelection: function(params) {
+        return selection.fromParams(this, params);
+    },

     setCurrentElement: function(element, params) {
         if(!element) {
             logger.debug('Invalid element passed to setCurrentElement: ' + element);
     setCurrentElement: function(element, params) {
         if(!element) {
             logger.debug('Invalid element passed to setCurrentElement: ' + element);


@@ -347,7 +433,7 @@ $.extend(Canvas.prototype, Backbone.Events, {
             if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
                 return byBrowser;
             }
             if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
                 return byBrowser;
             }

-            return e.getVerticallyFirstTextElement();
+            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) {


@@ -375,7 +461,7 @@ $.extend(Canvas.prototype, Backbone.Events, {
 
         if(textElementToLand) {
             _markAsCurrent(textElementToLand);
 
         if(textElementToLand) {
             _markAsCurrent(textElementToLand);

-            if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {
+            if((params.caretTo || params.caretTo === 0) || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {

                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
             }
         } else {
                 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
             }
         } else {


@@ -407,9 +493,10 @@ $.extend(Canvas.prototype, Backbone.Events, {
         }
         var selection = document.getSelection();
 
         }
         var selection = document.getSelection();
 

+        $(node).parent().attr('contenteditable', true);

         selection.removeAllRanges();
         selection.addRange(range);
         selection.removeAllRanges();
         selection.addRange(range);

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

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


@@ -417,77 +504,21 @@ $.extend(Canvas.prototype, Backbone.Events, {
             this._moveCaretToTextElement(position.element, position.offset);
         }
     },
             this._moveCaretToTextElement(position.element, position.offset);
         }
     },

+    showContextMenu: function(element, coors) {
+        var menu = new Menu();

 
 

-    toggleGrid: function() {
-        this.rootWrapper.toggleClass('grid-on');
-        this.trigger('changed');
-    },
-    isGridToggled: function() {
-        return this.rootWrapper.hasClass('grid-on');
-    }
-});
-
-
-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.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
-                });
-            }
+        while(element) {
+            (element.contextMenuActions || []).forEach(menu.addAction.bind(menu));
+            element = element.parent();

         }
         }

-        if(this.type === 'node') {
-            return doc.createFragment(doc.NodeFragment, {node: this.canvas.getCurrentNodeElement().wlxmlNode});
+        if(menu.actions.length) {
+            menu.updateContextParam('fragment', this.getSelection().toDocumentFragment());
+            this.sandbox.showContextMenu(menu, {x: coors.x, y: coors.y});

         }
         }

-    },
-    sameAs: function(other) {
-        void(other);

     }
 });
 
     }
 });
 

+

 var Cursor = function(canvas) {
     this.canvas = canvas;
     this.selection = window.getSelection();
 var Cursor = function(canvas) {
     this.canvas = canvas;
     this.selection = window.getSelection();


@@ -526,18 +557,18 @@ $.extend(Cursor.prototype, {
         return this.getSelectionAnchor();
     },
     getSelectionStart: function() {
         return this.getSelectionAnchor();
     },
     getSelectionStart: function() {

-        return this.getSelectionBoundry('start');
+        return this.getSelectionBoundary('start');

     },
     getSelectionEnd: function() {
     },
     getSelectionEnd: function() {

-        return this.getSelectionBoundry('end');
+        return this.getSelectionBoundary('end');

     },
     getSelectionAnchor: function() {
     },
     getSelectionAnchor: function() {

-        return this.getSelectionBoundry('anchor');
+        return this.getSelectionBoundary('anchor');

     },
     getSelectionFocus: function() {
     },
     getSelectionFocus: function() {

-        return this.getSelectionBoundry('focus');
+        return this.getSelectionBoundary('focus');

     },
     },

-    getSelectionBoundry: function(which) {
+    getSelectionBoundary: function(which) {

         /* globals window */
         var selection = window.getSelection(),
             anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
         /* globals window */
         var selection = window.getSelection(),
             anchorElement = this.canvas.getDocumentElement(selection.anchorNode),


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

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

     }
 };
 
     }
 };