editor: refactoring in the data module
[fnpeditor.git] / src / editor / modules / documentCanvas / canvas / genericElement.js
index 8b7d2fb..a769240 100644 (file)
@@ -3,84 +3,61 @@ define(function(require) {
 'use strict';
 
 var $ = require('libs/jquery'),
+    _ = require('libs/underscore'),
     documentElement = require('./documentElement'),
     utils = require('./utils'),
-    wlxmlUtils = require('utils/wlxml');
+    CommentsView = require('./comments/comments');
 
-var labelWidget = function(tag, klass) {
-    return $('<span>')
-        .addClass('canvas-widget canvas-widget-label')
-        .text(wlxmlUtils.getTagLabel(tag) + (klass ? ' / ' + wlxmlUtils.getClassLabel(klass) : ''));
-};
-void(labelWidget); // for linters; labelWidget is unused on purpose for now
 
+var DocumentNodeElement = documentElement.DocumentNodeElement;
 
-var generic = {
-    onNodeAttrChange: function(event) {
-        if(event.meta.attr === 'class') {
-            this.setWlxmlClass(event.meta.newVal); //
-        }
-    },
-    onNodeAdded: function(event) {
-        if(event.meta.node.isRoot()) {
-            this.canvas.reloadRoot();
-            return;
-        }
+var generic = Object.create(DocumentNodeElement.prototype);
 
-        var nodeIndex = event.meta.node.getIndex(),
-            referenceElement, referenceAction, actionArg;
+$.extend(generic, {
+    init: function() {
+        DocumentNodeElement.prototype.init.call(this);
+        this._container()
+            .attr('wlxml-tag', this.wlxmlNode.getTagName())
+            .attr('wlxml-class', this.wlxmlNode.getClass().replace(/\./g, '-'));
 
-        if(nodeIndex === 0) {
-            referenceElement = this;
-            referenceAction = 'prepend';
-        } else {
-            referenceElement = this.children()[nodeIndex-1];
-            referenceAction = 'after';
+        this.wlxmlNode.contents().forEach(function(node) {
+            var el = this.canvas.createElement(node);
+            if(el.dom) {
+                this._container().append(el.dom);
+            }
+        }.bind(this));
+
+        this.commentsView = new CommentsView(this.wlxmlNode, this.canvas.metadata.user);
+        this.addToGutter(this.commentsView);
+        this.commentTip = $('<div class="comment-tip"><i class="icon-comment"></i></div>');
+        this.addWidget(this.commentTip);
+
+        if(!this.wlxmlNode.hasChild({klass: 'comment'})) {
+            this.commentTip.hide();
         }
 
-        actionArg = (event.type === 'nodeMoved' && utils.findCanvasElement(event.meta.node, event.meta.parent)) || event.meta.node;
-        referenceElement[referenceAction](actionArg);
-    },
-    onNodeMoved: function(event) {
-        return this.onNodeAdded.call(this, event, true);
+        this.refresh();
     },
-    onNodeDetached: function(event) {
-        if(event.meta.node.sameNode(this)) {
-            this.detach();
+    
+    refresh: function() {
+        if(this.wlxmlNode.getTagName() === 'span') {
+            if(this.containsBlock()) {
+                this.displayAsBlock();
+            } else {
+                this.displayInline();
+            }
         } else {
-            this.children().some(function(child) {
-                if(child.wlxmlNode.sameNode(event.meta.node)) {
-                    child.detach();
-                    return true;
-                }
-            });
+            this.displayAsBlock();
         }
     },
-    onNodeTextChange: function(event) {
-        var toSet = event.meta.node.getText();
-        this.children().some(function(child) {
-            if(child.wlxmlNode.sameNode(event.meta.node)) {
-                if(toSet === '') {
-                    toSet = utils.unicode.ZWS;
-                }
-                if(toSet !== child.getText()) {
-                    child.setText(toSet);
-                }
-                return true;
-            }
-        });
-    },
 
-    prepend: function(param) {
-        var element;
-        if(param instanceof documentElement.DocumentElement) {
-            element = param;
-        } else {
-            element = this.canvas.createElement(param);
+    getFirst: function(e1, e2) {
+        var idx1 = this.childIndex(e1),
+            idx2 = this.childIndex(e2);
+        if(e1 === null || e2 === null) {
+            return undefined;
         }
-        this._container().prepend(element.dom());
-        this.refreshPath();
-        return element;
+        return idx1 <= idx2 ? e1: e2;
     },
 
     children: function() {
@@ -97,67 +74,104 @@ var generic = {
         return toret;
     },
 
-    getFirst: function(e1, e2) {
-        var idx1 = this.childIndex(e1),
-            idx2 = this.childIndex(e2);
-        if(e1 === null || e2 === null) {
-            return undefined;
-        }
-        return idx1 <= idx2 ? e1: e2;
-    },
-
-    childIndex: function(child) {
-        var children = this.children(),
-            toret = null;
-        children.forEach(function(c, idx) {
-            if(c.sameNode(child)) {
-                toret = idx;
-                return false;
+    getVerticallyFirstTextElement: function(params) {
+        var toret;
+        
+        params = _.extend({
+            considerChildren: true
+        }, params);
+        
+        this.children().some(function(child) {
+            if(child instanceof documentElement.DocumentTextElement) {
+                toret = child;
+                return true; // break
+            } else if(params.considerChildren) {
+                toret = child.getVerticallyFirstTextElement();
+                if(toret) {
+                    return true; // break
+                }
             }
         });
         return toret;
     },
 
-    getWlxmlClass: function() {
-        var klass = this._container().attr('wlxml-class');
-        if(klass) {
-            return klass.replace(/-/g, '.');
-        }
-        return undefined;
-    },
-    setWlxmlClass: function(klass) {
-        if(klass === this.getWlxmlClass()) {
+    onNodeAdded: function(event) {
+        if(event.meta.node.isRoot()) {
+            this.canvas.reloadRoot();
             return;
         }
-        if(klass) {
-            this._container().attr('wlxml-class', klass.replace(/\./g, '-'));
+
+        var ptr = event.meta.node.prev(),
+            referenceElement, referenceAction, actionArg;
+            
+        while(ptr && !(referenceElement = utils.getElementForElementRootNode(ptr))) {
+            ptr = ptr.prev();
         }
-        else {
-            this._container().removeAttr('wlxml-class');
+
+        if(referenceElement) {
+            referenceAction = 'after';
+        } else {
+            referenceElement = this;
+            referenceAction = 'prepend';
+        }
+      
+        if(event.meta.move) {
+            /* Let's check if this node had its own canvas element and it's accessible. */
+            actionArg = utils.getElementForElementRootNode(event.meta.node);
+        }
+        if(!actionArg) {
+            actionArg = event.meta.node;
         }
-        this.refreshPath();
-    },
-    init: function() {
-        this._container()
-            .attr('wlxml-tag', this.wlxmlNode.getTagName());
-        this.setWlxmlClass(this.wlxmlNode.getClass());
-        this.wlxmlNode.contents().forEach(function(node) {
-            this._container().append(this.canvas.createElement(node).dom());
-        }.bind(this));
-        this.refresh();
 
+        referenceElement[referenceAction](actionArg);
+
+        if(event.meta.node.is('comment')) {
+            this.commentTip.show();
+            this.commentsView.render();
+        }
     },
-    refresh: function() {
-        if(this.wlxmlNode.getTagName() === 'span') {
-            if(this.containsBlock()) {
-                this.displayAsBlock();
-            } else {
-                this.displayInline();
-            }
+    onNodeDetached: function(event) {
+        var isComment = event.meta.node.is('comment');
+        if(event.meta.node.sameNode(this)) {
+            this.detach();
         } else {
-            this.displayAsBlock();
+            this.children().some(function(child) {
+                if(child.wlxmlNode.sameNode(event.meta.node)) {
+                    child.detach();
+                    return true;
+                }
+            });
+            if(isComment && !this.wlxmlNode.hasChild({klass: 'comment'})) {
+                this.commentTip.hide();
+            }
+            this.commentsView.render();
         }
     },
+    onNodeTextChange: function(event) {
+        var node = event.meta.node;
+
+        /* TODO: This handling of changes to the comments should probably be implemented via separate,
+        non-rendering comments element */
+        if(node.parent() && node.parent().is('comment') && this.wlxmlNode.sameNode(node.parent().parent())) {
+            this.commentsView.render();
+        }
+    },
+
+    onStateChange: function(changes) {
+        if(_.isBoolean(changes.exposed) && !this.isSpan()) {
+            this._container().toggleClass('highlighted-element', changes.exposed);
+        }
+        if(_.isBoolean(changes.active) && !this.isSpan()) {
+            this._container().toggleClass('current-node-element', changes.active);
+        }
+    },
+
+    ///
+
+    isSpan: function() {
+        return this.wlxmlNode.getTagName() === 'span';
+    },
+    
     containsBlock: function() {
         return this.children()
             .filter(function(child) {
@@ -171,22 +185,33 @@ var generic = {
                 }
             });
     },
-    getVerticallyFirstTextElement: function() {
-        var toret;
-        this.children().some(function(child) {
-            if(child instanceof documentElement.DocumentTextElement) {
-                toret = child;
-                return true; // break
-            } else {
-                toret = child.getVerticallyFirstTextElement();
-                if(toret) {
-                    return true; // break
-                }
+
+    prepend: function(param) {
+        var element;
+        if(param instanceof documentElement.DocumentElement) {
+            element = param;
+        } else {
+            element = this.canvas.createElement(param);
+        }
+        if(element.dom) {
+            this._container().prepend(element.dom);
+            this.refreshPath();
+        }
+        return element;
+    },
+
+    childIndex: function(child) {
+        var children = this.children(),
+            toret = null;
+        children.forEach(function(c, idx) {
+            if(c.sameNode(child)) {
+                toret = idx;
+                return false;
             }
         });
         return toret;
-    },
-};
+    }
+});
 
 
 return generic;