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