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         for(var i = children.length - 1; i >= 0; i--) {
 204             childParts = children[i].toXML(level + 1);
 205
 206             if(i === children.length - 1 && node.contents().length === 2) {
 207                 $(node.contents()[0]).after(childParts);
 208                 prevChildParts = childParts;
 209                 continue;
 210             }
 211
 212             if(prevChildParts && prevChildParts.length > 1 && prevChildParts[0].nodeType === Node.TEXT_NODE && prevChildParts[1].nodeType === Node.TEXT_NODE) {
 213                 $(node.contents()[0]).after(childParts);
 214                 prevChildParts = childParts;
 215                 continue;
 216             }
 217
 218             node.prepend(childParts);
 219
 220             prevChildParts = childParts;
 221         }
 222         return parts;
 223     },
 224     append: function(params) {
 225         if(params.tag !== 'span')
 226             this.data('orig-append', []);
 227         return manipulate(this, params, 'append');
 228     },
 229     before: function(params) {
 230         return manipulate(this, params, 'before');
 231
 232     },
 233     after: function(params) {
 234         return manipulate(this, params, 'after');
 235     },
 236     children: function() {
 237         var toret = [];
 238         if(this instanceof DocumentTextElement)
 239             return toret;
 240
 241
 242         var elementContent = this.dom().contents();
 243         var element = this;
 244         elementContent.each(function(idx) {
 245             var childElement = DocumentElement.fromHTMLElement(this, element.canvas);
 246             if(idx === 0 && elementContent.length > 1 && elementContent[1].nodeType === Node.ELEMENT_NODE && (childElement instanceof DocumentTextElement) && $.trim($(this).text()) === '')
 247                 return true;
 248             if(idx > 0 && childElement instanceof DocumentTextElement) {
 249                 if(toret[toret.length-1] instanceof DocumentNodeElement && $.trim($(this).text()) === '')
 250                     return true;
 251             }
 252             toret.push(childElement);
 253         });
 254         return toret;
 255     },
 256     childIndex: function(child) {
 257         var children = this.children(),
 258             toret = null;
 259         children.forEach(function(c, idx) {
 260             if(c.sameNode(child)) {
 261                 toret = idx;
 262                 return false;
 263             }
 264         });
 265         return toret;
 266     },
 267     getWlxmlTag: function() {
 268         return this.dom().attr('wlxml-tag');
 269     },
 270     setWlxmlTag: function(tag) {
 271         this.dom().attr('wlxml-tag', tag);
 272     },
 273     getWlxmlClass: function() {
 274         var klass = this.dom().attr('wlxml-class');
 275         if(klass)
 276             return klass.replace(/-/g, '.');
 277         return undefined;
 278     },
 279     setWlxmlClass: function(klass) {
 280         this.getWlxmlMetaAttrs().forEach(function(attr) {
 281             if(!classAttributes.hasMetaAttr(klass, attr.name))
 282                 this.dom().removeAttr('wlxml-meta-' + attr.name);
 283         }, this);
 284
 285         if(klass)
 286             this.dom().attr('wlxml-class', klass.replace(/\./g, '-'));
 287         else
 288             this.dom().removeAttr('wlxml-class');
 289     },
 290     is: function(what) {
 291         if(what === 'list' && _.contains(['list-items', 'list-items-enum'], this.dom().attr('wlxml-class')))
 292             return true;
 293         return false;
 294     },
 295
 296
 297     getWlxmlMetaAttr: function(attr) {
 298         return this.dom().attr('wlxml-meta-'+attr);
 299     },
 300     getWlxmlMetaAttrs: function() {
 301         var toret = [];
 302         var attrList = classAttributes.getMetaAttrsList(this.getWlxmlClass());
 303         attrList.all.forEach(function(attr) {
 304             toret.push({name: attr.name, value: this.getWlxmlMetaAttr(attr.name) || ''});
 305         }, this);
 306         return toret;
 307     },
 308     setWlxmlMetaAttr: function(attr, value) {
 309         this.dom().attr('wlxml-meta-'+attr, value);
 310     }
 311 });
 312
 313
 314 // DocumentNodeElement represents a text node from WLXML document rendered inside Canvas
 315 var DocumentTextElement = function(htmlElement, canvas) {
 316     DocumentElement.call(this, htmlElement, canvas);
 317 };
 318
 319 $.extend(DocumentTextElement, {
 320     createDOM: function(params) {
 321         return $('<div>')
 322             .attr('wlxml-text', '')
 323             .text(params.text);
 324     },
 325
 326     create: function(params, canvas) {
 327         return this.fromHTMLElement(this.createDOM(params)[0]);
 328     },
 329
 330     fromHTMLElement: function(htmlElement, canvas) {
 331         return new this(htmlElement, canvas);
 332     }
 333 });
 334
 335 DocumentTextElement.prototype = new DocumentElement();
 336
 337 $.extend(DocumentTextElement.prototype, {
 338     toXML: function(parent) {
 339         return this.getText();
 340     },
 341     _setupDOMHandler: function(htmlElement) {
 342         var $element = $(htmlElement);
 343         if(htmlElement.nodeType === Node.TEXT_NODE)
 344             this.$element = $element.parent();
 345         else
 346             this.$element = $element;
 347     },
 348     setText: function(text) {
 349         this.dom().contents()[0].data = text;
 350     },
 351     getText: function() {
 352         return this.dom().text();
 353     },
 354     after: function(params) {
 355         if(params instanceof DocumentTextElement || params.text)
 356             return false;
 357         var element;
 358         if(params instanceof DocumentNodeElement) {
 359             element = params;
 360         } else {
 361             element = DocumentNodeElement.create(params);
 362         }
 363         this.dom().wrap('<div>');
 364         this.dom().parent().after(element.dom());
 365         this.dom().unwrap();
 366         return element;
 367     },
 368     before: function(params) {
 369         if(params instanceof DocumentTextElement || params.text)
 370             return false;
 371         var element;
 372         if(params instanceof DocumentNodeElement) {
 373             element = params;
 374         } else {
 375             element = DocumentNodeElement.create(params);
 376         }
 377         this.dom().wrap('<div>');
 378         this.dom().parent().before(element.dom());
 379         this.dom().unwrap();
 380         return element;
 381     },
 382     wrapWithNodeElement: function(wlxmlNode) {
 383         if(typeof wlxmlNode.start === 'number' && typeof wlxmlNode.end === 'number') {
 384             return this.canvas.wrapText({
 385                 inside: this.parent(),
 386                 textNodeIdx: this.parent().childIndex(this),
 387                 offsetStart: Math.min(wlxmlNode.start, wlxmlNode.end),
 388                 offsetEnd: Math.max(wlxmlNode.start, wlxmlNode.end),
 389                 _with: {tag: wlxmlNode.tag, klass: wlxmlNode.klass}
 390             });
 391         } else {
 392             return DocumentElement.prototype.wrapWithNodeElement.call(this, wlxmlNode);
 393         }
 394     },
 395     unwrap: function() {
 396         var parent = this.parent(),
 397             toret;
 398         if(parent.children().length === 1) {
 399             toret = parent.parent();
 400             var grandParent = parent.parent();
 401             if(grandParent) {
 402                 var grandParentChildren = grandParent.children(),
 403                     idx = grandParent.childIndex(parent),
 404                     prev = idx - 1 > -1 ? grandParentChildren[idx-1] : null,
 405                     next = idx + 1 < grandParentChildren.length ? grandParentChildren[idx+1] : null;
 406                 if(prev && next) {
 407                     prev.setText(prev.getText() + this.getText() + next.getText());
 408                     next.detach();
 409                 } else if (prev || next) {
 410                     var target = prev ? prev : next;
 411                     target.setText(target.getText() + this.getText());
 412                 } else {
 413                     parent.after(this);
 414                 }
 415             } else {
 416                 parent.after(this);
 417             }
 418             parent.detach();
 419             return toret;
 420         }
 421     },
 422     split: function(params) {
 423         var parentElement = this.parent(),
 424             myIdx = parentElement.childIndex(this),
 425             myCanvas = this.canvas,
 426             passed = false,
 427             succeedingChildren = [],
 428             thisElement = this,
 429             prefix = this.getText().substr(0, params.offset),
 430             suffix = this.getText().substr(params.offset);
 431
 432         parentElement.children().forEach(function(child) {
 433             if(passed)
 434                 succeedingChildren.push(child);
 435             if(child.sameNode(thisElement))
 436                 passed = true;
 437         });
 438
 439         if(prefix.length > 0)
 440             this.setText(prefix);
 441         else
 442             this.detach();
 443
 444         var newElement = DocumentNodeElement.create({tag: parentElement.getWlxmlTag(), klass: parentElement.getWlxmlClass()}, myCanvas);
 445         parentElement.after(newElement);
 446
 447         if(suffix.length > 0)
 448             newElement.append({text: suffix});
 449         succeedingChildren.forEach(function(child) {
 450             newElement.append(child);
 451         });
 452
 453         return {first: parentElement, second: newElement};
 454     },
 455 });
 456
 457 return {
 458     DocumentElement: DocumentElement,
 459     DocumentNodeElement: DocumentNodeElement,
 460     DocumentTextElement: DocumentTextElement
 461 };
 462
 463 });