modules/documentCanvas/canvas/documentElement.js

   1 define([
   2 'libs/jquery-1.9.1.min',
   3 'libs/underscore-min',
   4 'modules/documentCanvas/classAttributes',
   5 'modules/documentCanvas/canvas/utils'
   6 ], function($, _, classAttributes, utils) {
   7
   8 'use strict';
   9
  10
  11 // DocumentElement represents a text or an element node from WLXML document rendered inside Canvas
  12 var DocumentElement = function(htmlElement, canvas) {
  13     if(arguments.length === 0)
  14         return;
  15     this.canvas = canvas;
  16     this._setupDOMHandler(htmlElement);
  17 }
  18
  19 var elementTypeFromParams = function(params) {
  20     return params.text !== undefined ? DocumentTextElement : DocumentNodeElement;
  21
  22 };
  23
  24 $.extend(DocumentElement, {
  25     create: function(params, canvas) {
  26         return elementTypeFromParams(params).create(params);
  27     },
  28
  29     createDOM: function(params) {
  30         return elementTypeFromParams(params).createDOM(params);
  31     },
  32
  33     fromHTMLElement: function(htmlElement, canvas) {
  34         var $element = $(htmlElement);
  35         if(htmlElement.nodeType === Node.ELEMENT_NODE && $element.attr('wlxml-tag'))
  36             return DocumentNodeElement.fromHTMLElement(htmlElement, canvas);
  37         if($element.attr('wlxml-text') !== undefined || (htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('wlxml-text') !== undefined))
  38             return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
  39         return undefined;
  40     }
  41 });
  42
  43 $.extend(DocumentElement.prototype, {
  44     _setupDOMHandler: function(htmlElement) {
  45         this.$element = $(htmlElement);
  46     },
  47     dom: function() {
  48         return this.$element;
  49     },
  50     parent: function() {
  51         var parents = this.$element.parents('[wlxml-tag]');
  52         if(parents.length)
  53             return DocumentElement.fromHTMLElement(parents[0], this.canvas);
  54         return null;
  55     },
  56
  57     parents: function() {
  58         var parents = [],
  59             parent = this.parent();
  60         while(parent) {
  61             parents.push(parent);
  62             parent = parent.parent();
  63         }
  64         return parents;
  65     },
  66
  67     sameNode: function(other) {
  68         return other && (typeof other === typeof this) && other.dom()[0] === this.dom()[0];
  69     },
  70
  71     wrapWithNodeElement: function(wlxmlNode) {
  72         var wrapper = DocumentNodeElement.create({tag: wlxmlNode.tag, klass: wlxmlNode.klass});
  73         this.dom().replaceWith(wrapper.dom());
  74         wrapper.append(this);
  75         return wrapper;
  76     },
  77
  78     detach: function() {
  79         this.dom().detach();
  80         this.canvas = null;
  81     },
  82
  83     markAsCurrent: function() {
  84         this.canvas.markAsCurrent(this);
  85     },
  86
  87     getVerticallyFirstTextElement: function() {
  88         var toret;
  89         this.children().some(function(child) {
  90             if(!child.isVisible())
  91                 return false; // continue
  92             if(child instanceof DocumentTextElement) {
  93                 toret = child;
  94                 return true; // break
  95             } else {
  96                 toret = child.getVerticallyFirstTextElement();
  97                 if(toret)
  98                     return true; // break
  99             }
 100         });
 101         return toret;
 102     },
 103
 104     isVisible: function() {
 105         return this instanceof DocumentTextElement || this.getWlxmlTag() !== 'metadata';
 106     }
 107 });
 108
 109
 110 // DocumentNodeElement represents an element node from WLXML document rendered inside Canvas
 111 var DocumentNodeElement = function(htmlElement, canvas) {
 112     DocumentElement.call(this, htmlElement, canvas);
 113 };
 114
 115 $.extend(DocumentNodeElement, {
 116     createDOM: function(params) {
 117         var dom = $('<div>')
 118             .attr('wlxml-tag', params.tag);
 119         if(params.klass)
 120             dom.attr('wlxml-class', params.klass.replace(/\./g, '-'));
 121         if(params.meta) {
 122             _.keys(params.meta).forEach(function(key) {
 123                 dom.attr('wlxml-meta-'+key, params.meta[key]);
 124             });
 125         }
 126         dom.data('other-attrs', params.others);
 127
 128         var widgets = $('<div class="canvas-widgets" contenteditable="false">');
 129         widgets.append($('<span class="canvas-widget canvas-widget-label">').text(params.tag + (params.klass ? ' / ' + params.klass : '')));
 130         dom.append(widgets);
 131
 132         // Make sure widgets aren't navigable with arrow keys
 133         widgets.find('*').add(widgets).attr('tabindex', -1);
 134
 135         return dom;
 136     },
 137
 138     create: function(params, canvas) {
 139         return this.fromHTMLElement(this.createDOM(params)[0]);
 140     },
 141
 142     fromHTMLElement: function(htmlElement, canvas) {
 143         return new this(htmlElement, canvas);
 144     }
 145 });
 146
 147 var manipulate = function(e, params, action) {
 148     var element;
 149     if(params instanceof DocumentElement) {
 150         element = params;
 151     } else {
 152         element = DocumentElement.create(params);
 153     }
 154     e.dom()[action](element.dom());
 155     return element;
 156 };
 157
 158 DocumentNodeElement.prototype = new DocumentElement();
 159
 160
 161 $.extend(DocumentNodeElement.prototype, {
 162     data: function() {
 163         var dom = this.dom(),
 164             args = Array.prototype.slice.call(arguments, 0);
 165         if(args.length === 2 && args[1] === undefined)
 166             return dom.removeData(args[0]);
 167         return dom.data.apply(dom, arguments);
 168     },
 169     toXML: function(level) {
 170         var node = $('<' + this.getWlxmlTag() + '>');
 171
 172         if(this.getWlxmlClass())
 173             node.attr('class', this.getWlxmlClass());
 174         var meta = this.getWlxmlMetaAttrs();
 175         meta.forEach(function(attr) {
 176             if(attr.value)
 177                 node.attr('meta-' + attr.name, attr.value);
 178         });
 179         _.keys(this.data('other-attrs') || {}).forEach(function(key) {
 180             node.attr(key, this.data('other-attrs')[key]);
 181         }, this);
 182
 183         var addFormatting = function() {
 184             var toret = $('<div>');
 185             var formattings = {};
 186
 187             if(this.data('orig-before') !== undefined) {
 188                 if(this.data('orig-before')) {
 189                     toret.prepend(document.createTextNode(this.data('orig-before')));
 190                 }
 191             } else if(level && this.getWlxmlTag() !== 'span') {
 192                 toret.append('\n' + (new Array(level * 2 + 1)).join(' '));
 193             }
 194
 195             toret.append(node);
 196
 197             if(this.data('orig-after')) {
 198                 toret.append(document.createTextNode(this.data('orig-after')));
 199             }
 200
 201             /* Inside node */
 202             if(this.data('orig-begin')) {
 203                 node.prepend(this.data('orig-begin'));
 204                 formattings.begin = true;
 205             }
 206
 207             if(this.data('orig-end') !== undefined) {
 208                 if(this.data('orig-end')) {
 209                     node.append(this.data('orig-end'));
 210                 }
 211             } else if(this.getWlxmlTag() !== 'span' && children.length){
 212                 node.append('\n' + (new Array(level * 2 + 1)).join(' '));
 213             }
 214
 215             return {parts: toret.contents(), formattings: formattings};
 216         }.bind(this);
 217
 218
 219
 220         var children = this.children(),
 221             childParts;
 222
 223         var formatting = addFormatting(node);
 224
 225         for(var i = children.length - 1; i >= 0; i--) {
 226             childParts = children[i].toXML(level + 1);
 227             if(typeof childParts === 'string')
 228                 childParts = [document.createTextNode(childParts)];
 229
 230             if(formatting.formattings.begin) {
 231                 $(node.contents()[0]).after(childParts);
 232             } else
 233                 node.prepend(childParts);
 234         }
 235         return formatting.parts;
 236     },
 237     append: function(params) {
 238         if(params.tag !== 'span')
 239             this.data('orig-end', undefined);
 240         return manipulate(this, params, 'append');
 241     },
 242     before: function(params) {
 243         return manipulate(this, params, 'before');
 244
 245     },
 246     after: function(params) {
 247         return manipulate(this, params, 'after');
 248     },
 249     children: function() {
 250         var toret = [];
 251         if(this instanceof DocumentTextElement)
 252             return toret;
 253
 254
 255         var elementContent = this.dom().contents();
 256         var element = this;
 257         elementContent.each(function(idx) {
 258             var childElement = DocumentElement.fromHTMLElement(this, element.canvas);
 259             if(childElement === undefined)
 260                 return true;
 261             if(idx === 1 && elementContent.length > 2 && elementContent[1].nodeType === Node.ELEMENT_NODE && (childElement instanceof DocumentTextElement) && $.trim($(this).text()) === '')
 262                 return true;
 263             if(idx > 0 && childElement instanceof DocumentTextElement) {
 264                 if(toret[toret.length-1] instanceof DocumentNodeElement && $.trim($(this).text()) === '')
 265                     return true;
 266             }
 267             toret.push(childElement);
 268         });
 269         return toret;
 270     },
 271     childIndex: function(child) {
 272         var children = this.children(),
 273             toret = null;
 274         children.forEach(function(c, idx) {
 275             if(c.sameNode(child)) {
 276                 toret = idx;
 277                 return false;
 278             }
 279         });
 280         return toret;
 281     },
 282     getWlxmlTag: function() {
 283         return this.dom().attr('wlxml-tag');
 284     },
 285     setWlxmlTag: function(tag) {
 286         this.dom().attr('wlxml-tag', tag);
 287     },
 288     getWlxmlClass: function() {
 289         var klass = this.dom().attr('wlxml-class');
 290         if(klass)
 291             return klass.replace(/-/g, '.');
 292         return undefined;
 293     },
 294     setWlxmlClass: function(klass) {
 295         this.getWlxmlMetaAttrs().forEach(function(attr) {
 296             if(!classAttributes.hasMetaAttr(klass, attr.name))
 297                 this.dom().removeAttr('wlxml-meta-' + attr.name);
 298         }, this);
 299
 300         if(klass)
 301             this.dom().attr('wlxml-class', klass.replace(/\./g, '-'));
 302         else
 303             this.dom().removeAttr('wlxml-class');
 304     },
 305     is: function(what) {
 306         if(what === 'list' && _.contains(['list.items', 'list.items.enum'], this.getWlxmlClass()))
 307             return true;
 308         return false;
 309     },
 310
 311     getWlxmlMetaAttr: function(attr) {
 312         return this.dom().attr('wlxml-meta-'+attr);
 313     },
 314
 315     getWlxmlMetaAttrs: function() {
 316         var toret = [];
 317         var attrList = classAttributes.getMetaAttrsList(this.getWlxmlClass());
 318         attrList.all.forEach(function(attr) {
 319             toret.push({name: attr.name, value: this.getWlxmlMetaAttr(attr.name) || ''});
 320         }, this);
 321         return toret;
 322     },
 323
 324     setWlxmlMetaAttr: function(attr, value) {
 325         this.dom().attr('wlxml-meta-'+attr, value);
 326     },
 327
 328     toggleLabel: function(toggle) {
 329         var displayCss = toggle ? 'inline-block' : 'none';
 330         var label = this.dom().children('.canvas-widgets').find('.canvas-widget-label');
 331         label.css('display', displayCss);
 332         this.dom().toggleClass('highlighted-element');
 333     }
 334 });
 335
 336
 337 // DocumentNodeElement represents a text node from WLXML document rendered inside Canvas
 338 var DocumentTextElement = function(htmlElement, canvas) {
 339     DocumentElement.call(this, htmlElement, canvas);
 340 };
 341
 342 $.extend(DocumentTextElement, {
 343     createDOM: function(params) {
 344         return $('<div>')
 345             .attr('wlxml-text', '')
 346             .text(params.text || utils.unicode.ZWS);
 347     },
 348
 349     create: function(params, canvas) {
 350         return this.fromHTMLElement(this.createDOM(params)[0]);
 351     },
 352
 353     fromHTMLElement: function(htmlElement, canvas) {
 354         return new this(htmlElement, canvas);
 355     },
 356     isContentContainer: function(htmlElement) {
 357         return htmlElement.nodeType === Node.TEXT_NODE && $(htmlElement).parent().is('[wlxml-text]');
 358     }
 359 });
 360
 361 DocumentTextElement.prototype = new DocumentElement();
 362
 363 $.extend(DocumentTextElement.prototype, {
 364     toXML: function(parent) {
 365         return this.getText();
 366     },
 367     _setupDOMHandler: function(htmlElement) {
 368         var $element = $(htmlElement);
 369         if(htmlElement.nodeType === Node.TEXT_NODE)
 370             this.$element = $element.parent();
 371         else
 372             this.$element = $element;
 373     },
 374     setText: function(text) {
 375         this.dom().contents()[0].data = text;
 376     },
 377     getText: function() {
 378         return this.dom().text().replace(utils.unicode.ZWS, '');
 379     },
 380     isEmpty: function() {
 381         // Having at least Zero Width Space is guaranteed be Content Observer
 382         return this.dom().contents()[0].data === utils.unicode.ZWS;
 383     },
 384     after: function(params) {
 385         if(params instanceof DocumentTextElement || params.text)
 386             return false;
 387         var element;
 388         if(params instanceof DocumentNodeElement) {
 389             element = params;
 390         } else {
 391             element = DocumentNodeElement.create(params);
 392         }
 393         this.dom().wrap('<div>');
 394         this.dom().parent().after(element.dom());
 395         this.dom().unwrap();
 396         return element;
 397     },
 398     before: function(params) {
 399         if(params instanceof DocumentTextElement || params.text)
 400             return false;
 401         var element;
 402         if(params instanceof DocumentNodeElement) {
 403             element = params;
 404         } else {
 405             element = DocumentNodeElement.create(params);
 406         }
 407         this.dom().wrap('<div>');
 408         this.dom().parent().before(element.dom());
 409         this.dom().unwrap();
 410         return element;
 411     },
 412     wrapWithNodeElement: function(wlxmlNode) {
 413         if(typeof wlxmlNode.start === 'number' && typeof wlxmlNode.end === 'number') {
 414             return this.canvas.wrapText({
 415                 inside: this.parent(),
 416                 textNodeIdx: this.parent().childIndex(this),
 417                 offsetStart: Math.min(wlxmlNode.start, wlxmlNode.end),
 418                 offsetEnd: Math.max(wlxmlNode.start, wlxmlNode.end),
 419                 _with: {tag: wlxmlNode.tag, klass: wlxmlNode.klass}
 420             });
 421         } else {
 422             return DocumentElement.prototype.wrapWithNodeElement.call(this, wlxmlNode);
 423         }
 424     },
 425     unwrap: function() {
 426         var parent = this.parent(),
 427             toret;
 428         if(parent.children().length === 1) {
 429             toret = parent.parent();
 430             var grandParent = parent.parent();
 431             if(grandParent) {
 432                 var grandParentChildren = grandParent.children(),
 433                     idx = grandParent.childIndex(parent),
 434                     prev = idx - 1 > -1 ? grandParentChildren[idx-1] : null,
 435                     next = idx + 1 < grandParentChildren.length ? grandParentChildren[idx+1] : null;
 436                 if(prev && next) {
 437                     prev.setText(prev.getText() + this.getText() + next.getText());
 438                     next.detach();
 439                 } else if (prev || next) {
 440                     var target = prev ? prev : next;
 441                     target.setText(target.getText() + this.getText());
 442                 } else {
 443                     parent.after(this);
 444                 }
 445             } else {
 446                 parent.after(this);
 447             }
 448             parent.detach();
 449             return toret;
 450         }
 451     },
 452     split: function(params) {
 453         var parentElement = this.parent(),
 454             myIdx = parentElement.childIndex(this),
 455             myCanvas = this.canvas,
 456             passed = false,
 457             succeedingChildren = [],
 458             thisElement = this,
 459             prefix = this.getText().substr(0, params.offset),
 460             suffix = this.getText().substr(params.offset);
 461
 462         parentElement.children().forEach(function(child) {
 463             if(passed)
 464                 succeedingChildren.push(child);
 465             if(child.sameNode(thisElement))
 466                 passed = true;
 467         });
 468
 469         if(prefix.length > 0)
 470             this.setText(prefix);
 471         else
 472             this.detach();
 473
 474         var newElement = DocumentNodeElement.create({tag: parentElement.getWlxmlTag(), klass: parentElement.getWlxmlClass()}, myCanvas);
 475         parentElement.after(newElement);
 476
 477         if(suffix.length > 0)
 478             newElement.append({text: suffix});
 479         succeedingChildren.forEach(function(child) {
 480             newElement.append(child);
 481         });
 482
 483         return {first: parentElement, second: newElement};
 484     },
 485     divide: function(params) {
 486         var myText = this.getText();
 487
 488         if(params.offset === myText.length)
 489             return this.after(params);
 490         if(params.offset === 0)
 491             return this.before(params);
 492
 493         var lhsText = myText.substr(0, params.offset),
 494             rhsText = myText.substr(params.offset),
 495             newElement = DocumentNodeElement.create({tag: params.tag, klass: params.klass}, this.canvas),
 496             rhsTextElement = DocumentTextElement.create({text: rhsText});
 497
 498         this.setText(lhsText);
 499         this.after(newElement);
 500         newElement.after(rhsTextElement);
 501         return newElement;
 502     }
 503 });
 504
 505 return {
 506     DocumentElement: DocumentElement,
 507     DocumentNodeElement: DocumentNodeElement,
 508     DocumentTextElement: DocumentTextElement
 509 };
 510
 511 });