modules/documentCanvas/canvas/documentElement.js

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