Allow for creating footnote from selected text

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

diff --git a/modules/documentCanvas/canvas/documentElement.js b/modules/documentCanvas/canvas/documentElement.js
index 6fea275..cfdac5d 100644 (file)
--- a/modules/documentCanvas/canvas/documentElement.js
+++ b/modules/documentCanvas/canvas/documentElement.js
@@ -1,144 +1,562 @@
 define([
 define([

-'libs/jquery-1.9.1.min'
-], function($) {
+'libs/jquery-1.9.1.min',
+'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
-var DocumentElement = function(htmlElement) {
+
+// DocumentElement represents a text or an element node from WLXML document rendered inside Canvas
+var DocumentElement = function(htmlElement, canvas) {

     if(arguments.length === 0)
         return;
     if(arguments.length === 0)
         return;

-    this.$element = $(htmlElement);
-    this.wlxmlTag = this.$element.prop('tagName');
+    this.canvas = canvas;
+    this._setupDOMHandler(htmlElement);
+}
+
+var elementTypeFromParams = function(params) {
+    return params.text !== undefined ? DocumentTextElement : DocumentNodeElement;
+

 };
 
 };
 

-$.extend(DocumentElement.prototype, {
-    children: function() {
-        var toret = [];
-        if(this instanceof DocumentTextElement)
-            return toret;
+$.extend(DocumentElement, {
+    create: function(params, canvas) {
+        return elementTypeFromParams(params).create(params);
+    },

 
 

+    createDOM: function(params) {
+        return elementTypeFromParams(params).createDOM(params);
+    },

 
 

-        var elementContent = this.$element.contents();
-        elementContent.each(function(idx) {
-            var element = documentElementFromHTMLElement(this);
-            if(idx === 0 && elementContent.length > 1 && elementContent[1].nodeType === Node.ELEMENT_NODE && (element instanceof DocumentTextElement) && $.trim($(this).text()) === '')
-                return true;
-            if(idx > 0 && element instanceof DocumentTextElement) {
-                if(toret[toret.length-1] instanceof DocumentNodeElement && $.trim($(this).text()) === '')
-                    return true;
-            }
-            toret.push(element);
-        });
-        return toret;
+    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, {
+    _setupDOMHandler: function(htmlElement) {
+        this.$element = $(htmlElement);
+    },
+    bound: function() {
+        return this.canvas !== undefined;
+    },
+    dom: function() {
+        return this.$element;

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

-        return documentElementFromHTMLElement(this.$element.parent()[0]);
+        var parents = this.$element.parents('[document-node-element]');
+        if(parents.length)
+            return DocumentElement.fromHTMLElement(parents[0], this.canvas);
+        return null;
+    },
+
+    parents: function() {
+        var parents = [],
+            parent = this.parent();
+        while(parent) {
+            parents.push(parent);
+            parent = parent.parent();
+        }
+        return parents;

     },
 
     sameNode: function(other) {
     },
 
     sameNode: function(other) {

-        return other && (typeof other === typeof this) && other.$element[0] === this.$element[0];
+        return other && (typeof other === typeof this) && other.dom()[0] === this.dom()[0];

     },
 
     wrapWithNodeElement: function(wlxmlNode) {
     },
 
     wrapWithNodeElement: function(wlxmlNode) {

-        this.$element.wrap($('<' + wlxmlNode.tag + ' class="' + wlxmlNode.klass + '"">')[0]);
-        return documentElementFromHTMLElement(this.$element.parent().get(0));
+        var wrapper = DocumentNodeElement.create({tag: wlxmlNode.tag, klass: wlxmlNode.klass});
+        this.dom().replaceWith(wrapper.dom());
+        wrapper.append(this);
+        return wrapper;

     },
 
     },
 

-    childIndex: function(child) {
-        var children = this.children(),
-            toret = null;
-        children.forEach(function(c, idx) {
-            if(c.sameNode(child)) {
-                toret = idx;
-                return false;
+    detach: function() {
+        this.dom().detach();
+        this.canvas = null;
+        return this;
+    },
+
+    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;
             }
         });
         return toret;

+    },
+
+    isVisible: function() {
+        return this instanceof DocumentTextElement || this.getWlxmlTag() !== 'metadata';

     }
 });
 
     }
 });
 

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

 
 

-var DocumentTextElement = function(htmlElement) {
-    DocumentElement.call(this, htmlElement);  
+// DocumentNodeElement represents an element node from WLXML document rendered inside Canvas
+var DocumentNodeElement = function(htmlElement, canvas) {
+    DocumentElement.call(this, htmlElement, canvas);

 };
 
 };
 

-DocumentNodeElement.prototype = new DocumentElement();
-DocumentTextElement.prototype = new DocumentElement();
+$.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);
+
+        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 manipulate = function(e, params, action) {

-    var dom;
+    var element;

     if(params instanceof DocumentElement) {
     if(params instanceof DocumentElement) {

-        dom = params.dom()
+        element = params;

     } else {
     } else {

-        dom = DocumentNodeElement.createDOM(params);
+        element = DocumentElement.create(params);

     }
     }

-    e.$element[action](dom);
-    return documentElementFromHTMLElement(dom);
+    var target = (action === 'append' || action === 'prepend') ? e._container() : e.dom();
+    target[action](element.dom());
+    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 = [];
+        if(this instanceof DocumentTextElement)
+            return toret;
+
+
+        var elementContent = this._container().contents();
+        var element = this;
+        elementContent.each(function(idx) {
+            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(toret[toret.length-1] instanceof DocumentNodeElement && $.trim($(this).text()) === '')
+                    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');
+    },
+    setWlxmlTag: function(tag) {
+        if(tag === this.getWlxmlTag())
+            return;
+
+        this._container().attr('wlxml-tag', tag);
+        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;
+
+        this.getWlxmlMetaAttrs().forEach(function(attr) {
+            if(!classAttributes.hasMetaAttr(klass, attr.name))
+                this.dom().removeAttr('wlxml-meta-' + attr.name);
+        }, this);
+
+        if(klass)
+            this._container().attr('wlxml-class', klass.replace(/\./g, '-'));
+        else
+            this._container().removeAttr('wlxml-class');
+        this._updateWlxmlManager();
+    },
+    _updateWlxmlManager: function() {
+        var manager = wlxmlManagers.getFor(this);
+        this.data('_wlxmlManager', manager);
+        manager.setup();
+    },
+    is: function(what) {
+        if(what === 'list' && _.contains(['list.items', 'list.items.enum'], this.getWlxmlClass()))
+            return true;
+        return false;
+    },
+
+    getWlxmlMetaAttr: function(attr) {
+        return this.dom().attr('wlxml-meta-'+attr);
+    },
+
+    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;
+    },
+
+    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);
+    },
+
+    toggleHighlight: function(toogle) {
+        this._container().toggleClass('highlighted-element');
+    },
+
+    toggle: function(toggle) {
+        var mng = this.data('_wlxmlManager');
+        if(mng) {
+            mng.toggle(toggle);
+        }

     }
 });
 
     }
 });
 

-DocumentNodeElement.createDOM = function(params) {
-    var dom;
-    if(params.text) {
-        dom = $(document.createTextNode(params.text));
-    } else {
-        dom = $('<' + params.tag + '>');
-        if(params.klass)
-            dom.attr('class', params.klass);
-    }
-    return dom;
+
+// 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.$element[0].data = text;
+        this.dom().contents()[0].data = text;

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

-        return this.$element.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) {
     },
     after: function(params) {

-        if(params.text || params instanceof DocumentTextElement)
+        if(params instanceof DocumentTextElement || params.text)

             return false;
             return false;

-        var dom;
+        var element;

         if(params instanceof DocumentNodeElement) {
         if(params instanceof DocumentNodeElement) {

-            dom = params.dom();
+            element = params;
+        } else {
+            element = DocumentNodeElement.create(params, this.canvas);
+        }
+        this.dom().wrap('<div>');
+        this.dom().parent().after(element.dom());
+        this.dom().unwrap();
+        return element;
+    },
+    before: function(params) {
+        if(params instanceof DocumentTextElement || params.text)
+            return false;
+        var element;
+        if(params instanceof DocumentNodeElement) {
+            element = params;
+        } else {
+            element = DocumentNodeElement.create(params, this.canvas);
+        }
+        this.dom().wrap('<div>');
+        this.dom().parent().before(element.dom());
+        this.dom().unwrap();
+        return element;
+    },
+    wrapWithNodeElement: function(wlxmlNode) {
+        if(typeof wlxmlNode.start === 'number' && typeof wlxmlNode.end === 'number') {
+            return this.canvas.wrapText({
+                inside: this.parent(),
+                textNodeIdx: this.parent().childIndex(this),
+                offsetStart: Math.min(wlxmlNode.start, wlxmlNode.end),
+                offsetEnd: Math.max(wlxmlNode.start, wlxmlNode.end),
+                _with: {tag: wlxmlNode.tag, klass: wlxmlNode.klass}
+            });

         } else {
         } else {

-            dom = DocumentNodeElement.createDOM(params);
+            return DocumentElement.prototype.wrapWithNodeElement.call(this, wlxmlNode);
+        }
+    },
+    unwrap: function() {
+        var parent = this.parent(),
+            toret;
+        if(parent.children().length === 1) {
+            toret = parent.parent();
+            var grandParent = parent.parent();
+            if(grandParent) {
+                var grandParentChildren = grandParent.children(),
+                    idx = grandParent.childIndex(parent),
+                    prev = idx - 1 > -1 ? grandParentChildren[idx-1] : null,
+                    next = idx + 1 < grandParentChildren.length ? grandParentChildren[idx+1] : null;
+                
+                prev = (prev instanceof DocumentTextElement) ? prev : null;
+                next = (next instanceof DocumentTextElement) ? next : null;
+
+                if(prev && next) {
+                    prev.setText(prev.getText() + this.getText() + next.getText());
+                    next.detach();
+                } else if (prev || next) {
+                    var target = prev ? prev : next;
+                    target.setText(target.getText() + this.getText());
+                } else {
+                    parent.after(this);
+                }
+            } else {
+                parent.after(this);
+            }
+            parent.detach();
+            return toret;

         }
         }

-        this.$element.wrap('<div>');
-        this.$element.parent().after(dom[0]);
-        this.$element.unwrap();
-        return documentElementFromHTMLElement(dom[0]);
+    },
+    split: function(params) {
+        var parentElement = this.parent(),
+            myIdx = parentElement.childIndex(this),
+            myCanvas = this.canvas,
+            passed = false,
+            succeedingChildren = [],
+            thisElement = this,
+            prefix = this.getText().substr(0, params.offset),
+            suffix = this.getText().substr(params.offset);
+
+        parentElement.children().forEach(function(child) {
+            if(passed)
+                succeedingChildren.push(child);
+            if(child.sameNode(thisElement))
+                passed = true;
+        });
+
+        if(prefix.length > 0)
+            this.setText(prefix);
+        else
+            this.detach();
+        
+        var newElement = DocumentNodeElement.create({tag: parentElement.getWlxmlTag(), klass: parentElement.getWlxmlClass()}, myCanvas);
+        parentElement.after(newElement);
+
+        if(suffix.length > 0)
+            newElement.append({text: suffix});
+        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) {
-    if(htmlElement.nodeType === Node.ELEMENT_NODE)
-        return new DocumentNodeElement(htmlElement);
-    if(htmlElement.nodeType === Node.TEXT_NODE)
-        return new DocumentTextElement(htmlElement);
-};
-

 return {
 return {

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

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