2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
9 * Represents a list os CKEDITOR.dom.range objects, which can be easily
\r
10 * iterated sequentially.
\r
12 * @param {CKEDITOR.dom.range|Array} [ranges] The ranges contained on this list.
\r
13 * Note that, if an array of ranges is specified, the range sequence
\r
14 * should match its DOM order. This class will not help to sort them.
\r
16 CKEDITOR.dom.rangeList = function( ranges )
\r
18 if ( ranges instanceof CKEDITOR.dom.rangeList )
\r
23 else if ( ranges instanceof CKEDITOR.dom.range )
\r
24 ranges = [ ranges ];
\r
26 return CKEDITOR.tools.extend( ranges, mixins );
\r
30 /** @lends CKEDITOR.dom.rangeList.prototype */
\r
33 * Creates an instance of the rangeList iterator, it should be used
\r
34 * only when the ranges processing could be DOM intrusive, which
\r
35 * means it may pollute and break other ranges in this list.
\r
36 * Otherwise, it's enough to just iterate over this array in a for loop.
\r
37 * @returns {CKEDITOR.dom.rangeListIterator}
\r
39 createIterator : function()
\r
41 var rangeList = this,
\r
42 bookmark = CKEDITOR.dom.walker.bookmark(),
\r
43 guard = function( node ) { return ! ( node.is && node.is( 'tr' ) ); },
\r
48 * @lends CKEDITOR.dom.rangeListIterator.prototype
\r
53 * Retrieves the next range in the list.
\r
54 * @param {Boolean} mergeConsequent Whether join two adjacent ranges into single, e.g. consequent table cells.
\r
56 getNextRange : function( mergeConsequent )
\r
58 current = current == undefined ? 0 : current + 1;
\r
60 var range = rangeList[ current ];
\r
62 // Multiple ranges might be mangled by each other.
\r
63 if ( range && rangeList.length > 1 )
\r
65 // Bookmarking all other ranges on the first iteration,
\r
66 // the range correctness after it doesn't matter since we'll
\r
67 // restore them before the next iteration.
\r
70 // Make sure bookmark correctness by reverse processing.
\r
71 for ( var i = rangeList.length - 1; i >= 0; i-- )
\r
72 bookmarks.unshift( rangeList[ i ].createBookmark( true ) );
\r
75 if ( mergeConsequent )
\r
77 // Figure out how many ranges should be merged.
\r
79 while ( rangeList[ current + mergeCount + 1 ] )
\r
81 var doc = range.document,
\r
83 left = doc.getById( bookmarks[ mergeCount ].endNode ),
\r
84 right = doc.getById( bookmarks[ mergeCount + 1 ].startNode ),
\r
87 // Check subsequent range.
\r
90 next = left.getNextSourceNode( false );
\r
91 if ( !right.equals( next ) )
\r
93 // This could be yet another bookmark or
\r
94 // walking across block boundaries.
\r
95 if ( bookmark( next ) || ( next.type == CKEDITOR.NODE_ELEMENT && next.isBlockBoundary() ) )
\r
114 range.moveToBookmark( bookmarks.shift() );
\r
116 // Merge ranges finally after moving to bookmarks.
\r
117 while( mergeCount-- )
\r
119 next = rangeList[ ++current ];
\r
120 next.moveToBookmark( bookmarks.shift() );
\r
121 range.setEnd( next.endContainer, next.endOffset );
\r
130 createBookmarks : function( serializable )
\r
132 var retval = [], bookmark;
\r
133 for ( var i = 0; i < this.length ; i++ )
\r
135 retval.push( bookmark = this[ i ].createBookmark( serializable, true) );
\r
137 // Updating the container & offset values for ranges
\r
138 // that have been touched.
\r
139 for ( var j = i + 1; j < this.length; j++ )
\r
141 this[ j ] = updateDirtyRange( bookmark, this[ j ] );
\r
142 this[ j ] = updateDirtyRange( bookmark, this[ j ], true );
\r
148 createBookmarks2 : function( normalized )
\r
150 var bookmarks = [];
\r
152 for ( var i = 0 ; i < this.length ; i++ )
\r
153 bookmarks.push( this[ i ].createBookmark2( normalized ) );
\r
159 * Move each range in the list to the position specified by a list of bookmarks.
\r
160 * @param {Array} bookmarks The list of bookmarks, each one matching a range in the list.
\r
162 moveToBookmarks : function( bookmarks )
\r
164 for ( var i = 0 ; i < this.length ; i++ )
\r
165 this[ i ].moveToBookmark( bookmarks[ i ] );
\r
169 // Update the specified range which has been mangled by previous insertion of
\r
170 // range bookmark nodes.(#3256)
\r
171 function updateDirtyRange( bookmark, dirtyRange, checkEnd )
\r
173 var serializable = bookmark.serializable,
\r
174 container = dirtyRange[ checkEnd ? 'endContainer' : 'startContainer' ],
\r
175 offset = checkEnd ? 'endOffset' : 'startOffset';
\r
177 var bookmarkStart = serializable ?
\r
178 dirtyRange.document.getById( bookmark.startNode )
\r
179 : bookmark.startNode;
\r
181 var bookmarkEnd = serializable ?
\r
182 dirtyRange.document.getById( bookmark.endNode )
\r
183 : bookmark.endNode;
\r
185 if ( container.equals( bookmarkStart.getPrevious() ) )
\r
187 dirtyRange.startOffset = dirtyRange.startOffset
\r
188 - container.getLength()
\r
189 - bookmarkEnd.getPrevious().getLength();
\r
190 container = bookmarkEnd.getNext();
\r
192 else if ( container.equals( bookmarkEnd.getPrevious() ) )
\r
194 dirtyRange.startOffset = dirtyRange.startOffset - container.getLength();
\r
195 container = bookmarkEnd.getNext();
\r
198 container.equals( bookmarkStart.getParent() ) && dirtyRange[ offset ]++;
\r
199 container.equals( bookmarkEnd.getParent() ) && dirtyRange[ offset ]++;
\r
201 // Update and return this range.
\r
202 dirtyRange[ checkEnd ? 'endContainer' : 'startContainer' ] = container;
\r
208 * (Virtual Class) Do not call this constructor. This class is not really part
\r
209 * of the API. It just describes the return type of {@link CKEDITOR.dom.rangeList#createIterator}.
\r
210 * @name CKEDITOR.dom.rangeListIterator
\r