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