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