2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @file Insert and remove numbered and bulleted lists.
\r
12 var listNodeNames = { ol : 1, ul : 1 },
\r
13 emptyTextRegex = /^[\n\r\t ]*$/;
\r
15 CKEDITOR.plugins.list = {
\r
17 * Convert a DOM list tree into a data structure that is easier to
\r
18 * manipulate. This operation should be non-intrusive in the sense that it
\r
19 * does not change the DOM tree, with the exception that it may add some
\r
20 * markers to the list item nodes when database is specified.
\r
22 listToArray : function( listNode, database, baseArray, baseIndentLevel, grandparentNode )
\r
24 if ( !listNodeNames[ listNode.getName() ] )
\r
27 if ( !baseIndentLevel )
\r
28 baseIndentLevel = 0;
\r
32 // Iterate over all list items to and look for inner lists.
\r
33 for ( var i = 0, count = listNode.getChildCount() ; i < count ; i++ )
\r
35 var listItem = listNode.getChild( i );
\r
37 // It may be a text node or some funny stuff.
\r
38 if ( listItem.$.nodeName.toLowerCase() != 'li' )
\r
41 var itemObj = { 'parent' : listNode, indent : baseIndentLevel, element : listItem, contents : [] };
\r
42 if ( !grandparentNode )
\r
44 itemObj.grandparent = listNode.getParent();
\r
45 if ( itemObj.grandparent && itemObj.grandparent.$.nodeName.toLowerCase() == 'li' )
\r
46 itemObj.grandparent = itemObj.grandparent.getParent();
\r
49 itemObj.grandparent = grandparentNode;
\r
52 CKEDITOR.dom.element.setMarker( database, listItem, 'listarray_index', baseArray.length );
\r
53 baseArray.push( itemObj );
\r
55 for ( var j = 0, itemChildCount = listItem.getChildCount(), child; j < itemChildCount ; j++ )
\r
57 child = listItem.getChild( j );
\r
58 if ( child.type == CKEDITOR.NODE_ELEMENT && listNodeNames[ child.getName() ] )
\r
59 // Note the recursion here, it pushes inner list items with
\r
60 // +1 indentation in the correct order.
\r
61 CKEDITOR.plugins.list.listToArray( child, database, baseArray, baseIndentLevel + 1, itemObj.grandparent );
\r
63 itemObj.contents.push( child );
\r
69 // Convert our internal representation of a list back to a DOM forest.
\r
70 arrayToList : function( listArray, database, baseIndex, paragraphMode )
\r
74 if ( !listArray || listArray.length < baseIndex + 1 )
\r
76 var doc = listArray[ baseIndex ].parent.getDocument(),
\r
77 retval = new CKEDITOR.dom.documentFragment( doc ),
\r
79 currentIndex = baseIndex,
\r
80 indentLevel = Math.max( listArray[ baseIndex ].indent, 0 ),
\r
81 currentListItem = null,
\r
82 paragraphName = ( paragraphMode == CKEDITOR.ENTER_P ? 'p' : 'div' );
\r
85 var item = listArray[ currentIndex ];
\r
86 if ( item.indent == indentLevel )
\r
88 if ( !rootNode || listArray[ currentIndex ].parent.getName() != rootNode.getName() )
\r
90 rootNode = listArray[ currentIndex ].parent.clone( false, true );
\r
91 retval.append( rootNode );
\r
93 currentListItem = rootNode.append( item.element.clone( false, true ) );
\r
94 for ( var i = 0 ; i < item.contents.length ; i++ )
\r
95 currentListItem.append( item.contents[i].clone( true, true ) );
\r
98 else if ( item.indent == Math.max( indentLevel, 0 ) + 1 )
\r
100 var listData = CKEDITOR.plugins.list.arrayToList( listArray, null, currentIndex, paragraphMode );
\r
101 currentListItem.append( listData.listNode );
\r
102 currentIndex = listData.nextIndex;
\r
104 else if ( item.indent == -1 && !baseIndex && item.grandparent )
\r
107 if ( listNodeNames[ item.grandparent.getName() ] )
\r
108 currentListItem = item.element.clone( false, true );
\r
111 // Create completely new blocks here, attributes are dropped.
\r
112 if ( paragraphMode != CKEDITOR.ENTER_BR && item.grandparent.getName() != 'td' )
\r
113 currentListItem = doc.createElement( paragraphName );
\r
115 currentListItem = new CKEDITOR.dom.documentFragment( doc );
\r
118 for ( i = 0 ; i < item.contents.length ; i++ )
\r
119 currentListItem.append( item.contents[i].clone( true, true ) );
\r
121 if ( currentListItem.type == CKEDITOR.NODE_DOCUMENT_FRAGMENT
\r
122 && currentIndex != listArray.length - 1 )
\r
124 if ( currentListItem.getLast()
\r
125 && currentListItem.getLast().type == CKEDITOR.NODE_ELEMENT
\r
126 && currentListItem.getLast().getAttribute( 'type' ) == '_moz' )
\r
127 currentListItem.getLast().remove();
\r
128 currentListItem.appendBogus();
\r
131 if ( currentListItem.type == CKEDITOR.NODE_ELEMENT &&
\r
132 currentListItem.getName() == paragraphName &&
\r
133 currentListItem.$.firstChild )
\r
135 currentListItem.trim();
\r
136 var firstChild = currentListItem.getFirst();
\r
137 if ( firstChild.type == CKEDITOR.NODE_ELEMENT && firstChild.isBlockBoundary() )
\r
139 var tmp = new CKEDITOR.dom.documentFragment( doc );
\r
140 currentListItem.moveChildren( tmp );
\r
141 currentListItem = tmp;
\r
145 var currentListItemName = currentListItem.$.nodeName.toLowerCase();
\r
146 if ( !CKEDITOR.env.ie && ( currentListItemName == 'div' || currentListItemName == 'p' ) )
\r
147 currentListItem.appendBogus();
\r
148 retval.append( currentListItem );
\r
155 if ( listArray.length <= currentIndex || Math.max( listArray[ currentIndex ].indent, 0 ) < indentLevel )
\r
159 // Clear marker attributes for the new list tree made of cloned nodes, if any.
\r
162 var currentNode = retval.getFirst();
\r
163 while ( currentNode )
\r
165 if ( currentNode.type == CKEDITOR.NODE_ELEMENT )
\r
166 CKEDITOR.dom.element.clearMarkers( database, currentNode );
\r
167 currentNode = currentNode.getNextSourceNode();
\r
171 return { listNode : retval, nextIndex : currentIndex };
\r
175 function setState( editor, state )
\r
177 editor.getCommand( this.name ).setState( state );
\r
180 function onSelectionChange( evt )
\r
182 var path = evt.data.path,
\r
183 blockLimit = path.blockLimit,
\r
184 elements = path.elements,
\r
187 // Grouping should only happen under blockLimit.(#3940).
\r
188 for ( var i = 0 ; i < elements.length && ( element = elements[ i ] )
\r
189 && !element.equals( blockLimit ); i++ )
\r
191 if ( listNodeNames[ elements[i].getName() ] )
\r
193 return setState.call( this, evt.editor,
\r
194 this.type == elements[i].getName() ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );
\r
198 return setState.call( this, evt.editor, CKEDITOR.TRISTATE_OFF );
\r
201 function changeListType( editor, groupObj, database, listsCreated )
\r
203 // This case is easy...
\r
204 // 1. Convert the whole list into a one-dimensional array.
\r
205 // 2. Change the list type by modifying the array.
\r
206 // 3. Recreate the whole list by converting the array to a list.
\r
207 // 4. Replace the original list with the recreated list.
\r
208 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),
\r
209 selectedListItems = [];
\r
211 for ( var i = 0 ; i < groupObj.contents.length ; i++ )
\r
213 var itemNode = groupObj.contents[i];
\r
214 itemNode = itemNode.getAscendant( 'li', true );
\r
215 if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )
\r
217 selectedListItems.push( itemNode );
\r
218 CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );
\r
221 var fakeParent = groupObj.root.getDocument().createElement( this.type );
\r
222 for ( i = 0 ; i < selectedListItems.length ; i++ )
\r
224 var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );
\r
225 listArray[listIndex].parent = fakeParent;
\r
227 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );
\r
228 var child, length = newList.listNode.getChildCount();
\r
229 for ( i = 0 ; i < length && ( child = newList.listNode.getChild( i ) ) ; i++ )
\r
231 if ( child.getName() == this.type )
\r
232 listsCreated.push( child );
\r
234 newList.listNode.replace( groupObj.root );
\r
237 var headerTagRegex = /^h[1-6]$/;
\r
239 function createList( editor, groupObj, listsCreated )
\r
241 var contents = groupObj.contents,
\r
242 doc = groupObj.root.getDocument(),
\r
245 // It is possible to have the contents returned by DomRangeIterator to be the same as the root.
\r
246 // e.g. when we're running into table cells.
\r
247 // In such a case, enclose the childNodes of contents[0] into a <div>.
\r
248 if ( contents.length == 1 && contents[0].equals( groupObj.root ) )
\r
250 var divBlock = doc.createElement( 'div' );
\r
251 contents[0].moveChildren && contents[0].moveChildren( divBlock );
\r
252 contents[0].append( divBlock );
\r
253 contents[0] = divBlock;
\r
256 // Calculate the common parent node of all content blocks.
\r
257 var commonParent = groupObj.contents[0].getParent();
\r
258 for ( var i = 0 ; i < contents.length ; i++ )
\r
259 commonParent = commonParent.getCommonAncestor( contents[i].getParent() );
\r
261 // We want to insert things that are in the same tree level only, so calculate the contents again
\r
262 // by expanding the selected blocks to the same tree level.
\r
263 for ( i = 0 ; i < contents.length ; i++ )
\r
265 var contentNode = contents[i],
\r
267 while ( ( parentNode = contentNode.getParent() ) )
\r
269 if ( parentNode.equals( commonParent ) )
\r
271 listContents.push( contentNode );
\r
274 contentNode = parentNode;
\r
278 if ( listContents.length < 1 )
\r
281 // Insert the list to the DOM tree.
\r
282 var insertAnchor = listContents[ listContents.length - 1 ].getNext(),
\r
283 listNode = doc.createElement( this.type );
\r
285 listsCreated.push( listNode );
\r
286 while ( listContents.length )
\r
288 var contentBlock = listContents.shift(),
\r
289 listItem = doc.createElement( 'li' );
\r
291 // Preserve heading structure when converting to list item. (#5271)
\r
292 if ( headerTagRegex.test( contentBlock.getName() ) )
\r
293 contentBlock.appendTo( listItem );
\r
296 contentBlock.copyAttributes( listItem );
\r
297 contentBlock.moveChildren( listItem );
\r
298 contentBlock.remove();
\r
301 listItem.appendTo( listNode );
\r
303 // Append a bogus BR to force the LI to render at full height
\r
304 if ( !CKEDITOR.env.ie )
\r
305 listItem.appendBogus();
\r
307 if ( insertAnchor )
\r
308 listNode.insertBefore( insertAnchor );
\r
310 listNode.appendTo( commonParent );
\r
313 function removeList( editor, groupObj, database )
\r
315 // This is very much like the change list type operation.
\r
316 // Except that we're changing the selected items' indent to -1 in the list array.
\r
317 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),
\r
318 selectedListItems = [];
\r
320 for ( var i = 0 ; i < groupObj.contents.length ; i++ )
\r
322 var itemNode = groupObj.contents[i];
\r
323 itemNode = itemNode.getAscendant( 'li', true );
\r
324 if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )
\r
326 selectedListItems.push( itemNode );
\r
327 CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );
\r
330 var lastListIndex = null;
\r
331 for ( i = 0 ; i < selectedListItems.length ; i++ )
\r
333 var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );
\r
334 listArray[listIndex].indent = -1;
\r
335 lastListIndex = listIndex;
\r
338 // After cutting parts of the list out with indent=-1, we still have to maintain the array list
\r
339 // model's nextItem.indent <= currentItem.indent + 1 invariant. Otherwise the array model of the
\r
340 // list cannot be converted back to a real DOM list.
\r
341 for ( i = lastListIndex + 1 ; i < listArray.length ; i++ )
\r
343 if ( listArray[i].indent > listArray[i-1].indent + 1 )
\r
345 var indentOffset = listArray[i-1].indent + 1 - listArray[i].indent;
\r
346 var oldIndent = listArray[i].indent;
\r
347 while ( listArray[i] && listArray[i].indent >= oldIndent )
\r
349 listArray[i].indent += indentOffset;
\r
356 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );
\r
358 // Compensate <br> before/after the list node if the surrounds are non-blocks.(#3836)
\r
359 var docFragment = newList.listNode, boundaryNode, siblingNode;
\r
360 function compensateBrs( isStart )
\r
362 if ( ( boundaryNode = docFragment[ isStart ? 'getFirst' : 'getLast' ]() )
\r
363 && !( boundaryNode.is && boundaryNode.isBlockBoundary() )
\r
364 && ( siblingNode = groupObj.root[ isStart ? 'getPrevious' : 'getNext' ]
\r
365 ( CKEDITOR.dom.walker.whitespaces( true ) ) )
\r
366 && !( siblingNode.is && siblingNode.isBlockBoundary( { br : 1 } ) ) )
\r
367 editor.document.createElement( 'br' )[ isStart ? 'insertBefore' : 'insertAfter' ]( boundaryNode );
\r
369 compensateBrs( true );
\r
372 docFragment.replace( groupObj.root );
\r
375 function listCommand( name, type )
\r
381 listCommand.prototype = {
\r
382 exec : function( editor )
\r
386 var doc = editor.document,
\r
387 selection = editor.getSelection(),
\r
388 ranges = selection && selection.getRanges();
\r
390 // There should be at least one selected range.
\r
391 if ( !ranges || ranges.length < 1 )
\r
394 // Midas lists rule #1 says we can create a list even in an empty document.
\r
395 // But DOM iterator wouldn't run if the document is really empty.
\r
396 // So create a paragraph if the document is empty and we're going to create a list.
\r
397 if ( this.state == CKEDITOR.TRISTATE_OFF )
\r
399 var body = doc.getBody();
\r
401 if ( !body.getFirst() )
\r
403 var paragraph = doc.createElement( editor.config.enterMode == CKEDITOR.ENTER_P ? 'p' :
\r
404 ( editor.config.enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'br' ) );
\r
405 paragraph.appendTo( body );
\r
406 ranges = [ new CKEDITOR.dom.range( doc ) ];
\r
407 // IE exception on inserting anything when anchor inside <br>.
\r
408 if ( paragraph.is( 'br' ) )
\r
410 ranges[ 0 ].setStartBefore( paragraph );
\r
411 ranges[ 0 ].setEndAfter( paragraph );
\r
414 ranges[ 0 ].selectNodeContents( paragraph );
\r
415 selection.selectRanges( ranges );
\r
417 // Maybe a single range there enclosing the whole list,
\r
418 // turn on the list state manually(#4129).
\r
421 var range = ranges.length == 1 && ranges[ 0 ],
\r
422 enclosedNode = range && range.getEnclosedNode();
\r
423 if ( enclosedNode && enclosedNode.is
\r
424 && this.type == enclosedNode.getName() )
\r
426 setState.call( this, editor, CKEDITOR.TRISTATE_ON );
\r
431 var bookmarks = selection.createBookmarks( true );
\r
433 // Group the blocks up because there are many cases where multiple lists have to be created,
\r
434 // or multiple lists have to be cancelled.
\r
435 var listGroups = [],
\r
438 while ( ranges.length > 0 )
\r
440 range = ranges.shift();
\r
442 var boundaryNodes = range.getBoundaryNodes(),
\r
443 startNode = boundaryNodes.startNode,
\r
444 endNode = boundaryNodes.endNode;
\r
446 if ( startNode.type == CKEDITOR.NODE_ELEMENT && startNode.getName() == 'td' )
\r
447 range.setStartAt( boundaryNodes.startNode, CKEDITOR.POSITION_AFTER_START );
\r
449 if ( endNode.type == CKEDITOR.NODE_ELEMENT && endNode.getName() == 'td' )
\r
450 range.setEndAt( boundaryNodes.endNode, CKEDITOR.POSITION_BEFORE_END );
\r
452 var iterator = range.createIterator(),
\r
455 iterator.forceBrBreak = ( this.state == CKEDITOR.TRISTATE_OFF );
\r
457 while ( ( block = iterator.getNextParagraph() ) )
\r
459 var path = new CKEDITOR.dom.elementPath( block ),
\r
460 pathElements = path.elements,
\r
461 pathElementsCount = pathElements.length,
\r
463 processedFlag = false,
\r
464 blockLimit = path.blockLimit,
\r
467 // First, try to group by a list ancestor.
\r
468 for ( var i = pathElementsCount - 1; i >= 0 && ( element = pathElements[ i ] ); i-- )
\r
470 if ( listNodeNames[ element.getName() ]
\r
471 && blockLimit.contains( element ) ) // Don't leak outside block limit (#3940).
\r
473 // If we've encountered a list inside a block limit
\r
474 // The last group object of the block limit element should
\r
475 // no longer be valid. Since paragraphs after the list
\r
476 // should belong to a different group of paragraphs before
\r
477 // the list. (Bug #1309)
\r
478 blockLimit.removeCustomData( 'list_group_object' );
\r
480 var groupObj = element.getCustomData( 'list_group_object' );
\r
482 groupObj.contents.push( block );
\r
485 groupObj = { root : element, contents : [ block ] };
\r
486 listGroups.push( groupObj );
\r
487 CKEDITOR.dom.element.setMarker( database, element, 'list_group_object', groupObj );
\r
489 processedFlag = true;
\r
494 if ( processedFlag )
\r
497 // No list ancestor? Group by block limit.
\r
498 var root = blockLimit;
\r
499 if ( root.getCustomData( 'list_group_object' ) )
\r
500 root.getCustomData( 'list_group_object' ).contents.push( block );
\r
503 groupObj = { root : root, contents : [ block ] };
\r
504 CKEDITOR.dom.element.setMarker( database, root, 'list_group_object', groupObj );
\r
505 listGroups.push( groupObj );
\r
510 // Now we have two kinds of list groups, groups rooted at a list, and groups rooted at a block limit element.
\r
511 // We either have to build lists or remove lists, for removing a list does not makes sense when we are looking
\r
512 // at the group that's not rooted at lists. So we have three cases to handle.
\r
513 var listsCreated = [];
\r
514 while ( listGroups.length > 0 )
\r
516 groupObj = listGroups.shift();
\r
517 if ( this.state == CKEDITOR.TRISTATE_OFF )
\r
519 if ( listNodeNames[ groupObj.root.getName() ] )
\r
520 changeListType.call( this, editor, groupObj, database, listsCreated );
\r
522 createList.call( this, editor, groupObj, listsCreated );
\r
524 else if ( this.state == CKEDITOR.TRISTATE_ON && listNodeNames[ groupObj.root.getName() ] )
\r
525 removeList.call( this, editor, groupObj, database );
\r
528 // For all new lists created, merge adjacent, same type lists.
\r
529 for ( i = 0 ; i < listsCreated.length ; i++ )
\r
531 listNode = listsCreated[i];
\r
532 var mergeSibling, listCommand = this;
\r
533 ( mergeSibling = function( rtl ){
\r
535 var sibling = listNode[ rtl ?
\r
536 'getPrevious' : 'getNext' ]( CKEDITOR.dom.walker.whitespaces( true ) );
\r
537 if ( sibling && sibling.getName &&
\r
538 sibling.getName() == listCommand.type )
\r
541 // Move children order by merge direction.(#3820)
\r
542 sibling.moveChildren( listNode, rtl ? true : false );
\r
545 mergeSibling( true );
\r
548 // Clean up, restore selection and update toolbar button states.
\r
549 CKEDITOR.dom.element.clearAllMarkers( database );
\r
550 selection.selectBookmarks( bookmarks );
\r
555 var dtd = CKEDITOR.dtd;
\r
556 var tailNbspRegex = /[\t\r\n ]*(?: |\xa0)$/;
\r
558 function indexOfFirstChildElement( element, tagNameList )
\r
561 children = element.children,
\r
562 length = children.length;
\r
564 for ( var i = 0 ; i < length ; i++ )
\r
566 child = children[ i ];
\r
567 if ( child.name && ( child.name in tagNameList ) )
\r
574 function getExtendNestedListFilter( isHtmlFilter )
\r
576 // An element filter function that corrects nested list start in an empty
\r
577 // list item for better displaying/outputting. (#3165)
\r
578 return function( listItem )
\r
580 var children = listItem.children,
\r
581 firstNestedListIndex = indexOfFirstChildElement( listItem, dtd.$list ),
\r
582 firstNestedList = children[ firstNestedListIndex ],
\r
583 nodeBefore = firstNestedList && firstNestedList.previous,
\r
587 && ( nodeBefore.name && nodeBefore.name == 'br'
\r
588 || nodeBefore.value && ( tailNbspmatch = nodeBefore.value.match( tailNbspRegex ) ) ) )
\r
590 var fillerNode = nodeBefore;
\r
592 // Always use 'nbsp' as filler node if we found a nested list appear
\r
593 // in front of a list item.
\r
594 if ( !( tailNbspmatch && tailNbspmatch.index ) && fillerNode == children[ 0 ] )
\r
595 children[ 0 ] = ( isHtmlFilter || CKEDITOR.env.ie ) ?
\r
596 new CKEDITOR.htmlParser.text( '\xa0' ) :
\r
597 new CKEDITOR.htmlParser.element( 'br', {} );
\r
599 // Otherwise the filler is not needed anymore.
\r
600 else if ( fillerNode.name == 'br' )
\r
601 children.splice( firstNestedListIndex - 1, 1 );
\r
603 fillerNode.value = fillerNode.value.replace( tailNbspRegex, '' );
\r
609 var defaultListDataFilterRules = { elements : {} };
\r
610 for ( var i in dtd.$listItem )
\r
611 defaultListDataFilterRules.elements[ i ] = getExtendNestedListFilter();
\r
613 var defaultListHtmlFilterRules = { elements : {} };
\r
614 for ( i in dtd.$listItem )
\r
615 defaultListHtmlFilterRules.elements[ i ] = getExtendNestedListFilter( true );
\r
617 CKEDITOR.plugins.add( 'list',
\r
619 init : function( editor )
\r
621 // Register commands.
\r
622 var numberedListCommand = new listCommand( 'numberedlist', 'ol' ),
\r
623 bulletedListCommand = new listCommand( 'bulletedlist', 'ul' );
\r
624 editor.addCommand( 'numberedlist', numberedListCommand );
\r
625 editor.addCommand( 'bulletedlist', bulletedListCommand );
\r
627 // Register the toolbar button.
\r
628 editor.ui.addButton( 'NumberedList',
\r
630 label : editor.lang.numberedlist,
\r
631 command : 'numberedlist'
\r
633 editor.ui.addButton( 'BulletedList',
\r
635 label : editor.lang.bulletedlist,
\r
636 command : 'bulletedlist'
\r
639 // Register the state changing handlers.
\r
640 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, numberedListCommand ) );
\r
641 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, bulletedListCommand ) );
\r
644 afterInit : function ( editor )
\r
646 var dataProcessor = editor.dataProcessor;
\r
647 if ( dataProcessor )
\r
649 dataProcessor.dataFilter.addRules( defaultListDataFilterRules );
\r
650 dataProcessor.htmlFilter.addRules( defaultListHtmlFilterRules );
\r
654 requires : [ 'domiterator' ]
\r