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