2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
8 // #### checkSelectionChange : START
\r
10 // The selection change check basically saves the element parent tree of
\r
11 // the current node and check it on successive requests. If there is any
\r
12 // change on the tree, then the selectionChange event gets fired.
\r
13 function checkSelectionChange()
\r
17 // In IE, the "selectionchange" event may still get thrown when
\r
18 // releasing the WYSIWYG mode, so we need to check it first.
\r
19 var sel = this.getSelection();
\r
20 if ( !sel || !sel.document.getWindow().$ )
\r
23 var firstElement = sel.getStartElement();
\r
24 var currentPath = new CKEDITOR.dom.elementPath( firstElement );
\r
26 if ( !currentPath.compare( this._.selectionPreviousPath ) )
\r
28 this._.selectionPreviousPath = currentPath;
\r
29 this.fire( 'selectionChange', { selection : sel, path : currentPath, element : firstElement } );
\r
36 var checkSelectionChangeTimer,
\r
37 checkSelectionChangeTimeoutPending;
\r
39 function checkSelectionChangeTimeout()
\r
41 // Firing the "OnSelectionChange" event on every key press started to
\r
42 // be too slow. This function guarantees that there will be at least
\r
43 // 200ms delay between selection checks.
\r
45 checkSelectionChangeTimeoutPending = true;
\r
47 if ( checkSelectionChangeTimer )
\r
50 checkSelectionChangeTimeoutExec.call( this );
\r
52 checkSelectionChangeTimer = CKEDITOR.tools.setTimeout( checkSelectionChangeTimeoutExec, 200, this );
\r
55 function checkSelectionChangeTimeoutExec()
\r
57 checkSelectionChangeTimer = null;
\r
59 if ( checkSelectionChangeTimeoutPending )
\r
61 // Call this with a timeout so the browser properly moves the
\r
62 // selection after the mouseup. It happened that the selection was
\r
63 // being moved after the mouseup when clicking inside selected text
\r
65 CKEDITOR.tools.setTimeout( checkSelectionChange, 0, this );
\r
67 checkSelectionChangeTimeoutPending = false;
\r
71 // #### checkSelectionChange : END
\r
73 function rangeRequiresFix( range )
\r
75 function isInlineCt( node )
\r
77 return node && node.type == CKEDITOR.NODE_ELEMENT
\r
78 && node.getName() in CKEDITOR.dtd.$removeEmpty;
\r
81 function singletonBlock( node )
\r
83 var body = range.document.getBody();
\r
84 return !node.is( 'body' ) && body.getChildCount() == 1;
\r
87 var start = range.startContainer,
\r
88 offset = range.startOffset;
\r
90 if ( start.type == CKEDITOR.NODE_TEXT )
\r
93 // 1. Empty inline element. <span>^</span>
\r
94 // 2. Adjoin to inline element. <p><strong>text</strong>^</p>
\r
95 // 3. The only empty block in document. <body><p>^</p></body> (#7222)
\r
96 return !CKEDITOR.tools.trim( start.getHtml() ) ? isInlineCt( start ) || singletonBlock( start )
\r
97 : isInlineCt( start.getChild( offset - 1 ) ) || isInlineCt( start.getChild( offset ) );
\r
102 modes : { wysiwyg : 1, source : 1 },
\r
103 readOnly : CKEDITOR.env.ie || CKEDITOR.env.webkit,
\r
104 exec : function( editor )
\r
106 switch ( editor.mode )
\r
109 editor.document.$.execCommand( 'SelectAll', false, null );
\r
110 // Force triggering selectionChange (#7008)
\r
111 editor.forceNextSelectionCheck();
\r
112 editor.selectionChange();
\r
115 // Select the contents of the textarea
\r
116 var textarea = editor.textarea.$;
\r
117 if ( CKEDITOR.env.ie )
\r
118 textarea.createTextRange().execCommand( 'SelectAll' );
\r
121 textarea.selectionStart = 0;
\r
122 textarea.selectionEnd = textarea.value.length;
\r
130 function createFillingChar( doc )
\r
132 removeFillingChar( doc );
\r
134 var fillingChar = doc.createText( '\u200B' );
\r
135 doc.setCustomData( 'cke-fillingChar', fillingChar );
\r
137 return fillingChar;
\r
140 function getFillingChar( doc )
\r
142 return doc && doc.getCustomData( 'cke-fillingChar' );
\r
145 // Checks if a filling char has been used, eventualy removing it (#1272).
\r
146 function checkFillingChar( doc )
\r
148 var fillingChar = doc && getFillingChar( doc );
\r
151 // Use this flag to avoid removing the filling char right after
\r
153 if ( fillingChar.getCustomData( 'ready' ) )
\r
154 removeFillingChar( doc );
\r
156 fillingChar.setCustomData( 'ready', 1 );
\r
160 function removeFillingChar( doc )
\r
162 var fillingChar = doc && doc.removeCustomData( 'cke-fillingChar' );
\r
165 // We can't simply remove the filling node because the user
\r
166 // will actually enlarge it when typing, so we just remove the
\r
167 // invisible char from it.
\r
168 fillingChar.setText( fillingChar.getText().replace( /\u200B/g, '' ) );
\r
173 CKEDITOR.plugins.add( 'selection',
\r
175 init : function( editor )
\r
177 // On WebKit only, we need a special "filling" char on some situations
\r
178 // (#1272). Here we set the events that should invalidate that char.
\r
179 if ( CKEDITOR.env.webkit )
\r
181 editor.on( 'selectionChange', function() { checkFillingChar( editor.document ); } );
\r
182 editor.on( 'beforeSetMode', function() { removeFillingChar( editor.document ); } );
\r
183 editor.on( 'key', function( e )
\r
185 // Remove the filling char before some keys get
\r
186 // executed, so they'll not get blocked by it.
\r
187 switch ( e.data.keyCode )
\r
190 case CKEDITOR.SHIFT + 13 : // SHIFT-ENTER
\r
191 case 37 : // LEFT-ARROW
\r
192 case 39 : // RIGHT-ARROW
\r
193 case 8 : // BACKSPACE
\r
194 removeFillingChar( editor.document );
\r
196 }, null, null, 10 );
\r
198 var fillingCharBefore,
\r
201 function beforeData()
\r
203 var doc = editor.document,
\r
204 fillingChar = getFillingChar( doc );
\r
208 // If cursor is right blinking by side of the filler node, save it for restoring,
\r
209 // as the following text substitution will blind it. (#7437)
\r
210 var sel = doc.$.defaultView.getSelection();
\r
211 if ( sel.type == 'Caret' && sel.anchorNode == fillingChar.$ )
\r
212 resetSelection = 1;
\r
214 fillingCharBefore = fillingChar.getText();
\r
215 fillingChar.setText( fillingCharBefore.replace( /\u200B/g, '' ) );
\r
218 function afterData()
\r
220 var doc = editor.document,
\r
221 fillingChar = getFillingChar( doc );
\r
225 fillingChar.setText( fillingCharBefore );
\r
227 if ( resetSelection )
\r
229 doc.$.defaultView.getSelection().setPosition( fillingChar.$,fillingChar.getLength() );
\r
230 resetSelection = 0;
\r
234 editor.on( 'beforeUndoImage', beforeData );
\r
235 editor.on( 'afterUndoImage', afterData );
\r
236 editor.on( 'beforeGetData', beforeData, null, null, 0 );
\r
237 editor.on( 'getData', afterData );
\r
240 editor.on( 'contentDom', function()
\r
242 var doc = editor.document,
\r
243 body = doc.getBody(),
\r
244 html = doc.getDocumentElement();
\r
246 if ( CKEDITOR.env.ie )
\r
248 // Other browsers don't loose the selection if the
\r
249 // editor document loose the focus. In IE, we don't
\r
250 // have support for it, so we reproduce it here, other
\r
251 // than firing the selection change event.
\r
255 restoreEnabled = 1;
\r
257 // "onfocusin" is fired before "onfocus". It makes it
\r
258 // possible to restore the selection before click
\r
259 // events get executed.
\r
260 body.on( 'focusin', function( evt )
\r
262 // If there are elements with layout they fire this event but
\r
263 // it must be ignored to allow edit its contents #4682
\r
264 if ( evt.data.$.srcElement.nodeName != 'BODY' )
\r
267 // If we have saved a range, restore it at this
\r
271 if ( restoreEnabled )
\r
273 // Well not break because of this.
\r
276 savedRange.select();
\r
281 // Update locked selection because of the normalized text nodes. (#6083, #6987)
\r
282 var lockedSelection = doc.getCustomData( 'cke_locked_selection' );
\r
283 if ( lockedSelection )
\r
285 lockedSelection.unlock();
\r
286 lockedSelection.lock();
\r
294 body.on( 'focus', function()
\r
296 // Enable selections to be saved.
\r
302 body.on( 'beforedeactivate', function( evt )
\r
304 // Ignore this event if it's caused by focus switch between
\r
305 // internal editable control type elements, e.g. layouted paragraph. (#4682)
\r
306 if ( evt.data.$.toElement )
\r
309 // Disable selections from being saved.
\r
311 restoreEnabled = 1;
\r
314 // IE before version 8 will leave cursor blinking inside the document after
\r
315 // editor blurred unless we clean up the selection. (#4716)
\r
316 if ( CKEDITOR.env.ie && CKEDITOR.env.version < 8 )
\r
318 editor.on( 'blur', function( evt )
\r
320 // Try/Catch to avoid errors if the editor is hidden. (#6375)
\r
323 editor.document && editor.document.$.selection.empty();
\r
329 // Listening on document element ensures that
\r
330 // scrollbar is included. (#5280)
\r
331 html.on( 'mousedown', function()
\r
333 // Lock restore selection now, as we have
\r
334 // a followed 'click' event which introduce
\r
335 // new selection. (#5735)
\r
336 restoreEnabled = 0;
\r
339 html.on( 'mouseup', function()
\r
341 restoreEnabled = 1;
\r
344 // In IE6/7 the blinking cursor appears, but contents are
\r
345 // not editable. (#5634)
\r
346 if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.version < 8 || CKEDITOR.env.quirks ) )
\r
348 // The 'click' event is not fired when clicking the
\r
349 // scrollbars, so we can use it to check whether
\r
350 // the empty space following <body> has been clicked.
\r
351 html.on( 'click', function( evt )
\r
353 if ( evt.data.getTarget().getName() == 'html' )
\r
354 editor.getSelection().getRanges()[ 0 ].select();
\r
359 // IE fires the "selectionchange" event when clicking
\r
360 // inside a selection. We don't want to capture that.
\r
361 body.on( 'mousedown', function( evt )
\r
363 // IE scrolls document to top on right mousedown
\r
364 // when editor has no focus, remember this scroll
\r
365 // position and revert it before context menu opens. (#5778)
\r
366 if ( evt.data.$.button == 2 )
\r
368 var sel = editor.document.$.selection;
\r
369 if ( sel.type == 'None' )
\r
370 scroll = editor.window.getScrollPosition();
\r
375 body.on( 'mouseup',
\r
378 // Restore recorded scroll position when needed on right mouseup.
\r
379 if ( evt.data.$.button == 2 && scroll )
\r
381 editor.document.$.documentElement.scrollLeft = scroll.x;
\r
382 editor.document.$.documentElement.scrollTop = scroll.y;
\r
387 setTimeout( function()
\r
389 saveSelection( true );
\r
394 body.on( 'keydown', disableSave );
\r
403 // IE is the only to provide the "selectionchange"
\r
405 doc.on( 'selectionchange', saveSelection );
\r
407 function disableSave()
\r
412 function saveSelection( testIt )
\r
416 var doc = editor.document,
\r
417 sel = editor.getSelection(),
\r
418 nativeSel = sel && sel.getNative();
\r
420 // There is a very specific case, when clicking
\r
421 // inside a text selection. In that case, the
\r
422 // selection collapses at the clicking point,
\r
423 // but the selection object remains in an
\r
424 // unknown state, making createRange return a
\r
425 // range at the very start of the document. In
\r
426 // such situation we have to test the range, to
\r
427 // be sure it's valid.
\r
428 if ( testIt && nativeSel && nativeSel.type == 'None' )
\r
430 // The "InsertImage" command can be used to
\r
431 // test whether the selection is good or not.
\r
432 // If not, it's enough to give some time to
\r
433 // IE to put things in order for us.
\r
434 if ( !doc.$.queryCommandEnabled( 'InsertImage' ) )
\r
436 CKEDITOR.tools.setTimeout( saveSelection, 50, this, true );
\r
441 // Avoid saving selection from within text input. (#5747)
\r
443 if ( nativeSel && nativeSel.type && nativeSel.type != 'Control'
\r
444 && ( parentTag = nativeSel.createRange() )
\r
445 && ( parentTag = parentTag.parentElement() )
\r
446 && ( parentTag = parentTag.nodeName )
\r
447 && parentTag.toLowerCase() in { input: 1, textarea : 1 } )
\r
452 savedRange = nativeSel && sel.getRanges()[ 0 ];
\r
454 checkSelectionChangeTimeout.call( editor );
\r
460 // In other browsers, we make the selection change
\r
461 // check based on other events, like clicks or keys
\r
464 doc.on( 'mouseup', checkSelectionChangeTimeout, editor );
\r
465 doc.on( 'keyup', checkSelectionChangeTimeout, editor );
\r
469 // Clear the cached range path before unload. (#7174)
\r
470 editor.on( 'contentDomUnload', editor.forceNextSelectionCheck, editor );
\r
472 editor.addCommand( 'selectAll', selectAllCmd );
\r
473 editor.ui.addButton( 'SelectAll',
\r
475 label : editor.lang.selectAll,
\r
476 command : 'selectAll'
\r
479 editor.selectionChange = checkSelectionChangeTimeout;
\r
481 // IE9 might cease to work if there's an object selection inside the iframe (#7639).
\r
482 CKEDITOR.env.ie9Compat && editor.on( 'destroy', function()
\r
484 var sel = editor.getSelection();
\r
485 sel && sel.getNative().clear();
\r
486 }, null, null, 9 );
\r
491 * Gets the current selection from the editing area when in WYSIWYG mode.
\r
492 * @returns {CKEDITOR.dom.selection} A selection object or null if not on
\r
493 * WYSIWYG mode or no selection is available.
\r
495 * var selection = CKEDITOR.instances.editor1.<b>getSelection()</b>;
\r
496 * alert( selection.getType() );
\r
498 CKEDITOR.editor.prototype.getSelection = function()
\r
500 return this.document && this.document.getSelection();
\r
503 CKEDITOR.editor.prototype.forceNextSelectionCheck = function()
\r
505 delete this._.selectionPreviousPath;
\r
509 * Gets the current selection from the document.
\r
510 * @returns {CKEDITOR.dom.selection} A selection object.
\r
512 * var selection = CKEDITOR.instances.editor1.document.<b>getSelection()</b>;
\r
513 * alert( selection.getType() );
\r
515 CKEDITOR.dom.document.prototype.getSelection = function()
\r
517 var sel = new CKEDITOR.dom.selection( this );
\r
518 return ( !sel || sel.isInvalid ) ? null : sel;
\r
525 * if ( editor.getSelection().getType() == CKEDITOR.SELECTION_NONE )
\r
526 * alert( 'Nothing is selected' );
\r
528 CKEDITOR.SELECTION_NONE = 1;
\r
531 * Text or collapsed selection.
\r
534 * if ( editor.getSelection().getType() == CKEDITOR.SELECTION_TEXT )
\r
535 * alert( 'Text is selected' );
\r
537 CKEDITOR.SELECTION_TEXT = 2;
\r
540 * Element selection.
\r
543 * if ( editor.getSelection().getType() == CKEDITOR.SELECTION_ELEMENT )
\r
544 * alert( 'An element is selected' );
\r
546 CKEDITOR.SELECTION_ELEMENT = 3;
\r
549 * Manipulates the selection in a DOM document.
\r
553 CKEDITOR.dom.selection = function( document )
\r
555 var lockedSelection = document.getCustomData( 'cke_locked_selection' );
\r
557 if ( lockedSelection )
\r
558 return lockedSelection;
\r
560 this.document = document;
\r
568 * IE BUG: The selection's document may be a different document than the
\r
569 * editor document. Return null if that's the case.
\r
571 if ( CKEDITOR.env.ie )
\r
573 var range = this.getNative().createRange();
\r
575 || ( range.item && range.item(0).ownerDocument != this.document.$ )
\r
576 || ( range.parentElement && range.parentElement().ownerDocument != this.document.$ ) )
\r
578 this.isInvalid = true;
\r
585 var styleObjectElements =
\r
587 img:1,hr:1,li:1,table:1,tr:1,td:1,th:1,embed:1,object:1,ol:1,ul:1,
\r
588 a:1,input:1,form:1,select:1,textarea:1,button:1,fieldset:1,thead:1,tfoot:1
\r
591 CKEDITOR.dom.selection.prototype =
\r
594 * Gets the native selection object from the browser.
\r
596 * @returns {Object} The native selection object.
\r
598 * var selection = editor.getSelection().<b>getNative()</b>;
\r
604 return this._.cache.nativeSel || ( this._.cache.nativeSel = this.document.$.selection );
\r
609 return this._.cache.nativeSel || ( this._.cache.nativeSel = this.document.getWindow().$.getSelection() );
\r
613 * Gets the type of the current selection. The following values are
\r
616 * <li>{@link CKEDITOR.SELECTION_NONE} (1): No selection.</li>
\r
617 * <li>{@link CKEDITOR.SELECTION_TEXT} (2): Text is selected or
\r
618 * collapsed selection.</li>
\r
619 * <li>{@link CKEDITOR.SELECTION_ELEMENT} (3): A element
\r
623 * @returns {Number} One of the following constant values:
\r
624 * {@link CKEDITOR.SELECTION_NONE}, {@link CKEDITOR.SELECTION_TEXT} or
\r
625 * {@link CKEDITOR.SELECTION_ELEMENT}.
\r
627 * if ( editor.getSelection().<b>getType()</b> == CKEDITOR.SELECTION_TEXT )
\r
628 * alert( 'Text is selected' );
\r
634 var cache = this._.cache;
\r
638 var type = CKEDITOR.SELECTION_NONE;
\r
642 var sel = this.getNative(),
\r
645 if ( ieType == 'Text' )
\r
646 type = CKEDITOR.SELECTION_TEXT;
\r
648 if ( ieType == 'Control' )
\r
649 type = CKEDITOR.SELECTION_ELEMENT;
\r
651 // It is possible that we can still get a text range
\r
652 // object even when type == 'None' is returned by IE.
\r
653 // So we'd better check the object returned by
\r
654 // createRange() rather than by looking at the type.
\r
655 if ( sel.createRange().parentElement )
\r
656 type = CKEDITOR.SELECTION_TEXT;
\r
660 return ( cache.type = type );
\r
665 var cache = this._.cache;
\r
669 var type = CKEDITOR.SELECTION_TEXT;
\r
671 var sel = this.getNative();
\r
674 type = CKEDITOR.SELECTION_NONE;
\r
675 else if ( sel.rangeCount == 1 )
\r
677 // Check if the actual selection is a control (IMG,
\r
678 // TABLE, HR, etc...).
\r
680 var range = sel.getRangeAt(0),
\r
681 startContainer = range.startContainer;
\r
683 if ( startContainer == range.endContainer
\r
684 && startContainer.nodeType == 1
\r
685 && ( range.endOffset - range.startOffset ) == 1
\r
686 && styleObjectElements[ startContainer.childNodes[ range.startOffset ].nodeName.toLowerCase() ] )
\r
688 type = CKEDITOR.SELECTION_ELEMENT;
\r
692 return ( cache.type = type );
\r
696 * Retrieve the {@link CKEDITOR.dom.range} instances that represent the current selection.
\r
697 * Note: Some browsers returns multiple ranges even on a sequent selection, e.g. Firefox returns
\r
698 * one range for each table cell when one or more table row is selected.
\r
701 * var ranges = selection.getRanges();
\r
702 * alert(ranges.length);
\r
704 getRanges : (function()
\r
706 var func = CKEDITOR.env.ie ?
\r
709 function getNodeIndex( node ) { return new CKEDITOR.dom.node( node ).getIndex(); }
\r
711 // Finds the container and offset for a specific boundary
\r
713 var getBoundaryInformation = function( range, start )
\r
715 // Creates a collapsed range at the requested boundary.
\r
716 range = range.duplicate();
\r
717 range.collapse( start );
\r
719 // Gets the element that encloses the range entirely.
\r
720 var parent = range.parentElement(),
\r
721 doc = parent.ownerDocument;
\r
723 // Empty parent element, e.g. <i>^</i>
\r
724 if ( !parent.hasChildNodes() )
\r
725 return { container : parent, offset : 0 };
\r
727 var siblings = parent.children,
\r
730 testRange = range.duplicate(),
\r
732 endIndex = siblings.length - 1,
\r
737 // Binary search over all element childs to test the range to see whether
\r
738 // range is right on the boundary of one element.
\r
739 while ( startIndex <= endIndex )
\r
741 index = Math.floor( ( startIndex + endIndex ) / 2 );
\r
742 child = siblings[ index ];
\r
743 testRange.moveToElementText( child );
\r
744 position = testRange.compareEndPoints( 'StartToStart', range );
\r
746 if ( position > 0 )
\r
747 endIndex = index - 1;
\r
748 else if ( position < 0 )
\r
749 startIndex = index + 1;
\r
752 // IE9 report wrong measurement with compareEndPoints when range anchors between two BRs.
\r
753 // e.g. <p>text<br />^<br /></p> (#7433)
\r
754 if ( CKEDITOR.env.ie9Compat && child.tagName == 'BR' )
\r
756 var bmId = 'cke_range_marker';
\r
757 range.execCommand( 'CreateBookmark', false, bmId );
\r
758 child = doc.getElementsByName( bmId )[ 0 ];
\r
759 var offset = getNodeIndex( child );
\r
760 parent.removeChild( child );
\r
761 return { container : parent, offset : offset };
\r
764 return { container : parent, offset : getNodeIndex( child ) };
\r
768 // All childs are text nodes,
\r
769 // or to the right hand of test range are all text nodes. (#6992)
\r
770 if ( index == -1 || index == siblings.length - 1 && position < 0 )
\r
772 // Adapt test range to embrace the entire parent contents.
\r
773 testRange.moveToElementText( parent );
\r
774 testRange.setEndPoint( 'StartToStart', range );
\r
776 // IE report line break as CRLF with range.text but
\r
777 // only LF with textnode.nodeValue, normalize them to avoid
\r
778 // breaking character counting logic below. (#3949)
\r
779 distance = testRange.text.replace( /(\r\n|\r)/g, '\n' ).length;
\r
781 siblings = parent.childNodes;
\r
783 // Actual range anchor right beside test range at the boundary of text node.
\r
786 child = siblings[ siblings.length - 1 ];
\r
788 if ( child.nodeType == CKEDITOR.NODE_ELEMENT )
\r
789 return { container : parent, offset : siblings.length };
\r
791 return { container : child, offset : child.nodeValue.length };
\r
794 // Start the measuring until distance overflows, meanwhile count the text nodes.
\r
795 var i = siblings.length;
\r
796 while ( distance > 0 )
\r
797 distance -= siblings[ --i ].nodeValue.length;
\r
799 return { container : siblings[ i ], offset : -distance };
\r
801 // Test range was one offset beyond OR behind the anchored text node.
\r
804 // Adapt one side of test range to the actual range
\r
805 // for measuring the offset between them.
\r
806 testRange.collapse( position > 0 ? true : false );
\r
807 testRange.setEndPoint( position > 0 ? 'StartToStart' : 'EndToStart', range );
\r
809 // IE report line break as CRLF with range.text but
\r
810 // only LF with textnode.nodeValue, normalize them to avoid
\r
811 // breaking character counting logic below. (#3949)
\r
812 distance = testRange.text.replace( /(\r\n|\r)/g, '\n' ).length;
\r
814 // Actual range anchor right beside test range at the inner boundary of text node.
\r
816 return { container : parent, offset : getNodeIndex( child ) + ( position > 0 ? 0 : 1 ) };
\r
818 // Start the measuring until distance overflows, meanwhile count the text nodes.
\r
819 while ( distance > 0 )
\r
823 sibling = child[ position > 0 ? 'previousSibling' : 'nextSibling' ];
\r
824 distance -= sibling.nodeValue.length;
\r
827 // Measurement in IE could be somtimes wrong because of <select> element. (#4611)
\r
830 return { container : parent, offset : getNodeIndex( child ) };
\r
834 return { container : child, offset : position > 0 ? -distance : child.nodeValue.length + distance };
\r
840 // IE doesn't have range support (in the W3C way), so we
\r
841 // need to do some magic to transform selections into
\r
842 // CKEDITOR.dom.range instances.
\r
844 var sel = this.getNative(),
\r
845 nativeRange = sel && sel.createRange(),
\r
846 type = this.getType(),
\r
852 if ( type == CKEDITOR.SELECTION_TEXT )
\r
854 range = new CKEDITOR.dom.range( this.document );
\r
856 var boundaryInfo = getBoundaryInformation( nativeRange, true );
\r
857 range.setStart( new CKEDITOR.dom.node( boundaryInfo.container ), boundaryInfo.offset );
\r
859 boundaryInfo = getBoundaryInformation( nativeRange );
\r
860 range.setEnd( new CKEDITOR.dom.node( boundaryInfo.container ), boundaryInfo.offset );
\r
862 // Correct an invalid IE range case on empty list item. (#5850)
\r
863 if ( range.endContainer.getPosition( range.startContainer ) & CKEDITOR.POSITION_PRECEDING
\r
864 && range.endOffset <= range.startContainer.getIndex() )
\r
871 else if ( type == CKEDITOR.SELECTION_ELEMENT )
\r
875 for ( var i = 0 ; i < nativeRange.length ; i++ )
\r
877 var element = nativeRange.item( i ),
\r
878 parentElement = element.parentNode,
\r
881 range = new CKEDITOR.dom.range( this.document );
\r
883 for (; j < parentElement.childNodes.length && parentElement.childNodes[j] != element ; j++ )
\r
886 range.setStart( new CKEDITOR.dom.node( parentElement ), j );
\r
887 range.setEnd( new CKEDITOR.dom.node( parentElement ), j + 1 );
\r
888 retval.push( range );
\r
901 // On browsers implementing the W3C range, we simply
\r
902 // tranform the native ranges in CKEDITOR.dom.range
\r
907 doc = this.document,
\r
908 sel = this.getNative();
\r
913 // On WebKit, it may happen that we'll have no selection
\r
914 // available. We normalize it here by replicating the
\r
915 // behavior of other browsers.
\r
916 if ( !sel.rangeCount )
\r
918 range = new CKEDITOR.dom.range( doc );
\r
919 range.moveToElementEditStart( doc.getBody() );
\r
920 ranges.push( range );
\r
923 for ( var i = 0 ; i < sel.rangeCount ; i++ )
\r
925 var nativeRange = sel.getRangeAt( i );
\r
927 range = new CKEDITOR.dom.range( doc );
\r
929 range.setStart( new CKEDITOR.dom.node( nativeRange.startContainer ), nativeRange.startOffset );
\r
930 range.setEnd( new CKEDITOR.dom.node( nativeRange.endContainer ), nativeRange.endOffset );
\r
931 ranges.push( range );
\r
936 return function( onlyEditables )
\r
938 var cache = this._.cache;
\r
939 if ( cache.ranges && !onlyEditables )
\r
940 return cache.ranges;
\r
941 else if ( !cache.ranges )
\r
942 cache.ranges = new CKEDITOR.dom.rangeList( func.call( this ) );
\r
944 // Split range into multiple by read-only nodes.
\r
945 if ( onlyEditables )
\r
947 var ranges = cache.ranges;
\r
948 for ( var i = 0; i < ranges.length; i++ )
\r
950 var range = ranges[ i ];
\r
952 // Drop range spans inside one ready-only node.
\r
953 var parent = range.getCommonAncestor();
\r
954 if ( parent.isReadOnly() )
\r
955 ranges.splice( i, 1 );
\r
957 if ( range.collapsed )
\r
960 var startContainer = range.startContainer,
\r
961 endContainer = range.endContainer,
\r
962 startOffset = range.startOffset,
\r
963 endOffset = range.endOffset,
\r
964 walkerRange = range.clone();
\r
966 // Range may start inside a non-editable element, restart range
\r
967 // by the end of it.
\r
969 if ( ( readOnly = startContainer.isReadOnly() ) )
\r
970 range.setStartAfter( readOnly );
\r
972 // Enlarge range start/end with text node to avoid walker
\r
973 // being DOM destructive, it doesn't interfere our checking
\r
974 // of elements below as well.
\r
975 if ( startContainer && startContainer.type == CKEDITOR.NODE_TEXT )
\r
977 if ( startOffset >= startContainer.getLength() )
\r
978 walkerRange.setStartAfter( startContainer );
\r
980 walkerRange.setStartBefore( startContainer );
\r
983 if ( endContainer && endContainer.type == CKEDITOR.NODE_TEXT )
\r
986 walkerRange.setEndBefore( endContainer );
\r
988 walkerRange.setEndAfter( endContainer );
\r
991 // Looking for non-editable element inside the range.
\r
992 var walker = new CKEDITOR.dom.walker( walkerRange );
\r
993 walker.evaluator = function( node )
\r
995 if ( node.type == CKEDITOR.NODE_ELEMENT
\r
996 && node.isReadOnly() )
\r
998 var newRange = range.clone();
\r
999 range.setEndBefore( node );
\r
1001 // Drop collapsed range around read-only elements,
\r
1002 // it make sure the range list empty when selecting
\r
1003 // only non-editable elements.
\r
1004 if ( range.collapsed )
\r
1005 ranges.splice( i--, 1 );
\r
1007 // Avoid creating invalid range.
\r
1008 if ( !( node.getPosition( walkerRange.endContainer ) & CKEDITOR.POSITION_CONTAINS ) )
\r
1010 newRange.setStartAfter( node );
\r
1011 if ( !newRange.collapsed )
\r
1012 ranges.splice( i + 1, 0, newRange );
\r
1025 return cache.ranges;
\r
1030 * Gets the DOM element in which the selection starts.
\r
1031 * @returns {CKEDITOR.dom.element} The element at the beginning of the
\r
1034 * var element = editor.getSelection().<b>getStartElement()</b>;
\r
1035 * alert( element.getName() );
\r
1037 getStartElement : function()
\r
1039 var cache = this._.cache;
\r
1040 if ( cache.startElement !== undefined )
\r
1041 return cache.startElement;
\r
1044 sel = this.getNative();
\r
1046 switch ( this.getType() )
\r
1048 case CKEDITOR.SELECTION_ELEMENT :
\r
1049 return this.getSelectedElement();
\r
1051 case CKEDITOR.SELECTION_TEXT :
\r
1053 var range = this.getRanges()[0];
\r
1057 if ( !range.collapsed )
\r
1061 // Decrease the range content to exclude particial
\r
1062 // selected node on the start which doesn't have
\r
1063 // visual impact. ( #3231 )
\r
1066 var startContainer = range.startContainer,
\r
1067 startOffset = range.startOffset;
\r
1068 // Limit the fix only to non-block elements.(#3950)
\r
1069 if ( startOffset == ( startContainer.getChildCount ?
\r
1070 startContainer.getChildCount() : startContainer.getLength() )
\r
1071 && !startContainer.isBlockBoundary() )
\r
1072 range.setStartAfter( startContainer );
\r
1076 node = range.startContainer;
\r
1078 if ( node.type != CKEDITOR.NODE_ELEMENT )
\r
1079 return node.getParent();
\r
1081 node = node.getChild( range.startOffset );
\r
1083 if ( !node || node.type != CKEDITOR.NODE_ELEMENT )
\r
1084 node = range.startContainer;
\r
1087 var child = node.getFirst();
\r
1088 while ( child && child.type == CKEDITOR.NODE_ELEMENT )
\r
1091 child = child.getFirst();
\r
1097 node = range.startContainer;
\r
1098 if ( node.type != CKEDITOR.NODE_ELEMENT )
\r
1099 node = node.getParent();
\r
1106 return cache.startElement = ( node ? new CKEDITOR.dom.element( node ) : null );
\r
1110 * Gets the current selected element.
\r
1111 * @returns {CKEDITOR.dom.element} The selected element. Null if no
\r
1112 * selection is available or the selection type is not
\r
1113 * {@link CKEDITOR.SELECTION_ELEMENT}.
\r
1115 * var element = editor.getSelection().<b>getSelectedElement()</b>;
\r
1116 * alert( element.getName() );
\r
1118 getSelectedElement : function()
\r
1120 var cache = this._.cache;
\r
1121 if ( cache.selectedElement !== undefined )
\r
1122 return cache.selectedElement;
\r
1126 var node = CKEDITOR.tools.tryThese(
\r
1127 // Is it native IE control type selection?
\r
1130 return self.getNative().createRange().item( 0 );
\r
1132 // Figure it out by checking if there's a single enclosed
\r
1133 // node of the range.
\r
1136 var range = self.getRanges()[ 0 ],
\r
1140 // Check first any enclosed element, e.g. <ul>[<li><a href="#">item</a></li>]</ul>
\r
1141 for ( var i = 2; i && !( ( enclosed = range.getEnclosedNode() )
\r
1142 && ( enclosed.type == CKEDITOR.NODE_ELEMENT )
\r
1143 && styleObjectElements[ enclosed.getName() ]
\r
1144 && ( selected = enclosed ) ); i-- )
\r
1146 // Then check any deep wrapped element, e.g. [<b><i><img /></i></b>]
\r
1147 range.shrink( CKEDITOR.SHRINK_ELEMENT );
\r
1150 return selected.$;
\r
1153 return cache.selectedElement = ( node ? new CKEDITOR.dom.element( node ) : null );
\r
1157 * Retrieves the text contained within the range, empty string is returned for non-text selection.
\r
1158 * @returns {String} string of text within the current selection.
\r
1161 * var text = editor.getSelectedText();
\r
1164 getSelectedText : function()
\r
1166 var cache = this._.cache;
\r
1167 if ( cache.selectedText !== undefined )
\r
1168 return cache.selectedText;
\r
1171 nativeSel = this.getNative();
\r
1172 if ( this.getType() == CKEDITOR.SELECTION_TEXT )
\r
1173 text = CKEDITOR.env.ie ? nativeSel.createRange().text : nativeSel.toString();
\r
1175 return ( cache.selectedText = text );
\r
1180 // Call all cacheable function.
\r
1182 this.getStartElement();
\r
1183 this.getSelectedElement();
\r
1184 this.getSelectedText();
\r
1186 // The native selection is not available when locked.
\r
1187 this._.cache.nativeSel = {};
\r
1189 this.isLocked = 1;
\r
1191 // Save this selection inside the DOM document.
\r
1192 this.document.setCustomData( 'cke_locked_selection', this );
\r
1195 unlock : function( restore )
\r
1197 var doc = this.document,
\r
1198 lockedSelection = doc.getCustomData( 'cke_locked_selection' );
\r
1200 if ( lockedSelection )
\r
1202 doc.setCustomData( 'cke_locked_selection', null );
\r
1206 var selectedElement = lockedSelection.getSelectedElement(),
\r
1207 ranges = !selectedElement && lockedSelection.getRanges();
\r
1209 this.isLocked = 0;
\r
1212 doc.getBody().focus();
\r
1214 if ( selectedElement )
\r
1215 this.selectElement( selectedElement );
\r
1217 this.selectRanges( ranges );
\r
1221 if ( !lockedSelection || !restore )
\r
1223 this.isLocked = 0;
\r
1228 reset : function()
\r
1230 this._.cache = {};
\r
1234 * Make the current selection of type {@link CKEDITOR.SELECTION_ELEMENT} by enclosing the specified element.
\r
1237 selectElement : function( element )
\r
1239 if ( this.isLocked )
\r
1241 var range = new CKEDITOR.dom.range( this.document );
\r
1242 range.setStartBefore( element );
\r
1243 range.setEndAfter( element );
\r
1245 this._.cache.selectedElement = element;
\r
1246 this._.cache.startElement = element;
\r
1247 this._.cache.ranges = new CKEDITOR.dom.rangeList( range );
\r
1248 this._.cache.type = CKEDITOR.SELECTION_ELEMENT;
\r
1253 range = new CKEDITOR.dom.range( element.getDocument() );
\r
1254 range.setStartBefore( element );
\r
1255 range.setEndAfter( element );
\r
1258 this.document.fire( 'selectionchange' );
\r
1264 * Adding the specified ranges to document selection preceding
\r
1265 * by clearing up the original selection.
\r
1266 * @param {CKEDITOR.dom.range} ranges
\r
1268 selectRanges : function( ranges )
\r
1270 if ( this.isLocked )
\r
1272 this._.cache.selectedElement = null;
\r
1273 this._.cache.startElement = ranges[ 0 ] && ranges[ 0 ].getTouchedStartNode();
\r
1274 this._.cache.ranges = new CKEDITOR.dom.rangeList( ranges );
\r
1275 this._.cache.type = CKEDITOR.SELECTION_TEXT;
\r
1280 if ( CKEDITOR.env.ie )
\r
1282 if ( ranges.length > 1 )
\r
1284 // IE doesn't accept multiple ranges selection, so we join all into one.
\r
1285 var last = ranges[ ranges.length -1 ] ;
\r
1286 ranges[ 0 ].setEnd( last.endContainer, last.endOffset );
\r
1287 ranges.length = 1;
\r
1290 if ( ranges[ 0 ] )
\r
1291 ranges[ 0 ].select();
\r
1297 var sel = this.getNative();
\r
1299 // getNative() returns null if iframe is "display:none" in FF. (#6577)
\r
1303 if ( ranges.length )
\r
1305 sel.removeAllRanges();
\r
1306 // Remove any existing filling char first.
\r
1307 CKEDITOR.env.webkit && removeFillingChar( this.document );
\r
1310 for ( var i = 0 ; i < ranges.length ; i++ )
\r
1312 // Joining sequential ranges introduced by
\r
1313 // readonly elements protection.
\r
1314 if ( i < ranges.length -1 )
\r
1316 var left = ranges[ i ], right = ranges[ i +1 ],
\r
1317 between = left.clone();
\r
1318 between.setStart( left.endContainer, left.endOffset );
\r
1319 between.setEnd( right.startContainer, right.startOffset );
\r
1321 // Don't confused by Firefox adjancent multi-ranges
\r
1322 // introduced by table cells selection.
\r
1323 if ( !between.collapsed )
\r
1325 between.shrink( CKEDITOR.NODE_ELEMENT, true );
\r
1326 var ancestor = between.getCommonAncestor(),
\r
1327 enclosed = between.getEnclosedNode();
\r
1329 // The following cases has to be considered:
\r
1330 // 1. <span contenteditable="false">[placeholder]</span>
\r
1331 // 2. <input contenteditable="false" type="radio"/> (#6621)
\r
1332 if ( ancestor.isReadOnly() || enclosed && enclosed.isReadOnly() )
\r
1334 right.setStart( left.startContainer, left.startOffset );
\r
1335 ranges.splice( i--, 1 );
\r
1341 var range = ranges[ i ];
\r
1342 var nativeRange = this.document.$.createRange();
\r
1343 var startContainer = range.startContainer;
\r
1345 // In FF2, if we have a collapsed range, inside an empty
\r
1346 // element, we must add something to it otherwise the caret
\r
1347 // will not be visible.
\r
1348 // In Opera instead, the selection will be moved out of the
\r
1349 // element. (#4657)
\r
1350 if ( range.collapsed &&
\r
1351 ( CKEDITOR.env.opera || ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) ) &&
\r
1352 startContainer.type == CKEDITOR.NODE_ELEMENT &&
\r
1353 !startContainer.getChildCount() )
\r
1355 startContainer.appendText( '' );
\r
1358 if ( range.collapsed
\r
1359 && CKEDITOR.env.webkit
\r
1360 && rangeRequiresFix( range ) )
\r
1362 // Append a zero-width space so WebKit will not try to
\r
1363 // move the selection by itself (#1272).
\r
1364 var fillingChar = createFillingChar( this.document );
\r
1365 range.insertNode( fillingChar ) ;
\r
1367 var next = fillingChar.getNext();
\r
1369 // If the filling char is followed by a <br>, whithout
\r
1370 // having something before it, it'll not blink.
\r
1371 // Let's remove it in this case.
\r
1372 if ( next && !fillingChar.getPrevious() && next.type == CKEDITOR.NODE_ELEMENT && next.getName() == 'br' )
\r
1374 removeFillingChar( this.document );
\r
1375 range.moveToPosition( next, CKEDITOR.POSITION_BEFORE_START );
\r
1378 range.moveToPosition( fillingChar, CKEDITOR.POSITION_AFTER_END );
\r
1381 nativeRange.setStart( range.startContainer.$, range.startOffset );
\r
1385 nativeRange.setEnd( range.endContainer.$, range.endOffset );
\r
1389 // There is a bug in Firefox implementation (it would be too easy
\r
1390 // otherwise). The new start can't be after the end (W3C says it can).
\r
1391 // So, let's create a new range and collapse it to the desired point.
\r
1392 if ( e.toString().indexOf( 'NS_ERROR_ILLEGAL_VALUE' ) >= 0 )
\r
1394 range.collapse( 1 );
\r
1395 nativeRange.setEnd( range.endContainer.$, range.endOffset );
\r
1401 // Select the range.
\r
1402 sel.addRange( nativeRange );
\r
1410 * Create bookmark for every single of this selection range (from #getRanges)
\r
1411 * by calling the {@link CKEDITOR.dom.range.prototype.createBookmark} method,
\r
1412 * with extra cares to avoid interferon among those ranges. Same arguments are
\r
1413 * received as with the underlay range method.
\r
1415 createBookmarks : function( serializable )
\r
1417 return this.getRanges().createBookmarks( serializable );
\r
1421 * Create bookmark for every single of this selection range (from #getRanges)
\r
1422 * by calling the {@link CKEDITOR.dom.range.prototype.createBookmark2} method,
\r
1423 * with extra cares to avoid interferon among those ranges. Same arguments are
\r
1424 * received as with the underlay range method.
\r
1426 createBookmarks2 : function( normalized )
\r
1428 return this.getRanges().createBookmarks2( normalized );
\r
1432 * Select the virtual ranges denote by the bookmarks by calling #selectRanges.
\r
1433 * @param bookmarks
\r
1435 selectBookmarks : function( bookmarks )
\r
1438 for ( var i = 0 ; i < bookmarks.length ; i++ )
\r
1440 var range = new CKEDITOR.dom.range( this.document );
\r
1441 range.moveToBookmark( bookmarks[i] );
\r
1442 ranges.push( range );
\r
1444 this.selectRanges( ranges );
\r
1449 * Retrieve the common ancestor node of the first range and the last range.
\r
1451 getCommonAncestor : function()
\r
1453 var ranges = this.getRanges(),
\r
1454 startNode = ranges[ 0 ].startContainer,
\r
1455 endNode = ranges[ ranges.length - 1 ].endContainer;
\r
1456 return startNode.getCommonAncestor( endNode );
\r
1460 * Moving scroll bar to the current selection's start position.
\r
1462 scrollIntoView : function()
\r
1464 // If we have split the block, adds a temporary span at the
\r
1465 // range position and scroll relatively to it.
\r
1466 var start = this.getStartElement();
\r
1467 start.scrollIntoView();
\r
1474 var notWhitespaces = CKEDITOR.dom.walker.whitespaces( true ),
\r
1475 fillerTextRegex = /\ufeff|\u00a0/,
\r
1476 nonCells = { table:1,tbody:1,tr:1 };
\r
1478 CKEDITOR.dom.range.prototype.select =
\r
1481 function( forceExpand )
\r
1483 var collapsed = this.collapsed,
\r
1484 isStartMarkerAlone, dummySpan, ieRange;
\r
1486 // Try to make a object selection.
\r
1487 var selected = this.getEnclosedNode();
\r
1492 ieRange = this.document.$.body.createControlRange();
\r
1493 ieRange.addElement( selected.$ );
\r
1500 // IE doesn't support selecting the entire table row/cell, move the selection into cells, e.g.
\r
1501 // <table><tbody><tr>[<td>cell</b></td>... => <table><tbody><tr><td>[cell</td>...
\r
1502 if ( this.startContainer.type == CKEDITOR.NODE_ELEMENT && this.startContainer.getName() in nonCells
\r
1503 || this.endContainer.type == CKEDITOR.NODE_ELEMENT && this.endContainer.getName() in nonCells )
\r
1505 this.shrink( CKEDITOR.NODE_ELEMENT, true );
\r
1508 var bookmark = this.createBookmark();
\r
1510 // Create marker tags for the start and end boundaries.
\r
1511 var startNode = bookmark.startNode;
\r
1515 endNode = bookmark.endNode;
\r
1517 // Create the main range which will be used for the selection.
\r
1518 ieRange = this.document.$.body.createTextRange();
\r
1520 // Position the range at the start boundary.
\r
1521 ieRange.moveToElementText( startNode.$ );
\r
1522 ieRange.moveStart( 'character', 1 );
\r
1526 // Create a tool range for the end.
\r
1527 var ieRangeEnd = this.document.$.body.createTextRange();
\r
1529 // Position the tool range at the end.
\r
1530 ieRangeEnd.moveToElementText( endNode.$ );
\r
1532 // Move the end boundary of the main range to match the tool range.
\r
1533 ieRange.setEndPoint( 'EndToEnd', ieRangeEnd );
\r
1534 ieRange.moveEnd( 'character', -1 );
\r
1538 // The isStartMarkerAlone logic comes from V2. It guarantees that the lines
\r
1539 // will expand and that the cursor will be blinking on the right place.
\r
1540 // Actually, we are using this flag just to avoid using this hack in all
\r
1541 // situations, but just on those needed.
\r
1542 var next = startNode.getNext( notWhitespaces );
\r
1543 isStartMarkerAlone = ( !( next && next.getText && next.getText().match( fillerTextRegex ) ) // already a filler there?
\r
1544 && ( forceExpand || !startNode.hasPrevious() || ( startNode.getPrevious().is && startNode.getPrevious().is( 'br' ) ) ) );
\r
1546 // Append a temporary <span></span> before the selection.
\r
1547 // This is needed to avoid IE destroying selections inside empty
\r
1548 // inline elements, like <b></b> (#253).
\r
1549 // It is also needed when placing the selection right after an inline
\r
1550 // element to avoid the selection moving inside of it.
\r
1551 dummySpan = this.document.createElement( 'span' );
\r
1552 dummySpan.setHtml( '' ); // Zero Width No-Break Space (U+FEFF). See #1359.
\r
1553 dummySpan.insertBefore( startNode );
\r
1555 if ( isStartMarkerAlone )
\r
1557 // To expand empty blocks or line spaces after <br>, we need
\r
1558 // instead to have any char, which will be later deleted using the
\r
1560 // \ufeff = Zero Width No-Break Space (U+FEFF). (#1359)
\r
1561 this.document.createText( '\ufeff' ).insertBefore( startNode );
\r
1565 // Remove the markers (reset the position, because of the changes in the DOM tree).
\r
1566 this.setStartBefore( startNode );
\r
1567 startNode.remove();
\r
1571 if ( isStartMarkerAlone )
\r
1573 // Move the selection start to include the temporary \ufeff.
\r
1574 ieRange.moveStart( 'character', -1 );
\r
1578 // Remove our temporary stuff.
\r
1579 this.document.$.selection.clear();
\r
1584 this.moveToPosition( dummySpan, CKEDITOR.POSITION_BEFORE_START );
\r
1585 dummySpan.remove();
\r
1589 this.setEndBefore( endNode );
\r
1594 this.document.fire( 'selectionchange' );
\r
1599 this.document.getSelection().selectRanges( [ this ] );
\r
Got questions, comments, patches, etc.? Contact Jason Woofenden