editor: refactoring canvas markup

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

diff --git a/src/editor/modules/documentCanvas/canvas/documentElement.js b/src/editor/modules/documentCanvas/canvas/documentElement.js
index afa510f..948e8df 100644 (file)
--- a/src/editor/modules/documentCanvas/canvas/documentElement.js
+++ b/src/editor/modules/documentCanvas/canvas/documentElement.js
@@ -1,35 +1,63 @@
 define([
 'libs/jquery',
 'libs/underscore',
 define([
 'libs/jquery',
 'libs/underscore',

-'modules/documentCanvas/canvas/utils',
-'modules/documentCanvas/canvas/wlxmlManagers'
-], function($, _, utils, wlxmlManagers) {
+'modules/documentCanvas/canvas/utils'
+], function($, _, utils) {

     
 'use strict';
     
 'use strict';

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

 
 // DocumentElement represents a text or an element node from WLXML document rendered inside Canvas
 var DocumentElement = function(wlxmlNode, canvas) {
 
 // DocumentElement represents a text or an element node from WLXML document rendered inside Canvas
 var DocumentElement = function(wlxmlNode, canvas) {

-    if(arguments.length === 0) {
-        return;
-    }

     this.wlxmlNode = wlxmlNode;
     this.canvas = canvas;
     this.wlxmlNode = wlxmlNode;
     this.canvas = canvas;

+    this.state = {
+        exposed: false,
+        active: false
+    };

 
 

-    this.$element = this.createDOM();
-    this.$element.data('canvas-element', this);
+    this.dom = this.createDOM();
+    this.dom.data('canvas-element', this);

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

-    bound: function() {
-        return $.contains(document.documentElement, this.dom()[0]);
-    },
-    dom: function() {
-        return this.$element;
+    refreshPath: function() {
+        this.parents().forEach(function(parent) {
+            parent.refresh();
+        });
+        this.refresh();
+    },
+    refresh: function() {
+        // noop
+    },
+    updateState: function(toUpdate) {
+        var changes = {};
+        _.keys(toUpdate)
+            .filter(function(key) {
+                return this.state.hasOwnProperty(key);
+            }.bind(this))
+            .forEach(function(key) {
+                if(this.state !== toUpdate[key]) {
+                    this.state[key] = changes[key] = toUpdate[key];
+                }
+            }.bind(this));
+        if(_.isFunction(this.onStateChange)) {
+            this.onStateChange(changes);
+            if(_.isBoolean(changes.active)) {
+                if(changes.active) {
+                    var ptr = this;
+                    while(ptr && ptr.wlxmlNode.getTagName() === 'span') {
+                        ptr = ptr.parent();
+                    }
+                    if(ptr && ptr.gutterGroup) {
+                        ptr.gutterGroup.show();
+                    }
+                }
+            }
+        }

     },
     parent: function() {
     },
     parent: function() {

-        var parents = this.$element.parents('[document-node-element]');
+        var parents = this.dom.parents('[document-node-element]');

         if(parents.length) {
             return this.canvas.getDocumentElement(parents[0]);
         }
         if(parents.length) {
             return this.canvas.getDocumentElement(parents[0]);
         }


@@ -47,61 +75,14 @@ $.extend(DocumentElement.prototype, {
     },
 
     sameNode: function(other) {
     },
 
     sameNode: function(other) {

-        return other && (typeof other === typeof this) && other.dom()[0] === this.dom()[0];
-    },
-
-    markAsCurrent: function() {
-        this.canvas.markAsCurrent(this);
-    },
-
-    getVerticallyFirstTextElement: function() {
-        var toret;
-        this.children().some(function(child) {
-            if(!child.isVisible()) {
-                return false; // continue
-            }
-            if(child instanceof DocumentTextElement) {
-                toret = child;
-                return true; // break
-            } else {
-                toret = child.getVerticallyFirstTextElement();
-                if(toret) {
-                    return true; // break
-                }
-            }
-        });
-        return toret;
-    },
-
-    getPreviousTextElement: function(includeInvisible) {
-        return this.getNearestTextElement('above', includeInvisible);
-    },
-
-    getNextTextElement: function(includeInvisible) {
-        return this.getNearestTextElement('below', includeInvisible);
-    },
-
-    getNearestTextElement: function(direction, includeInvisible) {
-        includeInvisible = includeInvisible !== undefined ? includeInvisible : false;
-        var selector = '[document-text-element]' + (includeInvisible ? '' : ':visible');
-        return this.canvas.getDocumentElement(utils.nearestInDocumentOrder(selector, direction, this.dom()[0]));
+        return other && (typeof other === typeof this) && other.dom[0] === this.dom[0];

     },
 
     },
 

-    isVisible: function() {
-        return this instanceof DocumentTextElement || this.getWlxmlTag() !== 'metadata';
-    },
+    trigger: function() {
+        this.canvas.eventBus.trigger.apply(this.canvas.eventBus, Array.prototype.slice.call(arguments, 0));
+    }

 
 

-    isInsideList: function() {
-        return this.parents().some(function(parent) {
-            return parent.is('list');
-        });
-    },

 
 

-    exec: function(method) {
-        if(this.manager && this.manager[method]) {
-            return this.manager[method].apply(this.manager, Array.prototype.slice.call(arguments, 1));
-        }
-    }

 });
 
 
 });
 
 


@@ -109,6 +90,7 @@ $.extend(DocumentElement.prototype, {
 var DocumentNodeElement = function(wlxmlNode, canvas) {
     DocumentElement.call(this, wlxmlNode, canvas);
     wlxmlNode.setData('canvasElement', this);
 var DocumentNodeElement = function(wlxmlNode, canvas) {
     DocumentElement.call(this, wlxmlNode, canvas);
     wlxmlNode.setData('canvasElement', this);

+    this.init(this.dom);

 };
 
 
 };
 
 


@@ -119,48 +101,63 @@ var manipulate = function(e, params, action) {
     } else {
         element = e.canvas.createElement(params);
     }
     } else {
         element = e.canvas.createElement(params);
     }

-    var target = (action === 'append' || action === 'prepend') ? e._container() : e.dom();
-    target[action](element.dom());
+    if(element.dom) {
+        e.dom[action](element.dom);
+        e.refreshPath();
+    }

     return element;
 };
 
     return element;
 };
 

-DocumentNodeElement.prototype = new DocumentElement();
+DocumentNodeElement.prototype = Object.create(DocumentElement.prototype);

 
 
 $.extend(DocumentNodeElement.prototype, {
 
 
 $.extend(DocumentNodeElement.prototype, {

+    defaultDisplayStyle: 'block',
+    init: function() {},
+    addWidget: function(widget) {
+        this.dom.children('.canvas-widgets').append(widget.DOM ? widget.DOM : widget);
+    },
+    clearWidgets: function() {
+        this.dom.children('.canvas-widgets').empty();
+    },
+    addToGutter: function(view) {
+        if(!this.gutterGroup) {
+            this.gutterGroup = this.canvas.gutter.createViewGroup({
+                offsetHint: function() {
+                    return this.canvas.getElementOffset(this);
+                }.bind(this)
+            }, this);
+        }
+        this.gutterGroup.addView(view);
+    },
+    handle: function(event) {
+        var method = 'on' + event.type[0].toUpperCase() + event.type.substr(1);
+        if(this[method]) {
+            this[method](event);
+        }
+    },

     createDOM: function() {
     createDOM: function() {

-        var dom = $('<div>')
-                .attr('document-node-element', ''),
+        var wrapper = $('<div>').attr('document-node-element', ''),

             widgetsContainer = $('<div>')
                 .addClass('canvas-widgets')
                 .attr('contenteditable', false),
             widgetsContainer = $('<div>')
                 .addClass('canvas-widgets')
                 .attr('contenteditable', false),

-            container = $('<div>')
+            contentContainer = $('<div>')

                 .attr('document-element-content', '');
         
                 .attr('document-element-content', '');
         

-        dom.append(widgetsContainer, container);
-        // Make sure widgets aren't navigable with arrow keys
+        wrapper.append(contentContainer, widgetsContainer);

         widgetsContainer.find('*').add(widgetsContainer).attr('tabindex', -1);
         widgetsContainer.find('*').add(widgetsContainer).attr('tabindex', -1);

-        this.$element = dom; //@!!!
-        this.setWlxml({tag: this.wlxmlNode.getTagName(), klass: this.wlxmlNode.getClass()});
-
-        this.wlxmlNode.contents().forEach(function(node) {
-            container.append(this.canvas.createElement(node).dom());
-        }.bind(this));
-        return dom;
+        return wrapper;

     },
     _container: function() {
     },
     _container: function() {

-        return this.dom().children('[document-element-content]');
+        return this.dom.children('[document-element-content]');

     },
     detach: function() {
     },
     detach: function() {

-        this.dom().detach();
-        this.canvas = null;
-        return this;
-    },
-    append: function(params) {
-        return manipulate(this, params, 'append');
-    },
-    prepend: function(params) {
-        return manipulate(this, params, 'prepend');
+        var parents = this.parents();
+        this.dom.detach();
+        if(parents[0]) {
+            parents[0].refreshPath();
+        }
+         return this;

     },
     before: function(params) {
         return manipulate(this, params, 'before');
     },
     before: function(params) {
         return manipulate(this, params, 'before');


@@ -169,105 +166,30 @@ $.extend(DocumentNodeElement.prototype, {
     after: function(params) {
         return manipulate(this, params, 'after');
     },
     after: function(params) {
         return manipulate(this, params, 'after');
     },

-    children: function() {
-        var toret = [];
-        if(this instanceof DocumentTextElement) {
-            return toret;
-        }

 
 

-
-        var elementContent = this._container().contents();
-        var element = this;
-        elementContent.each(function() {
-            var childElement = element.canvas.getDocumentElement(this);
-            if(childElement === undefined) {
-                return true;
-            }
-            toret.push(childElement);
-        });
-        return toret;
-    },
-    childIndex: function(child) {
-        var children = this.children(),
-            toret = null;
-        children.forEach(function(c, idx) {
-            if(c.sameNode(child)) {
-                toret = idx;
-                return false;
-            }
-        });
-        return toret;
-    },
-    getWlxmlTag: function() {
-        return this._container().attr('wlxml-tag');
+    isBlock: function() {
+        return this.dom.css('display') === 'block';

     },
     },

-    setWlxmlTag: function(tag) {
-        if(tag === this.getWlxmlTag()) {
-            return;
-        }

 
 

-        this._container().attr('wlxml-tag', tag);
-        if(!this.__updatingWlxml) {
-            this._updateWlxmlManager();
-        }
-    },
-    getWlxmlClass: function() {
-        var klass = this._container().attr('wlxml-class');
-        if(klass) {
-            return klass.replace(/-/g, '.');
-        }
-        return undefined;
-    },
-    setWlxmlClass: function(klass) {
-        if(klass === this.getWlxmlClass()) {
-            return;
-        }
-        if(klass) {
-            this._container().attr('wlxml-class', klass.replace(/\./g, '-'));
-        }
-        else {
-            this._container().removeAttr('wlxml-class');
-        }
-        if(!this.__updatingWlxml) {
-            this._updateWlxmlManager();
-        }
-    },
-    setWlxml: function(params) {
-        this.__updatingWlxml = true;
-        if(params.tag !== undefined) {
-            this.setWlxmlTag(params.tag);
-        }
-        if(params.klass !== undefined) {
-            this.setWlxmlClass(params.klass);
-        }
-        this._updateWlxmlManager();
-        this.__updatingWlxml = false;
-    },
-    _updateWlxmlManager: function() {
-        this.manager = wlxmlManagers.getFor(this);
-        this.manager.setup();
+    displayAsBlock: function() {
+        this.dom.css('display', 'block');
+        this._container().css('display', 'block');

     },
     },

-    is: function(what) {
-        if(what === 'list' && _.contains(['list.items', 'list.items.enum'], this.getWlxmlClass())) {
-            return true;
-        }
-        return false;
-    },
-    toggleLabel: function(toggle) {
-        var displayCss = toggle ? 'inline-block' : 'none';
-        var label = this.dom().children('.canvas-widgets').find('.canvas-widget-label');
-        label.css('display', displayCss);
-        this.toggleHighlight(toggle);
+    displayInline: function() {
+        this.dom.css('display', 'inline');
+        this._container().css('display', 'inline');

     },
     },

-
-    toggleHighlight: function(toggle) {
-        this._container().toggleClass('highlighted-element', toggle);
-    },
-
-    toggle: function(toggle) {
-        if(this.manager) {
-            this.manager.toggle(toggle);
-        }
+    displayAs: function(what) {
+        // [this.dom(), this._container()].forEach(e) {
+        //     var isBlock = window.getComputedStyle(e).display === 'block';
+        //     if(!isBlock && what === 'block') {
+        //         e.css('display', what);
+        //     } else if(isBlock && what === 'inline') {
+        //         e.css('display')
+        //     }
+        // })
+        this.dom.css('display', what);
+        this._container().css('display', what);

     }
 });
 
     }
 });
 


@@ -283,25 +205,30 @@ $.extend(DocumentTextElement, {
     }
 });
 
     }
 });
 

-DocumentTextElement.prototype = new DocumentElement();
+DocumentTextElement.prototype = Object.create(DocumentElement.prototype);

 
 $.extend(DocumentTextElement.prototype, {
     createDOM: function() {
 
 $.extend(DocumentTextElement.prototype, {
     createDOM: function() {

-        return $('<div>')
+        var dom = $('<div>')

             .attr('document-text-element', '')
             .text(this.wlxmlNode.getText() || utils.unicode.ZWS);
             .attr('document-text-element', '')
             .text(this.wlxmlNode.getText() || utils.unicode.ZWS);

+        return dom;

     },
     detach: function() {
     },
     detach: function() {

-        this.dom().detach();
-        this.canvas = null;
+        this.dom.detach();

         return this;
     },
     setText: function(text) {
         return this;
     },
     setText: function(text) {

-        this.dom().contents()[0].data = text;
+        if(text === '') {
+            text = utils.unicode.ZWS;
+        }
+        if(text !== this.getText()) {
+            this.dom.contents()[0].data = text;
+        }

     },
     getText: function(options) {
         options = _.extend({raw: false}, options || {});
     },
     getText: function(options) {
         options = _.extend({raw: false}, options || {});

-        var toret = this.dom().text();
+        var toret = this.dom.text();

         if(!options.raw) {
             toret = toret.replace(utils.unicode.ZWS, '');
         }
         if(!options.raw) {
             toret = toret.replace(utils.unicode.ZWS, '');
         }


@@ -309,7 +236,7 @@ $.extend(DocumentTextElement.prototype, {
     },
     isEmpty: function() {
         // Having at least Zero Width Space is guaranteed be Content Observer
     },
     isEmpty: function() {
         // Having at least Zero Width Space is guaranteed be Content Observer

-        return this.dom().contents()[0].data === utils.unicode.ZWS;
+        return this.dom.contents()[0].data === utils.unicode.ZWS;

     },
     after: function(params) {
         if(params instanceof DocumentTextElement || params.text) {
     },
     after: function(params) {
         if(params instanceof DocumentTextElement || params.text) {


@@ -321,9 +248,12 @@ $.extend(DocumentTextElement.prototype, {
         } else {
             element = this.canvas.createElement(params);
         }
         } else {
             element = this.canvas.createElement(params);
         }

-        this.dom().wrap('<div>');
-        this.dom().parent().after(element.dom());
-        this.dom().unwrap();
+        if(element.dom) {
+            this.dom.wrap('<div>');
+            this.dom.parent().after(element.dom);
+            this.dom.unwrap();
+            this.refreshPath();
+        }

         return element;
     },
     before: function(params) {
         return element;
     },
     before: function(params) {


@@ -336,17 +266,22 @@ $.extend(DocumentTextElement.prototype, {
         } else {
             element = this.canvas.createElement(params);
         }
         } else {
             element = this.canvas.createElement(params);
         }

-        this.dom().wrap('<div>');
-        this.dom().parent().before(element.dom());
-        this.dom().unwrap();
+        if(element.dom) {
+            this.dom.wrap('<div>');
+            this.dom.parent().before(element.dom);
+            this.dom.unwrap();
+            this.refreshPath();
+        }

         return element;
     },
 
         return element;
     },
 

-    toggleHighlight: function() {
-        // do nothing for now
+    children: function() {
+        return [];

     }
     }

+

 });
 
 });
 

+

 return {
     DocumentElement: DocumentElement,
     DocumentNodeElement: DocumentNodeElement,
 return {
     DocumentElement: DocumentElement,
     DocumentNodeElement: DocumentNodeElement,