\r
doc.on( 'mouseup', checkSelectionChangeTimeout, editor );\r
doc.on( 'keyup', checkSelectionChangeTimeout, editor );\r
+ doc.on( 'selectionchange', checkSelectionChangeTimeout, editor );\r
}\r
});\r
\r
\r
/**\r
* Gets the current selection from the editing area when in WYSIWYG mode.\r
- * @returns {CKEDITOR.dom.selection} A selection object or null if not on\r
+ * @returns {CKEDITOR.dom.selection} A selection object or null if not in\r
* WYSIWYG mode or no selection is available.\r
* @example\r
- * var selection = CKEDITOR.instances.editor1.<b>getSelection()</b>;\r
+ * var selection = CKEDITOR.instances.editor1.<strong>getSelection()</strong>;\r
* alert( selection.getType() );\r
*/\r
CKEDITOR.editor.prototype.getSelection = function()\r
* Gets the current selection from the document.\r
* @returns {CKEDITOR.dom.selection} A selection object.\r
* @example\r
- * var selection = CKEDITOR.instances.editor1.document.<b>getSelection()</b>;\r
+ * var selection = CKEDITOR.instances.editor1.document.<strong>getSelection()</strong>;\r
* alert( selection.getType() );\r
*/\r
CKEDITOR.dom.document.prototype.getSelection = function()\r
CKEDITOR.SELECTION_NONE = 1;\r
\r
/**\r
- * Text or collapsed selection.\r
+ * A text or a collapsed selection.\r
* @constant\r
* @example\r
* if ( editor.getSelection().getType() == CKEDITOR.SELECTION_TEXT )\r
- * alert( 'Text is selected' );\r
+ * alert( 'A text is selected' );\r
*/\r
CKEDITOR.SELECTION_TEXT = 2;\r
\r
/**\r
* Manipulates the selection in a DOM document.\r
* @constructor\r
+ * @param {CKEDITOR.dom.document} document The DOM document that contains the selection.\r
* @example\r
+ * var sel = new <strong>CKEDITOR.dom.selection( CKEDITOR.document )</strong>;\r
*/\r
CKEDITOR.dom.selection = function( document )\r
{\r
\r
/**\r
* IE BUG: The selection's document may be a different document than the\r
- * editor document. Return null if that's the case.\r
+ * editor document. Return null if that is the case.\r
*/\r
if ( CKEDITOR.env.ie )\r
{\r
/**\r
* Gets the native selection object from the browser.\r
* @function\r
- * @returns {Object} The native selection object.\r
+ * @returns {Object} The native browser selection object.\r
* @example\r
- * var selection = editor.getSelection().<b>getNative()</b>;\r
+ * var selection = editor.getSelection().<strong>getNative()</strong>;\r
*/\r
getNative :\r
CKEDITOR.env.ie ?\r
* Gets the type of the current selection. The following values are\r
* available:\r
* <ul>\r
- * <li>{@link CKEDITOR.SELECTION_NONE} (1): No selection.</li>\r
- * <li>{@link CKEDITOR.SELECTION_TEXT} (2): Text is selected or\r
- * collapsed selection.</li>\r
- * <li>{@link CKEDITOR.SELECTION_ELEMENT} (3): A element\r
- * selection.</li>\r
+ * <li><code>{@link CKEDITOR.SELECTION_NONE}</code> (1): No selection.</li>\r
+ * <li><code>{@link CKEDITOR.SELECTION_TEXT}</code> (2): A text or a collapsed\r
+ * selection is selected.</li>\r
+ * <li><code>{@link CKEDITOR.SELECTION_ELEMENT}</code> (3): An element is\r
+ * selected.</li>\r
* </ul>\r
* @function\r
* @returns {Number} One of the following constant values:\r
- * {@link CKEDITOR.SELECTION_NONE}, {@link CKEDITOR.SELECTION_TEXT} or\r
- * {@link CKEDITOR.SELECTION_ELEMENT}.\r
+ * <code>{@link CKEDITOR.SELECTION_NONE}</code>, <code>{@link CKEDITOR.SELECTION_TEXT}</code>, or\r
+ * <code>{@link CKEDITOR.SELECTION_ELEMENT}</code>.\r
* @example\r
- * if ( editor.getSelection().<b>getType()</b> == CKEDITOR.SELECTION_TEXT )\r
- * alert( 'Text is selected' );\r
+ * if ( editor.getSelection().<strong>getType()</strong> == CKEDITOR.SELECTION_TEXT )\r
+ * alert( 'A text is selected' );\r
*/\r
getType :\r
CKEDITOR.env.ie ?\r
},\r
\r
/**\r
- * Retrieve the {@link CKEDITOR.dom.range} instances that represent the current selection.\r
- * Note: Some browsers returns multiple ranges even on a sequent selection, e.g. Firefox returns\r
- * one range for each table cell when one or more table row is selected.\r
- * @return {Array}\r
+ * Retrieves the <code>{@link CKEDITOR.dom.range}</code> instances that represent the current selection.\r
+ * Note: Some browsers return multiple ranges even for a continuous selection. Firefox, for example, returns\r
+ * one range for each table cell when one or more table rows are selected.\r
+ * @function\r
+ * @param {Boolean} [onlyEditables] If set to <code>true</code>, this function retrives editable ranges only.\r
+ * @return {Array} Range instances that represent the current selection.\r
* @example\r
- * var ranges = selection.getRanges();\r
- * alert(ranges.length);\r
+ * var ranges = selection.<strong>getRanges()</strong>;\r
+ * alert( ranges.length );\r
*/\r
getRanges : (function()\r
{\r
if ( range.collapsed )\r
continue;\r
\r
+ // Range may start inside a non-editable element,\r
+ // replace the range start after it.\r
+ if ( range.startContainer.isReadOnly() )\r
+ {\r
+ var current = range.startContainer;\r
+ while( current )\r
+ {\r
+ if ( current.is( 'body' ) || !current.isReadOnly() )\r
+ break;\r
+\r
+ if ( current.type == CKEDITOR.NODE_ELEMENT\r
+ && current.getAttribute( 'contentEditable' ) == 'false' )\r
+ range.setStartAfter( current );\r
+\r
+ current = current.getParent();\r
+ }\r
+ }\r
+\r
var startContainer = range.startContainer,\r
endContainer = range.endContainer,\r
startOffset = range.startOffset,\r
endOffset = range.endOffset,\r
walkerRange = range.clone();\r
\r
- // Range may start inside a non-editable element, restart range\r
- // by the end of it.\r
- var readOnly;\r
- if ( ( readOnly = startContainer.isReadOnly() ) )\r
- range.setStartAfter( readOnly );\r
-\r
// Enlarge range start/end with text node to avoid walker\r
// being DOM destructive, it doesn't interfere our checking\r
// of elements below as well.\r
* @returns {CKEDITOR.dom.element} The element at the beginning of the\r
* selection.\r
* @example\r
- * var element = editor.getSelection().<b>getStartElement()</b>;\r
+ * var element = editor.getSelection().<strong>getStartElement()</strong>;\r
* alert( element.getName() );\r
*/\r
getStartElement : function()\r
},\r
\r
/**\r
- * Gets the current selected element.\r
+ * Gets the currently selected element.\r
* @returns {CKEDITOR.dom.element} The selected element. Null if no\r
* selection is available or the selection type is not\r
- * {@link CKEDITOR.SELECTION_ELEMENT}.\r
+ * <code>{@link CKEDITOR.SELECTION_ELEMENT}</code>.\r
* @example\r
- * var element = editor.getSelection().<b>getSelectedElement()</b>;\r
+ * var element = editor.getSelection().<strong>getSelectedElement()</strong>;\r
* alert( element.getName() );\r
*/\r
getSelectedElement : function()\r
{\r
return self.getNative().createRange().item( 0 );\r
},\r
+ // If a table or list is fully selected.\r
+ function()\r
+ {\r
+ var root,\r
+ retval,\r
+ range = self.getRanges()[ 0 ],\r
+ ancestor = range.getCommonAncestor( 1, 1 ),\r
+ tags = { table:1,ul:1,ol:1,dl:1 };\r
+\r
+ for ( var t in tags )\r
+ {\r
+ if ( root = ancestor.getAscendant( t, 1 ) )\r
+ break;\r
+ }\r
+\r
+ if ( root )\r
+ {\r
+ // Enlarging the start boundary.\r
+ var testRange = new CKEDITOR.dom.range( this.document );\r
+ testRange.setStartAt( root, CKEDITOR.POSITION_AFTER_START );\r
+ testRange.setEnd( range.startContainer, range.startOffset );\r
+\r
+ var enlargeables = CKEDITOR.tools.extend( tags, CKEDITOR.dtd.$listItem, CKEDITOR.dtd.$tableContent ),\r
+ walker = new CKEDITOR.dom.walker( testRange ),\r
+ // Check the range is at the inner boundary of the structural element.\r
+ guard = function( walker, isEnd )\r
+ {\r
+ return function( node, isWalkOut )\r
+ {\r
+ if ( node.type == CKEDITOR.NODE_TEXT && ( !CKEDITOR.tools.trim( node.getText() ) || node.getParent().data( 'cke-bookmark' ) ) )\r
+ return true;\r
+\r
+ var tag;\r
+ if ( node.type == CKEDITOR.NODE_ELEMENT )\r
+ {\r
+ tag = node.getName();\r
+\r
+ // Bypass bogus br at the end of block.\r
+ if ( tag == 'br' && isEnd && node.equals( node.getParent().getBogus() ) )\r
+ return true;\r
+\r
+ if ( isWalkOut && tag in enlargeables || tag in CKEDITOR.dtd.$removeEmpty )\r
+ return true;\r
+ }\r
+\r
+ walker.halted = 1;\r
+ return false;\r
+ };\r
+ };\r
+\r
+ walker.guard = guard( walker );\r
+\r
+ if ( walker.checkBackward() && !walker.halted )\r
+ {\r
+ walker = new CKEDITOR.dom.walker( testRange );\r
+ testRange.setStart( range.endContainer, range.endOffset );\r
+ testRange.setEndAt( root, CKEDITOR.POSITION_BEFORE_END );\r
+ walker.guard = guard( walker, 1 );\r
+ if ( walker.checkForward() && !walker.halted )\r
+ retval = root.$;\r
+ }\r
+ }\r
+\r
+ if ( !retval )\r
+ throw 0;\r
+\r
+ return retval;\r
+ },\r
// Figure it out by checking if there's a single enclosed\r
// node of the range.\r
function()\r
},\r
\r
/**\r
- * Retrieves the text contained within the range, empty string is returned for non-text selection.\r
- * @returns {String} string of text within the current selection.\r
+ * Retrieves the text contained within the range. An empty string is returned for non-text selection.\r
+ * @returns {String} A string of text within the current selection.\r
* @since 3.6.1\r
* @example\r
- * var text = editor.getSelectedText();\r
+ * var text = editor.getSelection().<strong>getSelectedText()</strong>;\r
* alert( text );\r
*/\r
getSelectedText : function()\r
return ( cache.selectedText = text );\r
},\r
\r
+ /**\r
+ * Locks the selection made in the editor in order to make it possible to\r
+ * manipulate it without browser interference. A locked selection is\r
+ * cached and remains unchanged until it is released with the <code>#unlock</code>\r
+ * method.\r
+ * @example\r
+ * editor.getSelection().<strong>lock()</strong>;\r
+ */\r
lock : function()\r
{\r
// Call all cacheable function.\r
this.document.setCustomData( 'cke_locked_selection', this );\r
},\r
\r
+ /**\r
+ * Unlocks the selection made in the editor and locked with the <code>#lock</code> method.\r
+ * An unlocked selection is no longer cached and can be changed.\r
+ * @param {Boolean} [restore] If set to <code>true</code>, the selection is restored back to the selection saved earlier by using the <code>#lock</code> method.\r
+ * @example\r
+ * editor.getSelection().<strong>unlock()</strong>;\r
+ */\r
unlock : function( restore )\r
{\r
var doc = this.document,\r
}\r
},\r
\r
+ /**\r
+ * Clears the selection cache.\r
+ * @example\r
+ * editor.getSelection().<strong>reset()</strong>;\r
+ */\r
reset : function()\r
{\r
this._.cache = {};\r
},\r
\r
/**\r
- * Make the current selection of type {@link CKEDITOR.SELECTION_ELEMENT} by enclosing the specified element.\r
- * @param element\r
+ * Makes the current selection of type <code>{@link CKEDITOR.SELECTION_ELEMENT}</code> by enclosing the specified element.\r
+ * @param {CKEDITOR.dom.element} element The element to enclose in the selection.\r
+ * @example\r
+ * var element = editor.document.getById( 'sampleElement' );\r
+ * editor.getSelection.<strong>selectElement( element )</strong>;\r
*/\r
selectElement : function( element )\r
{\r
},\r
\r
/**\r
- * Adding the specified ranges to document selection preceding\r
- * by clearing up the original selection.\r
- * @param {CKEDITOR.dom.range} ranges\r
+ * Clears the original selection and adds the specified ranges\r
+ * to the document selection.\r
+ * @param {Array} ranges An array of <code>{@link CKEDITOR.dom.range}</code> instances representing ranges to be added to the document.\r
+ * @example\r
+ * var ranges = new CKEDITOR.dom.range( editor.document );\r
+ * editor.getSelection().<strong>selectRanges( [ ranges ] )</strong>;\r
*/\r
selectRanges : function( ranges )\r
{\r
sel.addRange( nativeRange );\r
}\r
\r
+ // Don't miss selection change event for non-IEs.\r
+ this.document.fire( 'selectionchange' );\r
this.reset();\r
}\r
},\r
\r
/**\r
- * Create bookmark for every single of this selection range (from #getRanges)\r
- * by calling the {@link CKEDITOR.dom.range.prototype.createBookmark} method,\r
- * with extra cares to avoid interferon among those ranges. Same arguments are\r
- * received as with the underlay range method.\r
+ * Creates a bookmark for each range of this selection (from <code>#getRanges</code>)\r
+ * by calling the <code>{@link CKEDITOR.dom.range.prototype.createBookmark}</code> method,\r
+ * with extra care taken to avoid interference among those ranges. The arguments\r
+ * received are the same as with the underlying range method.\r
+ * @returns {Array} Array of bookmarks for each range.\r
+ * @example\r
+ * var bookmarks = editor.getSelection().<strong>createBookmarks()</strong>;\r
*/\r
createBookmarks : function( serializable )\r
{\r
},\r
\r
/**\r
- * Create bookmark for every single of this selection range (from #getRanges)\r
- * by calling the {@link CKEDITOR.dom.range.prototype.createBookmark2} method,\r
- * with extra cares to avoid interferon among those ranges. Same arguments are\r
- * received as with the underlay range method.\r
+ * Creates a bookmark for each range of this selection (from <code>#getRanges</code>)\r
+ * by calling the <code>{@link CKEDITOR.dom.range.prototype.createBookmark2}</code> method,\r
+ * with extra care taken to avoid interference among those ranges. The arguments\r
+ * received are the same as with the underlying range method.\r
+ * @returns {Array} Array of bookmarks for each range.\r
+ * @example\r
+ * var bookmarks = editor.getSelection().<strong>createBookmarks2()</strong>;\r
*/\r
createBookmarks2 : function( normalized )\r
{\r
},\r
\r
/**\r
- * Select the virtual ranges denote by the bookmarks by calling #selectRanges.\r
- * @param bookmarks\r
+ * Selects the virtual ranges denoted by the bookmarks by calling <code>#selectRanges</code>.\r
+ * @param {Array} bookmarks The bookmarks representing ranges to be selected.\r
+ * @returns {CKEDITOR.dom.selection} This selection object, after the ranges were selected.\r
+ * @example\r
+ * var bookmarks = editor.getSelection().createBookmarks();\r
+ * editor.getSelection().<strong>selectBookmarks( bookmarks )</strong>;\r
*/\r
selectBookmarks : function( bookmarks )\r
{\r
},\r
\r
/**\r
- * Retrieve the common ancestor node of the first range and the last range.\r
+ * Retrieves the common ancestor node of the first range and the last range.\r
+ * @returns {CKEDITOR.dom.element} The common ancestor of the selection.\r
+ * @example\r
+ * var ancestor = editor.getSelection().<strong>getCommonAncestor()</strong>;\r
*/\r
getCommonAncestor : function()\r
{\r
},\r
\r
/**\r
- * Moving scroll bar to the current selection's start position.\r
+ * Moves the scrollbar to the starting position of the current selection.\r
+ * @example\r
+ * editor.getSelection().<strong>scrollIntoView()</strong>;\r
*/\r
scrollIntoView : function()\r
{\r
Got questions, comments, patches, etc.? Contact Jason Woofenden