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