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