5 'fnpjs/logging/logging',
6 'modules/documentCanvas/canvas/documentElement',
7 'modules/documentCanvas/canvas/keyboard',
8 'modules/documentCanvas/canvas/utils',
9 'modules/documentCanvas/canvas/wlxmlListener',
10 'modules/documentCanvas/canvas/elementsRegister',
11 'modules/documentCanvas/canvas/genericElement',
12 'modules/documentCanvas/canvas/nullElement',
13 'modules/documentCanvas/canvas/gutter',
14 ], function($, _, Backbone, logging, documentElement, keyboard, utils, wlxmlListener, ElementsRegister, genericElement, nullElement, gutter) {
17 /* global document:false, window:false, Node:false, gettext */
19 var logger = logging.getLogger('canvas');
21 var TextHandler = function(canvas) {this.canvas = canvas; this.buffer = null;};
22 $.extend(TextHandler.prototype, {
23 handle: function(node, text) {
24 this.setText(text, node);
29 // if(this.node.sameNode(node)) {
37 _ping: _.throttle(function(text) {
42 if(this.buffer !== null) {
43 this.setText(this.buffer, this.node);
47 setText: function(text, node) {
48 //this.canvas.wlxmlDocument.transform('setText', {node:node, text: text});
49 node.document.transaction(function() {
53 description: gettext('Changing text')
62 var Canvas = function(wlxmlDocument, elements) {
63 this.elementsRegister = new ElementsRegister(documentElement.DocumentNodeElement, nullElement);
66 {tag: 'section', klass: null, prototype: genericElement},
67 {tag: 'div', klass: null, prototype: genericElement},
68 {tag: 'header', klass: null, prototype: genericElement},
69 {tag: 'span', klass: null, prototype: genericElement},
70 {tag: 'aside', klass: null, prototype: genericElement}
71 ].concat(elements || []);
73 (elements).forEach(function(elementDesc) {
74 this.elementsRegister.register(elementDesc);
76 this.eventBus = _.extend({}, Backbone.Events);
78 this.wrapper = $('<div style="display: table; width: 96%"><div style="display: table-row" class="crow"></div></div>');
81 this.gutter = gutter.create();
82 this.gutterView = new gutter.GutterView(this.gutter);
83 this.rootWrapper = $('<div>').addClass('canvas-wrapper').attr('contenteditable', true);
84 this.wrapper.find('.crow').append(this.rootWrapper, this.gutterView.dom);
86 this.wlxmlListener = wlxmlListener.create(this);
87 this.loadWlxmlDocument(wlxmlDocument);
88 this.setupEventHandling();
89 this.textHandler = new TextHandler(this);
92 $.extend(Canvas.prototype, Backbone.Events, {
94 getElementOffset: function(element) {
95 return element.dom.offset().top - this.wrapper.offset().top;
98 loadWlxmlDocument: function(wlxmlDocument) {
103 this.wlxmlListener.listenTo(wlxmlDocument);
104 this.wlxmlDocument = wlxmlDocument;
108 createElement: function(wlxmlNode) {
110 if(wlxmlNode.nodeType === Node.TEXT_NODE) {
111 Factory = documentElement.DocumentTextElement;
113 Factory = this.elementsRegister.getElement({tag: wlxmlNode.getTagName(), klass: wlxmlNode.getClass()});
115 return new Factory(wlxmlNode, this);
118 getDocumentElement: function(htmlElement) {
119 /* globals HTMLElement, Text */
120 if(!htmlElement || !(htmlElement instanceof HTMLElement || htmlElement instanceof Text)) {
123 var $element = $(htmlElement);
124 if(htmlElement.nodeType === Node.ELEMENT_NODE && $element.attr('document-node-element') !== undefined) {
125 return $element.data('canvas-element');
128 if(htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined) {
129 $element = $element.parent();
132 if($element.attr('document-text-element') !== undefined || (htmlElement.nodeType === Node.TEXT_NODE && $element.parent().attr('document-text-element') !== undefined)) {
133 //return DocumentTextElement.fromHTMLElement(htmlElement, canvas);
134 return $element.data('canvas-element');
138 reloadRoot: function() {
139 this.rootElement = this.createElement(this.wlxmlDocument.root);
140 this.rootWrapper.empty();
141 this.rootWrapper.append(this.rootElement.dom);
144 setupEventHandling: function() {
147 this.rootWrapper.on('keyup keydown keypress', function(e) {
148 keyboard.handleKey(e, canvas);
151 this.rootWrapper.on('mouseup', function() {
152 canvas.triggerSelectionChanged();
156 this.rootWrapper.on('mousedown', '[document-node-element], [document-text-element]', function(e) {
157 mouseDown = e.target;
160 this.rootWrapper.on('click', '[document-node-element], [document-text-element]', function(e) {
162 if(e.originalEvent.detail === 3) {
164 canvas._moveCaretToTextElement(canvas.getDocumentElement(e.currentTarget), 'whole');
166 if(mouseDown === e.target) {
167 canvas.setCurrentElement(canvas.getDocumentElement(e.currentTarget), {caretTo: false});
172 this.rootWrapper.on('paste', function(e) {
175 var clipboardData = e.originalEvent.clipboardData;
176 if(!clipboardData || !clipboardData.getData) {
177 return; // TODO: alert
180 var text = clipboardData.getData('text/plain').replace(/\r?\n|\r/g, ' '),
181 cursor = canvas.getCursor(),
182 element = cursor.getPosition().element,
185 if(element && cursor.isWithinElement()) {
186 lhs = element.getText().substr(0, cursor.getSelectionStart().offset);
187 rhs = element.getText().substr(cursor.getSelectionEnd().offset);
188 element.setText(lhs+text+rhs);
189 canvas.setCurrentElement(element, {caretTo: lhs.length + text.length});
191 /* jshint noempty:false */
196 /* globals MutationObserver */
197 var observer = new MutationObserver(function(mutations) {
198 mutations.forEach(function(mutation) {
199 if(documentElement.DocumentTextElement.isContentContainer(mutation.target)) {
200 observer.disconnect();
201 if(mutation.target.data === '') {
202 mutation.target.data = utils.unicode.ZWS;
204 else if(mutation.oldValue === utils.unicode.ZWS) {
205 mutation.target.data = mutation.target.data.replace(utils.unicode.ZWS, '');
206 canvas._moveCaretToTextElement(canvas.getDocumentElement(mutation.target), 'end');
208 observer.observe(canvas.wrapper[0], config);
210 var textElement = canvas.getDocumentElement(mutation.target),
211 toSet = mutation.target.data !== utils.unicode.ZWS ? mutation.target.data : '';
213 //textElement.data('wlxmlNode').setText(toSet);
214 //textElement.data('wlxmlNode').document.transform('setText', {node: textElement.data('wlxmlNode'), text: toSet});
215 if(textElement.wlxmlNode.getText() !== toSet) {
216 canvas.textHandler.handle(textElement.wlxmlNode, toSet);
221 var config = { attributes: false, childList: false, characterData: true, subtree: true, characterDataOldValue: true};
222 observer.observe(this.rootWrapper[0], config);
225 var hoverHandler = function(e) {
226 var el = canvas.getDocumentElement(e.currentTarget),
235 if(el instanceof documentElement.DocumentTextElement) {
238 el.updateState({exposed:expose[e.type]});
241 this.rootWrapper.on('mouseover', '[document-node-element], [document-text-element]', hoverHandler);
242 this.rootWrapper.on('mouseout', '[document-node-element], [document-text-element]', hoverHandler);
244 this.eventBus.on('elementToggled', function(toggle, element) {
246 canvas.setCurrentElement(canvas.getPreviousTextElement(element));
256 return this.rootElement;
259 toggleElementHighlight: function(node, toggle) {
260 var element = utils.getElementForNode(node);
261 element.updateState({exposed: toggle});
264 getCursor: function() {
265 return new Cursor(this);
269 getCurrentNodeElement: function() {
270 return this.currentNodeElement;
273 getCurrentTextElement: function() {
274 var htmlElement = this.rootWrapper.find('.current-text-element')[0];
276 return this.getDocumentElement(htmlElement);
280 getPreviousTextElement: function(relativeToElement, includeInvisible) {
281 return this.getNearestTextElement('above', relativeToElement, includeInvisible);
284 getNextTextElement: function(relativeToElement, includeInvisible) {
285 return this.getNearestTextElement('below', relativeToElement, includeInvisible);
288 getNearestTextElement: function(direction, relativeToElement, includeInvisible) {
289 includeInvisible = includeInvisible !== undefined ? includeInvisible : false;
290 var selector = '[document-text-element]' + (includeInvisible ? '' : ':visible');
291 return this.getDocumentElement(utils.nearestInDocumentOrder(selector, direction, relativeToElement.dom[0]));
294 contains: function(element) {
295 return element && element.dom && element.dom.parents().index(this.rootWrapper) !== -1;
298 triggerSelectionChanged: function() {
299 this.trigger('selectionChanged', this.getSelection());
300 var s = this.getSelection(),
301 f = s.toDocumentFragment();
302 if(f && f instanceof f.RangeFragment) {
303 if(this.currentNodeElement) {
304 this.currentNodeElement.updateState({active: false});
305 this.currentNodeElement = null;
310 getSelection: function() {
311 return new Selection(this);
314 select: function(fragment) {
315 if(fragment instanceof this.wlxmlDocument.RangeFragment) {
316 this.setCurrentElement(fragment.endNode, {caretTo: fragment.endOffset});
317 } else if(fragment instanceof this.wlxmlDocument.NodeFragment) {
319 caretTo: fragment instanceof this.wlxmlDocument.CaretFragment ? fragment.offset : 'start'
321 this.setCurrentElement(fragment.node, params);
323 logger.debug('Fragment not supported');
327 setCurrentElement: function(element, params) {
329 logger.debug('Invalid element passed to setCurrentElement: ' + element);
333 if(!(element instanceof documentElement.DocumentElement)) {
334 element = utils.getElementForNode(element);
337 if(!element || !this.contains(element)) {
338 logger.warning('Cannot set current element: element doesn\'t exist on canvas');
342 params = _.extend({caretTo: 'end'}, params);
343 var findFirstDirectTextChild = function(e, nodeToLand) {
344 var byBrowser = this.getCursor().getPosition().element;
345 if(byBrowser && byBrowser.parent().sameNode(nodeToLand)) {
348 return e.getVerticallyFirstTextElement();
350 var _markAsCurrent = function(element) {
351 if(element instanceof documentElement.DocumentTextElement) {
352 this.rootWrapper.find('.current-text-element').removeClass('current-text-element');
353 element.dom.addClass('current-text-element');
355 if(this.currentNodeElement) {
356 this.currentNodeElement.updateState({active: false});
358 element.updateState({active: true});
359 this.currentNodeElement = element;
364 var isTextElement = element instanceof documentElement.DocumentTextElement,
365 nodeElementToLand = isTextElement ? element.parent() : element,
366 textElementToLand = isTextElement ? element : findFirstDirectTextChild(element, nodeElementToLand),
367 currentTextElement = this.getCurrentTextElement(),
368 currentNodeElement = this.getCurrentNodeElement();
370 if(currentTextElement && !(currentTextElement.sameNode(textElementToLand))) {
371 this.rootWrapper.find('.current-text-element').removeClass('current-text-element');
374 if(textElementToLand) {
375 _markAsCurrent(textElementToLand);
376 if(params.caretTo || !textElementToLand.sameNode(this.getCursor().getPosition().element)) {
377 this._moveCaretToTextElement(textElementToLand, params.caretTo); // as method on element?
380 document.getSelection().removeAllRanges();
383 if(!(currentNodeElement && currentNodeElement.sameNode(nodeElementToLand))) {
384 _markAsCurrent(nodeElementToLand);
386 this.triggerSelectionChanged();
389 _moveCaretToTextElement: function(element, where) {
390 var range = document.createRange(),
391 node = element.dom.contents()[0];
393 if(typeof where !== 'number') {
394 range.selectNodeContents(node);
396 range.setStart(node, Math.min(node.data.length, where));
399 if(where !== 'whole') {
400 var collapseArg = true;
401 if(where === 'end') {
404 range.collapse(collapseArg);
406 var selection = document.getSelection();
408 selection.removeAllRanges();
409 selection.addRange(range);
410 this.rootWrapper.focus(); // FF requires this for caret to be put where range colllapses, Chrome doesn't.
413 setCursorPosition: function(position) {
414 if(position.element) {
415 this._moveCaretToTextElement(position.element, position.offset);
419 toggleGrid: function() {
420 this.rootWrapper.toggleClass('grid-on');
421 this.trigger('changed');
423 isGridToggled: function() {
424 return this.rootWrapper.hasClass('grid-on');
429 var isText = function(node) {
430 return node && node.nodeType === Node.TEXT_NODE && $(node.parentNode).is('[document-text-element]');
433 var Selection = function(canvas) {
434 this.canvas = canvas;
435 var nativeSelection = this.nativeSelection = window.getSelection();
436 Object.defineProperty(this, 'type', {
438 if(nativeSelection.focusNode) {
439 if(nativeSelection.isCollapsed && isText(nativeSelection.focusNode)) {
442 if(isText(nativeSelection.focusNode) && isText(nativeSelection.anchorNode)) {
443 return 'textSelection';
446 if(canvas.getCurrentNodeElement()) {
453 $.extend(Selection.prototype, {
454 toDocumentFragment: function() {
455 var doc = this.canvas.wlxmlDocument,
456 anchorElement = this.canvas.getDocumentElement(this.nativeSelection.anchorNode),
457 focusElement = this.canvas.getDocumentElement(this.nativeSelection.focusNode),
458 anchorNode = anchorElement ? anchorElement.wlxmlNode : null,
459 focusNode = focusElement ? focusElement.wlxmlNode : null;
460 if(this.type === 'caret') {
461 return doc.createFragment(doc.CaretFragment, {node: anchorNode, offset: this.nativeSelection.anchorOffset});
463 if(this.type === 'textSelection') {
464 if(anchorNode.isSiblingOf(focusNode)) {
465 return doc.createFragment(doc.TextRangeFragment, {
467 offset1: this.nativeSelection.anchorOffset,
469 offset2: this.nativeSelection.focusOffset,
473 var siblingParents = doc.getSiblingParents({node1: anchorNode, node2: focusNode});
474 return doc.createFragment(doc.RangeFragment, {
475 node1: siblingParents.node1,
476 node2: siblingParents.node2
480 if(this.type === 'node') {
481 return doc.createFragment(doc.NodeFragment, {node: this.canvas.getCurrentNodeElement().wlxmlNode});
484 sameAs: function(other) {
489 var Cursor = function(canvas) {
490 this.canvas = canvas;
491 this.selection = window.getSelection();
494 $.extend(Cursor.prototype, {
495 sameAs: function(other) {
501 ['focusNode', 'focusOffset', 'anchorNode', 'anchorOffset'].some(function(prop) {
502 same = same && this.selection[prop] === other.selection[prop];
504 return true; // break
510 isSelecting: function() {
511 var selection = window.getSelection();
512 return !selection.isCollapsed;
514 isSelectingWithinElement: function() {
515 return this.isSelecting() && this.getSelectionStart().element.sameNode(this.getSelectionEnd().element);
517 isWithinElement: function() {
518 return !this.isSelecting() || this.isSelectingWithinElement();
520 isSelectingSiblings: function() {
521 return this.isSelecting() && this.getSelectionStart().element.parent().sameNode(this.getSelectionEnd().element.parent());
523 getPosition: function() {
524 return this.getSelectionAnchor();
526 getSelectionStart: function() {
527 return this.getSelectionBoundry('start');
529 getSelectionEnd: function() {
530 return this.getSelectionBoundry('end');
532 getSelectionAnchor: function() {
533 return this.getSelectionBoundry('anchor');
535 getSelectionFocus: function() {
536 return this.getSelectionBoundry('focus');
538 getSelectionBoundry: function(which) {
540 var selection = window.getSelection(),
541 anchorElement = this.canvas.getDocumentElement(selection.anchorNode),
542 focusElement = this.canvas.getDocumentElement(selection.focusNode);
544 if((!anchorElement) || (anchorElement instanceof documentElement.DocumentNodeElement) || (!focusElement) || focusElement instanceof documentElement.DocumentNodeElement) {
548 if(which === 'anchor') {
550 element: anchorElement,
551 offset: selection.anchorOffset,
552 offsetAtBeginning: selection.anchorOffset === 0 || anchorElement.getText() === '',
553 offsetAtEnd: selection.anchorNode.data.length === selection.anchorOffset || anchorElement.getText() === ''
556 if(which === 'focus') {
558 element: focusElement,
559 offset: selection.focusOffset,
560 offsetAtBeginning: selection.focusOffset === 0 || focusElement.getText() === '',
561 offsetAtEnd: selection.focusNode.data.length === selection.focusOffset || focusElement.getText() === '',
565 var getPlaceData = function(anchorFirst) {
568 if(which === 'start') {
569 element = anchorElement;
570 offset = selection.anchorOffset;
572 else if(which === 'end') {
573 element = focusElement;
574 offset = selection.focusOffset;
577 if(which === 'start') {
578 element = focusElement;
579 offset = selection.focusOffset;
581 else if(which === 'end') {
582 element = anchorElement;
583 offset = selection.anchorOffset;
586 return {element: element, offset: offset};
589 var anchorFirst, placeData, parent;
591 if(anchorElement.parent().sameNode(focusElement.parent())) {
592 parent = anchorElement.parent();
593 if(selection.anchorNode === selection.focusNode) {
594 anchorFirst = selection.anchorOffset <= selection.focusOffset;
596 anchorFirst = (parent.getFirst(anchorElement, focusElement) === anchorElement);
598 placeData = getPlaceData(anchorFirst);
600 /*jshint bitwise: false*/
601 anchorFirst = selection.anchorNode.compareDocumentPosition(selection.focusNode) & Node.DOCUMENT_POSITION_FOLLOWING;
602 placeData = getPlaceData(anchorFirst);
605 var nodeLen = (placeData.element.sameNode(focusElement) ? selection.focusNode : selection.anchorNode).length;
607 element: placeData.element,
608 offset: placeData.offset,
609 offsetAtBeginning: placeData.offset === 0 || focusElement.getText() === '',
610 offsetAtEnd: nodeLen === placeData.offset || focusElement.getText() === ''
616 fromXMLDocument: function(wlxmlDocument, elements) {
617 return new Canvas(wlxmlDocument, elements);