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