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