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