canvas api: getting sibling parents of two elements

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

diff --git a/modules/documentCanvas/canvas/documentElement.js b/modules/documentCanvas/canvas/documentElement.js
index 937e9d9..9768236 100644 (file)
--- a/modules/documentCanvas/canvas/documentElement.js
+++ b/modules/documentCanvas/canvas/documentElement.js
@@ -1,30 +1,74 @@
 define([
 'libs/jquery-1.9.1.min',
 define([
 'libs/jquery-1.9.1.min',

-'libs/underscore-min'
-], function($, _) {
+'libs/underscore-min',
+'modules/documentCanvas/classAttributes',
+'modules/documentCanvas/canvas/utils',
+'modules/documentCanvas/canvas/widgets',
+'modules/documentCanvas/canvas/wlxmlManagers'
+], function($, _, classAttributes, utils, widgets, wlxmlManagers) {

     
 'use strict';
 
 
     
 'use strict';
 
 

-// DocumentElement represents a node from WLXML document rendered inside Canvas
+// DocumentElement represents a text or an element node from WLXML document rendered inside Canvas

 var DocumentElement = function(htmlElement, canvas) {
     if(arguments.length === 0)
         return;
     this.canvas = canvas;
 var DocumentElement = function(htmlElement, canvas) {
     if(arguments.length === 0)
         return;
     this.canvas = canvas;

-    this.$element = $(htmlElement);
+    this._setupDOMHandler(htmlElement);

 }
 
 }
 

+var elementTypeFromParams = function(params) {
+    return params.text !== undefined ? DocumentTextElement : DocumentNodeElement;
+
+};
+
+$.extend(DocumentElement, {
+    create: function(params, canvas) {
+        return elementTypeFromParams(params).create(params);
+    },
+
+    createDOM: function(params) {
+        return elementTypeFromParams(params).createDOM(params);
+    },
+
+    fromHTMLElement: function(htmlElement, canvas) {
+        var $element = $(htmlElement);
+        if(htmlElement.nodeType === Node.ELEMENT_NODE && $element.attr('document-node-element') !== undefined)
+            return DocumentNodeElement.fromHTMLElement(htmlElement, canvas);
+        if($element.attr('document-text-element') !== undefined || (htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined))
+            return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
+        return undefined;
+    }
+});
+

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

+    _setupDOMHandler: function(htmlElement) {
+        this.$element = $(htmlElement);
+    },
+    bound: function() {
+        return this.canvas !== undefined;
+    },

     dom: function() {
         return this.$element;
     },
     parent: function() {
     dom: function() {
         return this.$element;
     },
     parent: function() {

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

         if(parents.length)
         if(parents.length)

-            return documentElementFromHTMLElement(parents[0], this.canvas);
+            return DocumentElement.fromHTMLElement(parents[0], this.canvas);

         return null;
     },
 
         return null;
     },
 

+    parents: function() {
+        var parents = [],
+            parent = this.parent();
+        while(parent) {
+            parents.push(parent);
+            parent = parent.parent();
+        }
+        return parents;
+    },
+

     sameNode: function(other) {
         return other && (typeof other === typeof this) && other.dom()[0] === this.dom()[0];
     },
     sameNode: function(other) {
         return other && (typeof other === typeof this) && other.dom()[0] === this.dom()[0];
     },


@@ -39,20 +83,80 @@ $.extend(DocumentElement.prototype, {
     detach: function() {
         this.dom().detach();
         this.canvas = null;
     detach: function() {
         this.dom().detach();
         this.canvas = null;

+    },
+
+    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;
+    },
+
+    isVisible: function() {
+        return this instanceof DocumentTextElement || this.getWlxmlTag() !== 'metadata';

     }
 });
 
 
     }
 });
 
 

+// DocumentNodeElement represents an element node from WLXML document rendered inside Canvas

 var DocumentNodeElement = function(htmlElement, canvas) {
     DocumentElement.call(this, htmlElement, canvas);
 };
 
 var DocumentNodeElement = function(htmlElement, canvas) {
     DocumentElement.call(this, htmlElement, canvas);
 };
 

-var DocumentTextElement = function(htmlElement, canvas) {
-    DocumentElement.call(this, htmlElement, canvas);
-};
+$.extend(DocumentNodeElement, {
+    createDOM: function(params, canvas) {
+        var dom = $('<div>')
+                .attr('document-node-element', ''),
+            widgetsContainer = $('<div>')
+                .addClass('canvas-widgets')
+                .attr('contenteditable', false),
+            container = $('<div>')
+                .attr('document-element-content', '');
+        
+        dom.append(widgetsContainer, container);
+        // Make sure widgets aren't navigable with arrow keys
+        widgetsContainer.find('*').add(widgetsContainer).attr('tabindex', -1);

 
 

-DocumentNodeElement.prototype = new DocumentElement();
-DocumentTextElement.prototype = new DocumentElement();
+        var element = this.fromHTMLElement(dom[0], canvas);
+
+        element.setWlxmlTag(params.tag);
+        if(params.klass)
+            element.setWlxmlClass(params.klass);
+        if(params.meta) {
+            _.keys(params.meta).forEach(function(key) {
+                element.setWlxmlMetaAttr(key, params.meta[key]);
+            });
+        }
+        element.data('other-attrs', params.others);
+
+        if(params.rawChildren) {
+            container.append(params.rawChildren);
+        }
+        return dom;
+    },
+
+    create: function(params, canvas) {
+        return this.fromHTMLElement(this.createDOM(params, canvas)[0], canvas);
+    },
+
+    fromHTMLElement: function(htmlElement, canvas) {
+        return new this(htmlElement, canvas);
+    }
+});

 
 var manipulate = function(e, params, action) {
     var element;
 
 var manipulate = function(e, params, action) {
     var element;


@@ -61,20 +165,107 @@ var manipulate = function(e, params, action) {
     } else {
         element = DocumentElement.create(params);
     }
     } else {
         element = DocumentElement.create(params);
     }

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

     return element;
 };
 
     return element;
 };
 

+DocumentNodeElement.prototype = new DocumentElement();
+
+

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

+    _container: function() {
+        return this.dom().children('[document-element-content]');
+    },
+    data: function() {
+        var dom = this.dom(),
+            args = Array.prototype.slice.call(arguments, 0);
+        if(args.length === 2 && args[1] === undefined)
+            return dom.removeData(args[0]);
+        return dom.data.apply(dom, arguments);
+    },
+    toXML: function(level) {
+        var node = $('<' + this.getWlxmlTag() + '>');
+
+        if(this.getWlxmlClass())
+            node.attr('class', this.getWlxmlClass());
+        var meta = this.getWlxmlMetaAttrs();
+        meta.forEach(function(attr) {
+            if(attr.value)
+                node.attr('meta-' + attr.name, attr.value);
+        });
+        _.keys(this.data('other-attrs') || {}).forEach(function(key) {
+            node.attr(key, this.data('other-attrs')[key]);
+        }, this);
+
+        var addFormatting = function() {
+            var toret = $('<div>');
+            var formattings = {};
+
+            if(this.data('orig-before') !== undefined) {
+                if(this.data('orig-before')) {
+                    toret.prepend(document.createTextNode(this.data('orig-before')));
+                }
+            } else if(level && this.getWlxmlTag() !== 'span') {
+                toret.append('\n' + (new Array(level * 2 + 1)).join(' '));
+            }
+
+            toret.append(node);
+
+            if(this.data('orig-after')) {
+                toret.append(document.createTextNode(this.data('orig-after')));
+            }
+
+            /* Inside node */
+            if(this.data('orig-begin')) {
+                node.prepend(this.data('orig-begin'));
+                formattings.begin = true;
+            }
+
+            if(this.data('orig-end') !== undefined) {
+                if(this.data('orig-end')) {
+                    node.append(this.data('orig-end'));
+                }
+            } else if(this.getWlxmlTag() !== 'span' && children.length){
+                node.append('\n' + (new Array(level * 2 + 1)).join(' '));
+            }
+           
+            return {parts: toret.contents(), formattings: formattings};
+        }.bind(this);
+
+        
+        
+        var children = this.children(),
+            childParts;
+
+        var formatting = addFormatting(node);
+
+        for(var i = children.length - 1; i >= 0; i--) {
+            childParts = children[i].toXML(level + 1);
+            if(typeof childParts === 'string')
+                childParts = [document.createTextNode(childParts)];
+
+            if(formatting.formattings.begin) {
+                $(node.contents()[0]).after(childParts);
+            } else
+                node.prepend(childParts);
+        }
+        return formatting.parts;
+    },

     append: function(params) {
     append: function(params) {

-        manipulate(this, params, 'append');
+        if(params.tag !== 'span')
+            this.data('orig-end', undefined);
+        return manipulate(this, params, 'append');
+    },
+    prepend: function(params) {
+        return manipulate(this, params, 'prepend');

     },
     before: function(params) {
     },
     before: function(params) {

-        manipulate(this, params, 'before');
+        return manipulate(this, params, 'before');

 
     },
     after: function(params) {
 
     },
     after: function(params) {

-        manipulate(this, params, 'after');
+        return manipulate(this, params, 'after');

     },
     children: function() {
         var toret = [];
     },
     children: function() {
         var toret = [];


@@ -82,10 +273,12 @@ $.extend(DocumentNodeElement.prototype, {
             return toret;
 
 
             return toret;
 
 

-        var elementContent = this.dom().contents();
+        var elementContent = this._container().contents();

         var element = this;
         elementContent.each(function(idx) {
         var element = this;
         elementContent.each(function(idx) {

-            var childElement = documentElementFromHTMLElement(this, element.canvas);
+            var childElement = DocumentElement.fromHTMLElement(this, element.canvas);
+            if(childElement === undefined)
+                return true;

             if(idx === 0 && elementContent.length > 1 && elementContent[1].nodeType === Node.ELEMENT_NODE && (childElement instanceof DocumentTextElement) && $.trim($(this).text()) === '')
                 return true;
             if(idx > 0 && childElement instanceof DocumentTextElement) {
             if(idx === 0 && elementContent.length > 1 && elementContent[1].nodeType === Node.ELEMENT_NODE && (childElement instanceof DocumentTextElement) && $.trim($(this).text()) === '')
                 return true;
             if(idx > 0 && childElement instanceof DocumentTextElement) {


@@ -108,67 +301,130 @@ $.extend(DocumentNodeElement.prototype, {
         return toret;
     },
     getWlxmlTag: function() {
         return toret;
     },
     getWlxmlTag: function() {

-        return this.dom().attr('wlxml-tag');
+        return this._container().attr('wlxml-tag');

     },
     setWlxmlTag: function(tag) {
     },
     setWlxmlTag: function(tag) {

-        this.dom().attr('wlxml-tag', tag);
+        if(tag === this.getWlxmlTag())
+            return;
+
+        this._container().attr('wlxml-tag', tag);
+        this._updateWlxmlManager();

     },
     getWlxmlClass: function() {
     },
     getWlxmlClass: function() {

-        var klass = this.dom().attr('wlxml-class');
+        var klass = this._container().attr('wlxml-class');

         if(klass)
         if(klass)

-            return klass.replace('-', '.');
+            return klass.replace(/-/g, '.');

         return undefined;
     },
     setWlxmlClass: function(klass) {
         return undefined;
     },
     setWlxmlClass: function(klass) {

+        if(klass === this.getWlxmlClass())
+            return;
+
+        this.getWlxmlMetaAttrs().forEach(function(attr) {
+            if(!classAttributes.hasMetaAttr(klass, attr.name))
+                this.dom().removeAttr('wlxml-meta-' + attr.name);
+        }, this);
+

         if(klass)
         if(klass)

-            this.dom().attr('wlxml-class', klass);
+            this._container().attr('wlxml-class', klass.replace(/\./g, '-'));

         else
         else

-            this.dom().removeAttr('wlxml-class');
+            this._container().removeAttr('wlxml-class');
+        this._updateWlxmlManager();
+    },
+    _updateWlxmlManager: function() {
+        var manager = wlxmlManagers.getFor(this);
+        this.data('_wlxmlManager', manager);
+        manager.setup();

     },
     is: function(what) {
     },
     is: function(what) {

-        if(what === 'list' && _.contains(['list-items', 'list-items-enum'], this.dom().attr('wlxml-class')))
+        if(what === 'list' && _.contains(['list.items', 'list.items.enum'], this.getWlxmlClass()))

             return true;
         return false;
             return true;
         return false;

-    }
-});
+    },

 
 

+    getWlxmlMetaAttr: function(attr) {
+        return this.dom().attr('wlxml-meta-'+attr);
+    },

 
 

-DocumentElement.create = function(params, canvas) {
-    var ElementType = params.text !== undefined ? DocumentTextElement : DocumentNodeElement;
-    return ElementType.create(params);
-};
+    getWlxmlMetaAttrs: function() {
+        var toret = [];
+        var attrList = classAttributes.getMetaAttrsList(this.getWlxmlClass());
+        attrList.all.forEach(function(attr) {
+            toret.push({name: attr.name, value: this.getWlxmlMetaAttr(attr.name) || ''});
+        }, this);
+        return toret;
+    },

 
 

-DocumentElement.createDOM = function(params) {
-    var ElementType = params.text !== undefined ? DocumentTextElement : DocumentNodeElement;
-    return ElementType.createDOM(params);
-};
+    setWlxmlMetaAttr: function(attr, value) {
+        this.dom().attr('wlxml-meta-'+attr, value);
+    },
+    
+    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);
+    },

 
 

-DocumentNodeElement.createDOM = function(params) {
-    var dom = $('<div>').attr('wlxml-tag', params.tag);
-    if(params.klass)
-        dom.attr('wlxml-class', params.klass);
-    return dom;
-};
+    toggleHighlight: function(toogle) {
+        this._container().toggleClass('highlighted-element');
+    },

 
 

-DocumentTextElement.createDOM = function(params) {
-    return $(document.createTextNode(params.text));
-};
+    toggle: function(toggle) {
+        var mng = this.data('_wlxmlManager');
+        if(mng) {
+            mng.toggle(toggle);
+        }
+    }
+});

 
 

-DocumentNodeElement.create = function(params, canvas) {
-    return documentElementFromHTMLElement(DocumentNodeElement.createDOM(params)[0]);
-};

 
 

-DocumentTextElement.create = function(params, canvas) {
-    return documentElementFromHTMLElement(DocumentTextElement.createDOM(params)[0]);
+// DocumentNodeElement represents a text node from WLXML document rendered inside Canvas
+var DocumentTextElement = function(htmlElement, canvas) {
+    DocumentElement.call(this, htmlElement, canvas);

 };
 
 };
 

+$.extend(DocumentTextElement, {
+    createDOM: function(params) {
+        return $('<div>')
+            .attr('document-text-element', '')
+            .text(params.text || utils.unicode.ZWS);
+    },
+
+    create: function(params, canvas) {
+        return this.fromHTMLElement(this.createDOM(params)[0]);
+    },
+
+    fromHTMLElement: function(htmlElement, canvas) {
+        return new this(htmlElement, canvas);
+    },
+    isContentContainer: function(htmlElement) {
+        return htmlElement.nodeType === Node.TEXT_NODE && $(htmlElement).parent().is('[document-text-element]');
+    }
+});
+
+DocumentTextElement.prototype = new DocumentElement();

 
 $.extend(DocumentTextElement.prototype, {
 
 $.extend(DocumentTextElement.prototype, {

+    toXML: function(parent) {
+        return this.getText();
+    },
+    _setupDOMHandler: function(htmlElement) {
+        var $element = $(htmlElement);
+        if(htmlElement.nodeType === Node.TEXT_NODE)
+            this.$element = $element.parent();
+        else
+            this.$element = $element;
+    },

     setText: function(text) {
     setText: function(text) {

-        this.dom()[0].data = text;
+        this.dom().contents()[0].data = text;

     },
     getText: function() {
     },
     getText: function() {

-        return this.dom().text();
+        return this.dom().text().replace(utils.unicode.ZWS, '');
+    },
+    isEmpty: function() {
+        // Having at least Zero Width Space is guaranteed be Content Observer
+        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)


@@ -177,7 +433,7 @@ $.extend(DocumentTextElement.prototype, {
         if(params instanceof DocumentNodeElement) {
             element = params;
         } else {
         if(params instanceof DocumentNodeElement) {
             element = params;
         } else {

-            element = DocumentNodeElement.create(params);
+            element = DocumentNodeElement.create(params, this.canvas);

         }
         this.dom().wrap('<div>');
         this.dom().parent().after(element.dom());
         }
         this.dom().wrap('<div>');
         this.dom().parent().after(element.dom());


@@ -191,7 +447,7 @@ $.extend(DocumentTextElement.prototype, {
         if(params instanceof DocumentNodeElement) {
             element = params;
         } else {
         if(params instanceof DocumentNodeElement) {
             element = params;
         } else {

-            element = DocumentNodeElement.create(params);
+            element = DocumentNodeElement.create(params, this.canvas);

         }
         this.dom().wrap('<div>');
         this.dom().parent().before(element.dom());
         }
         this.dom().wrap('<div>');
         this.dom().parent().before(element.dom());


@@ -212,8 +468,10 @@ $.extend(DocumentTextElement.prototype, {
         }
     },
     unwrap: function() {
         }
     },
     unwrap: function() {

-        var parent = this.parent();
+        var parent = this.parent(),
+            toret;

         if(parent.children().length === 1) {
         if(parent.children().length === 1) {

+            toret = parent.parent();

             var grandParent = parent.parent();
             if(grandParent) {
                 var grandParentChildren = grandParent.children(),
             var grandParent = parent.parent();
             if(grandParent) {
                 var grandParentChildren = grandParent.children(),


@@ -233,6 +491,7 @@ $.extend(DocumentTextElement.prototype, {
                 parent.after(this);
             }
             parent.detach();
                 parent.after(this);
             }
             parent.detach();

+            return toret;

         }
     },
     split: function(params) {
         }
     },
     split: function(params) {


@@ -265,22 +524,34 @@ $.extend(DocumentTextElement.prototype, {
         succeedingChildren.forEach(function(child) {
             newElement.append(child);
         });
         succeedingChildren.forEach(function(child) {
             newElement.append(child);
         });

+
+        return {first: parentElement, second: newElement};
+    },
+    divide: function(params) {
+        var myText = this.getText();
+
+        if(params.offset === myText.length)
+            return this.after(params);
+        if(params.offset === 0)
+            return this.before(params);
+
+        var lhsText = myText.substr(0, params.offset),
+            rhsText = myText.substr(params.offset),
+            newElement = DocumentNodeElement.create({tag: params.tag, klass: params.klass}, this.canvas),
+            rhsTextElement = DocumentTextElement.create({text: rhsText});
+
+        this.setText(lhsText);
+        this.after(newElement);
+        newElement.after(rhsTextElement);
+        return newElement;
+    },
+
+    toggleHighlight: function() {
+        // do nothing for now

     }
 });
 
     }
 });
 

-var documentElementFromHTMLElement = function(htmlElement, canvas) {
-    // if(!canvas)
-    //    throw 'no canvas specified';
-    if(htmlElement.nodeType === Node.ELEMENT_NODE)
-        return new DocumentNodeElement(htmlElement, canvas);
-    if(htmlElement.nodeType === Node.TEXT_NODE)
-        return new DocumentTextElement(htmlElement, canvas);
-};
-

 return {
 return {

-    wrap: function(htmlElement, canvas) {
-        return documentElementFromHTMLElement(htmlElement, canvas);
-    },

     DocumentElement: DocumentElement,
     DocumentNodeElement: DocumentNodeElement,
     DocumentTextElement: DocumentTextElement
     DocumentElement: DocumentElement,
     DocumentNodeElement: DocumentNodeElement,
     DocumentTextElement: DocumentTextElement