689df0e1852aba4959efa5d265586861bd7a5bba
[fnpeditor.git] / modules / documentCanvas / canvas / documentElement.js
1 define([
2 'libs/jquery-1.9.1.min',
3 'libs/underscore-min',
4 'modules/documentCanvas/classAttributes',
5 'modules/documentCanvas/canvas/utils',
6 'modules/documentCanvas/canvas/widgets',
7 'modules/documentCanvas/canvas/wlxmlManagers'
8 ], function($, _, classAttributes, utils, widgets, wlxmlManagers) {
9     
10 'use strict';
11
12
13 // DocumentElement represents a text or an element node from WLXML document rendered inside Canvas
14 var DocumentElement = function(htmlElement, canvas) {
15     if(arguments.length === 0)
16         return;
17     this.canvas = canvas;
18     this._setupDOMHandler(htmlElement);
19 }
20
21 var elementTypeFromParams = function(params) {
22     return params.text !== undefined ? DocumentTextElement : DocumentNodeElement;
23
24 };
25
26 $.extend(DocumentElement, {
27     create: function(params, canvas) {
28         return elementTypeFromParams(params).create(params);
29     },
30
31     createDOM: function(params) {
32         return elementTypeFromParams(params).createDOM(params);
33     },
34
35     fromHTMLElement: function(htmlElement, canvas) {
36         var $element = $(htmlElement);
37         if(htmlElement.nodeType === Node.ELEMENT_NODE && $element.attr('document-node-element') !== undefined)
38             return DocumentNodeElement.fromHTMLElement(htmlElement, canvas);
39         if($element.attr('document-text-element') !== undefined || (htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined))
40             return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
41         return undefined;
42     }
43 });
44
45 $.extend(DocumentElement.prototype, {
46     _setupDOMHandler: function(htmlElement) {
47         this.$element = $(htmlElement);
48     },
49     bound: function() {
50         return this.canvas !== undefined;
51     },
52     dom: function() {
53         return this.$element;
54     },
55     parent: function() {
56         var parents = this.$element.parents('[document-node-element]');
57         if(parents.length)
58             return DocumentElement.fromHTMLElement(parents[0], this.canvas);
59         return null;
60     },
61
62     parents: function() {
63         var parents = [],
64             parent = this.parent();
65         while(parent) {
66             parents.push(parent);
67             parent = parent.parent();
68         }
69         return parents;
70     },
71
72     sameNode: function(other) {
73         return other && (typeof other === typeof this) && other.dom()[0] === this.dom()[0];
74     },
75
76     wrapWithNodeElement: function(wlxmlNode) {
77         var wrapper = DocumentNodeElement.create({tag: wlxmlNode.tag, klass: wlxmlNode.klass});
78         this.dom().replaceWith(wrapper.dom());
79         wrapper.append(this);
80         return wrapper;
81     },
82
83     detach: function() {
84         this.dom().detach();
85         this.canvas = null;
86         return this;
87     },
88
89     markAsCurrent: function() {
90         this.canvas.markAsCurrent(this);
91     },
92
93     getVerticallyFirstTextElement: function() {
94         var toret;
95         this.children().some(function(child) {
96             if(!child.isVisible())
97                 return false; // continue
98             if(child instanceof DocumentTextElement) {
99                 toret = child;
100                 return true; // break
101             } else {
102                 toret = child.getVerticallyFirstTextElement();
103                 if(toret)
104                     return true; // break
105             }
106         });
107         return toret;
108     },
109
110     isVisible: function() {
111         return this instanceof DocumentTextElement || this.getWlxmlTag() !== 'metadata';
112     }
113 });
114
115
116 // DocumentNodeElement represents an element node from WLXML document rendered inside Canvas
117 var DocumentNodeElement = function(htmlElement, canvas) {
118     DocumentElement.call(this, htmlElement, canvas);
119 };
120
121 $.extend(DocumentNodeElement, {
122     createDOM: function(params, canvas) {
123         var dom = $('<div>')
124                 .attr('document-node-element', ''),
125             widgetsContainer = $('<div>')
126                 .addClass('canvas-widgets')
127                 .attr('contenteditable', false),
128             container = $('<div>')
129                 .attr('document-element-content', '');
130         
131         dom.append(widgetsContainer, container);
132         // Make sure widgets aren't navigable with arrow keys
133         widgetsContainer.find('*').add(widgetsContainer).attr('tabindex', -1);
134
135         var element = this.fromHTMLElement(dom[0], canvas);
136
137         element.setWlxmlTag(params.tag);
138         if(params.klass)
139             element.setWlxmlClass(params.klass);
140         if(params.meta) {
141             _.keys(params.meta).forEach(function(key) {
142                 element.setWlxmlMetaAttr(key, params.meta[key]);
143             });
144         }
145         element.data('other-attrs', params.others);
146
147         if(params.rawChildren) {
148             container.append(params.rawChildren);
149         }
150         return dom;
151     },
152
153     create: function(params, canvas) {
154         return this.fromHTMLElement(this.createDOM(params, canvas)[0], canvas);
155     },
156
157     fromHTMLElement: function(htmlElement, canvas) {
158         return new this(htmlElement, canvas);
159     }
160 });
161
162 var manipulate = function(e, params, action) {
163     var element;
164     if(params instanceof DocumentElement) {
165         element = params;
166     } else {
167         element = DocumentElement.create(params);
168     }
169     var target = (action === 'append' || action === 'prepend') ? e._container() : e.dom();
170     target[action](element.dom());
171     return element;
172 };
173
174 DocumentNodeElement.prototype = new DocumentElement();
175
176
177 $.extend(DocumentNodeElement.prototype, {
178     _container: function() {
179         return this.dom().children('[document-element-content]');
180     },
181     data: function() {
182         var dom = this.dom(),
183             args = Array.prototype.slice.call(arguments, 0);
184         if(args.length === 2 && args[1] === undefined)
185             return dom.removeData(args[0]);
186         return dom.data.apply(dom, arguments);
187     },
188     toXML: function(level) {
189         var node = $('<' + this.getWlxmlTag() + '>');
190
191         if(this.getWlxmlClass())
192             node.attr('class', this.getWlxmlClass());
193         var meta = this.getWlxmlMetaAttrs();
194         meta.forEach(function(attr) {
195             if(attr.value)
196                 node.attr('meta-' + attr.name, attr.value);
197         });
198         _.keys(this.data('other-attrs') || {}).forEach(function(key) {
199             node.attr(key, this.data('other-attrs')[key]);
200         }, this);
201
202         var addFormatting = function() {
203             var toret = $('<div>');
204             var formattings = {};
205
206             if(this.data('orig-before') !== undefined) {
207                 if(this.data('orig-before')) {
208                     toret.prepend(document.createTextNode(this.data('orig-before')));
209                 }
210             } else if(level && this.getWlxmlTag() !== 'span') {
211                 toret.append('\n' + (new Array(level * 2 + 1)).join(' '));
212             }
213
214             toret.append(node);
215
216             if(this.data('orig-after')) {
217                 toret.append(document.createTextNode(this.data('orig-after')));
218             }
219
220             /* Inside node */
221             if(this.data('orig-begin')) {
222                 node.prepend(this.data('orig-begin'));
223                 formattings.begin = true;
224             }
225
226             if(this.data('orig-end') !== undefined) {
227                 if(this.data('orig-end')) {
228                     node.append(this.data('orig-end'));
229                 }
230             } else if(this.getWlxmlTag() !== 'span' && children.length){
231                 node.append('\n' + (new Array(level * 2 + 1)).join(' '));
232             }
233            
234             return {parts: toret.contents(), formattings: formattings};
235         }.bind(this);
236
237         
238         
239         var children = this.children(),
240             childParts;
241
242         var formatting = addFormatting(node);
243
244         for(var i = children.length - 1; i >= 0; i--) {
245             childParts = children[i].toXML(level + 1);
246             if(typeof childParts === 'string')
247                 childParts = [document.createTextNode(childParts)];
248
249             if(formatting.formattings.begin) {
250                 $(node.contents()[0]).after(childParts);
251             } else
252                 node.prepend(childParts);
253         }
254         return formatting.parts;
255     },
256     append: function(params) {
257         if(params.tag !== 'span')
258             this.data('orig-end', undefined);
259         return manipulate(this, params, 'append');
260     },
261     prepend: function(params) {
262         return manipulate(this, params, 'prepend');
263     },
264     before: function(params) {
265         return manipulate(this, params, 'before');
266
267     },
268     after: function(params) {
269         return manipulate(this, params, 'after');
270     },
271     children: function() {
272         var toret = [];
273         if(this instanceof DocumentTextElement)
274             return toret;
275
276
277         var elementContent = this._container().contents();
278         var element = this;
279         elementContent.each(function(idx) {
280             var childElement = DocumentElement.fromHTMLElement(this, element.canvas);
281             if(childElement === undefined)
282                 return true;
283             if(idx === 0 && elementContent.length > 1 && elementContent[1].nodeType === Node.ELEMENT_NODE && (childElement instanceof DocumentTextElement) && $.trim($(this).text()) === '')
284                 return true;
285             if(idx > 0 && childElement instanceof DocumentTextElement) {
286                 if(toret[toret.length-1] instanceof DocumentNodeElement && $.trim($(this).text()) === '')
287                     return true;
288             }
289             toret.push(childElement);
290         });
291         return toret;
292     },
293     childIndex: function(child) {
294         var children = this.children(),
295             toret = null;
296         children.forEach(function(c, idx) {
297             if(c.sameNode(child)) {
298                 toret = idx;
299                 return false;
300             }
301         });
302         return toret;
303     },
304     getWlxmlTag: function() {
305         return this._container().attr('wlxml-tag');
306     },
307     setWlxmlTag: function(tag) {
308         if(tag === this.getWlxmlTag())
309             return;
310
311         this._container().attr('wlxml-tag', tag);
312         this._updateWlxmlManager();
313     },
314     getWlxmlClass: function() {
315         var klass = this._container().attr('wlxml-class');
316         if(klass)
317             return klass.replace(/-/g, '.');
318         return undefined;
319     },
320     setWlxmlClass: function(klass) {
321         if(klass === this.getWlxmlClass())
322             return;
323
324         this.getWlxmlMetaAttrs().forEach(function(attr) {
325             if(!classAttributes.hasMetaAttr(klass, attr.name))
326                 this.dom().removeAttr('wlxml-meta-' + attr.name);
327         }, this);
328
329         if(klass)
330             this._container().attr('wlxml-class', klass.replace(/\./g, '-'));
331         else
332             this._container().removeAttr('wlxml-class');
333         this._updateWlxmlManager();
334     },
335     _updateWlxmlManager: function() {
336         var manager = wlxmlManagers.getFor(this);
337         this.data('_wlxmlManager', manager);
338         manager.setup();
339     },
340     is: function(what) {
341         if(what === 'list' && _.contains(['list.items', 'list.items.enum'], this.getWlxmlClass()))
342             return true;
343         return false;
344     },
345
346     getWlxmlMetaAttr: function(attr) {
347         return this.dom().attr('wlxml-meta-'+attr);
348     },
349
350     getWlxmlMetaAttrs: function() {
351         var toret = [];
352         var attrList = classAttributes.getMetaAttrsList(this.getWlxmlClass());
353         attrList.all.forEach(function(attr) {
354             toret.push({name: attr.name, value: this.getWlxmlMetaAttr(attr.name) || ''});
355         }, this);
356         return toret;
357     },
358
359     setWlxmlMetaAttr: function(attr, value) {
360         this.dom().attr('wlxml-meta-'+attr, value);
361     },
362     
363     toggleLabel: function(toggle) {
364         var displayCss = toggle ? 'inline-block' : 'none';
365         var label = this.dom().children('.canvas-widgets').find('.canvas-widget-label');
366         label.css('display', displayCss);
367         this.toggleHighlight(toggle);
368     },
369
370     toggleHighlight: function(toggle) {
371         this._container().toggleClass('highlighted-element', toggle);
372     },
373
374     toggle: function(toggle) {
375         var mng = this.data('_wlxmlManager');
376         if(mng) {
377             mng.toggle(toggle);
378         }
379     }
380 });
381
382
383 // DocumentNodeElement represents a text node from WLXML document rendered inside Canvas
384 var DocumentTextElement = function(htmlElement, canvas) {
385     DocumentElement.call(this, htmlElement, canvas);
386 };
387
388 $.extend(DocumentTextElement, {
389     createDOM: function(params) {
390         return $('<div>')
391             .attr('document-text-element', '')
392             .text(params.text || utils.unicode.ZWS);
393     },
394
395     create: function(params, canvas) {
396         return this.fromHTMLElement(this.createDOM(params)[0]);
397     },
398
399     fromHTMLElement: function(htmlElement, canvas) {
400         return new this(htmlElement, canvas);
401     },
402     isContentContainer: function(htmlElement) {
403         return htmlElement.nodeType === Node.TEXT_NODE && $(htmlElement).parent().is('[document-text-element]');
404     }
405 });
406
407 DocumentTextElement.prototype = new DocumentElement();
408
409 $.extend(DocumentTextElement.prototype, {
410     toXML: function(parent) {
411         return this.getText();
412     },
413     _setupDOMHandler: function(htmlElement) {
414         var $element = $(htmlElement);
415         if(htmlElement.nodeType === Node.TEXT_NODE)
416             this.$element = $element.parent();
417         else
418             this.$element = $element;
419     },
420     setText: function(text) {
421         this.dom().contents()[0].data = text;
422     },
423     getText: function() {
424         return this.dom().text().replace(utils.unicode.ZWS, '');
425     },
426     isEmpty: function() {
427         // Having at least Zero Width Space is guaranteed be Content Observer
428         return this.dom().contents()[0].data === utils.unicode.ZWS;
429     },
430     after: function(params) {
431         if(params instanceof DocumentTextElement || params.text)
432             return false;
433         var element;
434         if(params instanceof DocumentNodeElement) {
435             element = params;
436         } else {
437             element = DocumentNodeElement.create(params, this.canvas);
438         }
439         this.dom().wrap('<div>');
440         this.dom().parent().after(element.dom());
441         this.dom().unwrap();
442         return element;
443     },
444     before: function(params) {
445         if(params instanceof DocumentTextElement || params.text)
446             return false;
447         var element;
448         if(params instanceof DocumentNodeElement) {
449             element = params;
450         } else {
451             element = DocumentNodeElement.create(params, this.canvas);
452         }
453         this.dom().wrap('<div>');
454         this.dom().parent().before(element.dom());
455         this.dom().unwrap();
456         return element;
457     },
458     wrapWithNodeElement: function(wlxmlNode) {
459         if(typeof wlxmlNode.start === 'number' && typeof wlxmlNode.end === 'number') {
460             return this.canvas.wrapText({
461                 inside: this.parent(),
462                 textNodeIdx: this.parent().childIndex(this),
463                 offsetStart: Math.min(wlxmlNode.start, wlxmlNode.end),
464                 offsetEnd: Math.max(wlxmlNode.start, wlxmlNode.end),
465                 _with: {tag: wlxmlNode.tag, klass: wlxmlNode.klass}
466             });
467         } else {
468             return DocumentElement.prototype.wrapWithNodeElement.call(this, wlxmlNode);
469         }
470     },
471     unwrap: function() {
472         var parent = this.parent(),
473             toret;
474         if(parent.children().length === 1) {
475             toret = parent.parent();
476             var grandParent = parent.parent();
477             if(grandParent) {
478                 var grandParentChildren = grandParent.children(),
479                     idx = grandParent.childIndex(parent),
480                     prev = idx - 1 > -1 ? grandParentChildren[idx-1] : null,
481                     next = idx + 1 < grandParentChildren.length ? grandParentChildren[idx+1] : null;
482                 
483                 prev = (prev instanceof DocumentTextElement) ? prev : null;
484                 next = (next instanceof DocumentTextElement) ? next : null;
485
486                 if(prev && next) {
487                     prev.setText(prev.getText() + this.getText() + next.getText());
488                     next.detach();
489                 } else if (prev || next) {
490                     var target = prev ? prev : next;
491                     target.setText(target.getText() + this.getText());
492                 } else {
493                     parent.after(this);
494                 }
495             } else {
496                 parent.after(this);
497             }
498             parent.detach();
499             return toret;
500         }
501     },
502     split: function(params) {
503         var parentElement = this.parent(),
504             myIdx = parentElement.childIndex(this),
505             myCanvas = this.canvas,
506             passed = false,
507             succeedingChildren = [],
508             thisElement = this,
509             prefix = this.getText().substr(0, params.offset),
510             suffix = this.getText().substr(params.offset);
511
512         parentElement.children().forEach(function(child) {
513             if(passed)
514                 succeedingChildren.push(child);
515             if(child.sameNode(thisElement))
516                 passed = true;
517         });
518
519         if(prefix.length > 0)
520             this.setText(prefix);
521         else
522             this.detach();
523         
524         var newElement = DocumentNodeElement.create({tag: parentElement.getWlxmlTag(), klass: parentElement.getWlxmlClass()}, myCanvas);
525         parentElement.after(newElement);
526
527         if(suffix.length > 0)
528             newElement.append({text: suffix});
529         succeedingChildren.forEach(function(child) {
530             newElement.append(child);
531         });
532
533         return {first: parentElement, second: newElement};
534     },
535     divide: function(params) {
536         var myText = this.getText();
537
538         if(params.offset === myText.length)
539             return this.after(params);
540         if(params.offset === 0)
541             return this.before(params);
542
543         var lhsText = myText.substr(0, params.offset),
544             rhsText = myText.substr(params.offset),
545             newElement = DocumentNodeElement.create({tag: params.tag, klass: params.klass}, this.canvas),
546             rhsTextElement = DocumentTextElement.create({text: rhsText});
547
548         this.setText(lhsText);
549         this.after(newElement);
550         newElement.after(rhsTextElement);
551         return newElement;
552     },
553
554     toggleHighlight: function() {
555         // do nothing for now
556     }
557 });
558
559 return {
560     DocumentElement: DocumentElement,
561     DocumentNodeElement: DocumentNodeElement,
562     DocumentTextElement: DocumentTextElement
563 };
564
565 });