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