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 get their contents 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
40 var itemObj = { 'parent' : listNode, indent : baseIndentLevel, contents : [] };
\r
41 if ( !grandparentNode )
\r
43 itemObj.grandparent = listNode.getParent();
\r
44 if ( itemObj.grandparent && itemObj.grandparent.$.nodeName.toLowerCase() == 'li' )
\r
45 itemObj.grandparent = itemObj.grandparent.getParent();
\r
48 itemObj.grandparent = grandparentNode;
\r
51 CKEDITOR.dom.element.setMarker( database, listItem, 'listarray_index', baseArray.length );
\r
52 baseArray.push( itemObj );
\r
54 for ( var j = 0, itemChildCount = listItem.getChildCount() ; j < itemChildCount ; j++ )
\r
56 var child = listItem.getChild( j );
\r
57 if ( child.type == CKEDITOR.NODE_ELEMENT && listNodeNames[ child.getName() ] )
\r
58 // Note the recursion here, it pushes inner list items with
\r
59 // +1 indentation in the correct order.
\r
60 CKEDITOR.plugins.list.listToArray( child, database, baseArray, baseIndentLevel + 1, itemObj.grandparent );
\r
62 itemObj.contents.push( child );
\r
68 // Convert our internal representation of a list back to a DOM forest.
\r
69 arrayToList : function( listArray, database, baseIndex, paragraphMode )
\r
73 if ( !listArray || listArray.length < baseIndex + 1 )
\r
75 var doc = listArray[ baseIndex ].parent.getDocument(),
\r
76 retval = new CKEDITOR.dom.documentFragment( doc ),
\r
78 currentIndex = baseIndex,
\r
79 indentLevel = Math.max( listArray[ baseIndex ].indent, 0 ),
\r
80 currentListItem = null,
\r
81 paragraphName = ( paragraphMode == CKEDITOR.ENTER_P ? 'p' : 'div' );
\r
84 var item = listArray[ currentIndex ];
\r
85 if ( item.indent == indentLevel )
\r
87 if ( !rootNode || listArray[ currentIndex ].parent.getName() != rootNode.getName() )
\r
89 rootNode = listArray[ currentIndex ].parent.clone( false, true );
\r
90 retval.append( rootNode );
\r
92 currentListItem = rootNode.append( doc.createElement( 'li' ) );
\r
93 for ( var i = 0 ; i < item.contents.length ; i++ )
\r
94 currentListItem.append( item.contents[i].clone( true, true ) );
\r
97 else if ( item.indent == Math.max( indentLevel, 0 ) + 1 )
\r
99 var listData = CKEDITOR.plugins.list.arrayToList( listArray, null, currentIndex, paragraphMode );
\r
100 currentListItem.append( listData.listNode );
\r
101 currentIndex = listData.nextIndex;
\r
103 else if ( item.indent == -1 && !baseIndex && item.grandparent )
\r
106 if ( listNodeNames[ item.grandparent.getName() ] )
\r
107 currentListItem = doc.createElement( 'li' );
\r
110 if ( paragraphMode != CKEDITOR.ENTER_BR && item.grandparent.getName() != 'td' )
\r
111 currentListItem = doc.createElement( paragraphName );
\r
113 currentListItem = new CKEDITOR.dom.documentFragment( doc );
\r
116 for ( i = 0 ; i < item.contents.length ; i++ )
\r
117 currentListItem.append( item.contents[i].clone( true, true ) );
\r
119 if ( currentListItem.type == CKEDITOR.NODE_DOCUMENT_FRAGMENT
\r
120 && currentIndex != listArray.length - 1 )
\r
122 if ( currentListItem.getLast()
\r
123 && currentListItem.getLast().type == CKEDITOR.NODE_ELEMENT
\r
124 && currentListItem.getLast().getAttribute( 'type' ) == '_moz' )
\r
125 currentListItem.getLast().remove();
\r
126 currentListItem.appendBogus();
\r
129 if ( currentListItem.type == CKEDITOR.NODE_ELEMENT &&
\r
130 currentListItem.getName() == paragraphName &&
\r
131 currentListItem.$.firstChild )
\r
133 currentListItem.trim();
\r
134 var firstChild = currentListItem.getFirst();
\r
135 if ( firstChild.type == CKEDITOR.NODE_ELEMENT && firstChild.isBlockBoundary() )
\r
137 var tmp = new CKEDITOR.dom.documentFragment( doc );
\r
138 currentListItem.moveChildren( tmp );
\r
139 currentListItem = tmp;
\r
143 var currentListItemName = currentListItem.$.nodeName.toLowerCase();
\r
144 if ( !CKEDITOR.env.ie && ( currentListItemName == 'div' || currentListItemName == 'p' ) )
\r
145 currentListItem.appendBogus();
\r
146 retval.append( currentListItem );
\r
153 if ( listArray.length <= currentIndex || Math.max( listArray[ currentIndex ].indent, 0 ) < indentLevel )
\r
157 // Clear marker attributes for the new list tree made of cloned nodes, if any.
\r
160 var currentNode = retval.getFirst();
\r
161 while ( currentNode )
\r
163 if ( currentNode.type == CKEDITOR.NODE_ELEMENT )
\r
164 CKEDITOR.dom.element.clearMarkers( database, currentNode );
\r
165 currentNode = currentNode.getNextSourceNode();
\r
169 return { listNode : retval, nextIndex : currentIndex };
\r
173 function setState( editor, state )
\r
175 editor.getCommand( this.name ).setState( state );
\r
178 function onSelectionChange( evt )
\r
180 var path = evt.data.path,
\r
181 blockLimit = path.blockLimit,
\r
182 elements = path.elements,
\r
185 // Grouping should only happen under blockLimit.(#3940).
\r
186 for ( var i = 0 ; i < elements.length && ( element = elements[ i ] )
\r
187 && !element.equals( blockLimit ); i++ )
\r
189 if ( listNodeNames[ elements[i].getName() ] )
\r
191 return setState.call( this, evt.editor,
\r
192 this.type == elements[i].getName() ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );
\r
196 return setState.call( this, evt.editor, CKEDITOR.TRISTATE_OFF );
\r
199 function changeListType( editor, groupObj, database, listsCreated )
\r
201 // This case is easy...
\r
202 // 1. Convert the whole list into a one-dimensional array.
\r
203 // 2. Change the list type by modifying the array.
\r
204 // 3. Recreate the whole list by converting the array to a list.
\r
205 // 4. Replace the original list with the recreated list.
\r
206 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),
\r
207 selectedListItems = [];
\r
209 for ( var i = 0 ; i < groupObj.contents.length ; i++ )
\r
211 var itemNode = groupObj.contents[i];
\r
212 itemNode = itemNode.getAscendant( 'li', true );
\r
213 if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )
\r
215 selectedListItems.push( itemNode );
\r
216 CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );
\r
219 var fakeParent = groupObj.root.getDocument().createElement( this.type );
\r
220 for ( i = 0 ; i < selectedListItems.length ; i++ )
\r
222 var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );
\r
223 listArray[listIndex].parent = fakeParent;
\r
225 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );
\r
226 var child, length = newList.listNode.getChildCount();
\r
227 for ( i = 0 ; i < length && ( child = newList.listNode.getChild( i ) ) ; i++ )
\r
229 if ( child.getName() == this.type )
\r
230 listsCreated.push( child );
\r
232 newList.listNode.replace( groupObj.root );
\r
235 function createList( editor, groupObj, listsCreated )
\r
237 var contents = groupObj.contents,
\r
238 doc = groupObj.root.getDocument(),
\r
241 // It is possible to have the contents returned by DomRangeIterator to be the same as the root.
\r
242 // e.g. when we're running into table cells.
\r
243 // In such a case, enclose the childNodes of contents[0] into a <div>.
\r
244 if ( contents.length == 1 && contents[0].equals( groupObj.root ) )
\r
246 var divBlock = doc.createElement( 'div' );
\r
247 contents[0].moveChildren && contents[0].moveChildren( divBlock );
\r
248 contents[0].append( divBlock );
\r
249 contents[0] = divBlock;
\r
252 // Calculate the common parent node of all content blocks.
\r
253 var commonParent = groupObj.contents[0].getParent();
\r
254 for ( var i = 0 ; i < contents.length ; i++ )
\r
255 commonParent = commonParent.getCommonAncestor( contents[i].getParent() );
\r
257 // We want to insert things that are in the same tree level only, so calculate the contents again
\r
258 // by expanding the selected blocks to the same tree level.
\r
259 for ( i = 0 ; i < contents.length ; i++ )
\r
261 var contentNode = contents[i],
\r
263 while ( ( parentNode = contentNode.getParent() ) )
\r
265 if ( parentNode.equals( commonParent ) )
\r
267 listContents.push( contentNode );
\r
270 contentNode = parentNode;
\r
274 if ( listContents.length < 1 )
\r
277 // Insert the list to the DOM tree.
\r
278 var insertAnchor = listContents[ listContents.length - 1 ].getNext(),
\r
279 listNode = doc.createElement( this.type );
\r
281 listsCreated.push( listNode );
\r
282 while ( listContents.length )
\r
284 var contentBlock = listContents.shift(),
\r
285 listItem = doc.createElement( 'li' );
\r
286 contentBlock.moveChildren( listItem );
\r
287 contentBlock.remove();
\r
288 listItem.appendTo( listNode );
\r
290 // Append a bogus BR to force the LI to render at full height
\r
291 if ( !CKEDITOR.env.ie )
\r
292 listItem.appendBogus();
\r
294 if ( insertAnchor )
\r
295 listNode.insertBefore( insertAnchor );
\r
297 listNode.appendTo( commonParent );
\r
300 function removeList( editor, groupObj, database )
\r
302 // This is very much like the change list type operation.
\r
303 // Except that we're changing the selected items' indent to -1 in the list array.
\r
304 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),
\r
305 selectedListItems = [];
\r
307 for ( var i = 0 ; i < groupObj.contents.length ; i++ )
\r
309 var itemNode = groupObj.contents[i];
\r
310 itemNode = itemNode.getAscendant( 'li', true );
\r
311 if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )
\r
313 selectedListItems.push( itemNode );
\r
314 CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );
\r
317 var lastListIndex = null;
\r
318 for ( i = 0 ; i < selectedListItems.length ; i++ )
\r
320 var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );
\r
321 listArray[listIndex].indent = -1;
\r
322 lastListIndex = listIndex;
\r
325 // After cutting parts of the list out with indent=-1, we still have to maintain the array list
\r
326 // model's nextItem.indent <= currentItem.indent + 1 invariant. Otherwise the array model of the
\r
327 // list cannot be converted back to a real DOM list.
\r
328 for ( i = lastListIndex + 1 ; i < listArray.length ; i++ )
\r
330 if ( listArray[i].indent > listArray[i-1].indent + 1 )
\r
332 var indentOffset = listArray[i-1].indent + 1 - listArray[i].indent;
\r
333 var oldIndent = listArray[i].indent;
\r
334 while ( listArray[i] && listArray[i].indent >= oldIndent )
\r
336 listArray[i].indent += indentOffset;
\r
343 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );
\r
345 // Compensate <br> before/after the list node if the surrounds are non-blocks.(#3836)
\r
346 var docFragment = newList.listNode, boundaryNode, siblingNode;
\r
347 function compensateBrs( isStart )
\r
349 if ( ( boundaryNode = docFragment[ isStart ? 'getFirst' : 'getLast' ]() )
\r
350 && !( boundaryNode.is && boundaryNode.isBlockBoundary() )
\r
351 && ( siblingNode = groupObj.root[ isStart ? 'getPrevious' : 'getNext' ]
\r
352 ( CKEDITOR.dom.walker.whitespaces( true ) ) )
\r
353 && !( siblingNode.is && siblingNode.isBlockBoundary( { br : 1 } ) ) )
\r
354 editor.document.createElement( 'br' )[ isStart ? 'insertBefore' : 'insertAfter' ]( boundaryNode );
\r
356 compensateBrs( true );
\r
359 docFragment.replace( groupObj.root );
\r
362 function listCommand( name, type )
\r
368 listCommand.prototype = {
\r
369 exec : function( editor )
\r
373 var doc = editor.document,
\r
374 selection = editor.getSelection(),
\r
375 ranges = selection && selection.getRanges();
\r
377 // There should be at least one selected range.
\r
378 if ( !ranges || ranges.length < 1 )
\r
381 // Midas lists rule #1 says we can create a list even in an empty document.
\r
382 // But DOM iterator wouldn't run if the document is really empty.
\r
383 // So create a paragraph if the document is empty and we're going to create a list.
\r
384 if ( this.state == CKEDITOR.TRISTATE_OFF )
\r
386 var body = doc.getBody();
\r
388 if ( !body.getFirst() )
\r
390 var paragraph = doc.createElement( editor.config.enterMode == CKEDITOR.ENTER_P ? 'p' :
\r
391 ( editor.config.enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'br' ) );
\r
392 paragraph.appendTo( body );
\r
393 ranges = [ new CKEDITOR.dom.range( doc ) ];
\r
394 // IE exception on inserting anything when anchor inside <br>.
\r
395 if ( paragraph.is( 'br' ) )
\r
397 ranges[ 0 ].setStartBefore( paragraph );
\r
398 ranges[ 0 ].setEndAfter( paragraph );
\r
401 ranges[ 0 ].selectNodeContents( paragraph );
\r
402 selection.selectRanges( ranges );
\r
404 // Maybe a single range there enclosing the whole list,
\r
405 // turn on the list state manually(#4129).
\r
408 var range = ranges.length == 1 && ranges[ 0 ],
\r
409 enclosedNode = range && range.getEnclosedNode();
\r
410 if ( enclosedNode && enclosedNode.is
\r
411 && this.type == enclosedNode.getName() )
\r
413 setState.call( this, editor, CKEDITOR.TRISTATE_ON );
\r
418 var bookmarks = selection.createBookmarks( true );
\r
420 // Group the blocks up because there are many cases where multiple lists have to be created,
\r
421 // or multiple lists have to be cancelled.
\r
422 var listGroups = [],
\r
425 while ( ranges.length > 0 )
\r
427 range = ranges.shift();
\r
429 var boundaryNodes = range.getBoundaryNodes(),
\r
430 startNode = boundaryNodes.startNode,
\r
431 endNode = boundaryNodes.endNode;
\r
433 if ( startNode.type == CKEDITOR.NODE_ELEMENT && startNode.getName() == 'td' )
\r
434 range.setStartAt( boundaryNodes.startNode, CKEDITOR.POSITION_AFTER_START );
\r
436 if ( endNode.type == CKEDITOR.NODE_ELEMENT && endNode.getName() == 'td' )
\r
437 range.setEndAt( boundaryNodes.endNode, CKEDITOR.POSITION_BEFORE_END );
\r
439 var iterator = range.createIterator(),
\r
442 iterator.forceBrBreak = ( this.state == CKEDITOR.TRISTATE_OFF );
\r
444 while ( ( block = iterator.getNextParagraph() ) )
\r
446 var path = new CKEDITOR.dom.elementPath( block ),
\r
447 pathElements = path.elements,
\r
448 pathElementsCount = pathElements.length,
\r
450 processedFlag = false,
\r
451 blockLimit = path.blockLimit,
\r
454 // First, try to group by a list ancestor.
\r
455 for ( var i = pathElementsCount - 1; i >= 0 && ( element = pathElements[ i ] ); i-- )
\r
457 if ( listNodeNames[ element.getName() ]
\r
458 && blockLimit.contains( element ) ) // Don't leak outside block limit (#3940).
\r
460 // If we've encountered a list inside a block limit
\r
461 // The last group object of the block limit element should
\r
462 // no longer be valid. Since paragraphs after the list
\r
463 // should belong to a different group of paragraphs before
\r
464 // the list. (Bug #1309)
\r
465 blockLimit.removeCustomData( 'list_group_object' );
\r
467 var groupObj = element.getCustomData( 'list_group_object' );
\r
469 groupObj.contents.push( block );
\r
472 groupObj = { root : element, contents : [ block ] };
\r
473 listGroups.push( groupObj );
\r
474 CKEDITOR.dom.element.setMarker( database, element, 'list_group_object', groupObj );
\r
476 processedFlag = true;
\r
481 if ( processedFlag )
\r
484 // No list ancestor? Group by block limit.
\r
485 var root = blockLimit;
\r
486 if ( root.getCustomData( 'list_group_object' ) )
\r
487 root.getCustomData( 'list_group_object' ).contents.push( block );
\r
490 groupObj = { root : root, contents : [ block ] };
\r
491 CKEDITOR.dom.element.setMarker( database, root, 'list_group_object', groupObj );
\r
492 listGroups.push( groupObj );
\r
497 // Now we have two kinds of list groups, groups rooted at a list, and groups rooted at a block limit element.
\r
498 // We either have to build lists or remove lists, for removing a list does not makes sense when we are looking
\r
499 // at the group that's not rooted at lists. So we have three cases to handle.
\r
500 var listsCreated = [];
\r
501 while ( listGroups.length > 0 )
\r
503 groupObj = listGroups.shift();
\r
504 if ( this.state == CKEDITOR.TRISTATE_OFF )
\r
506 if ( listNodeNames[ groupObj.root.getName() ] )
\r
507 changeListType.call( this, editor, groupObj, database, listsCreated );
\r
509 createList.call( this, editor, groupObj, listsCreated );
\r
511 else if ( this.state == CKEDITOR.TRISTATE_ON && listNodeNames[ groupObj.root.getName() ] )
\r
512 removeList.call( this, editor, groupObj, database );
\r
515 // For all new lists created, merge adjacent, same type lists.
\r
516 for ( i = 0 ; i < listsCreated.length ; i++ )
\r
518 listNode = listsCreated[i];
\r
519 var mergeSibling, listCommand = this;
\r
520 ( mergeSibling = function( rtl ){
\r
522 var sibling = listNode[ rtl ?
\r
523 'getPrevious' : 'getNext' ]( CKEDITOR.dom.walker.whitespaces( true ) );
\r
524 if ( sibling && sibling.getName &&
\r
525 sibling.getName() == listCommand.type )
\r
528 // Move children order by merge direction.(#3820)
\r
529 sibling.moveChildren( listNode, rtl ? true : false );
\r
532 mergeSibling( true );
\r
535 // Clean up, restore selection and update toolbar button states.
\r
536 CKEDITOR.dom.element.clearAllMarkers( database );
\r
537 selection.selectBookmarks( bookmarks );
\r
542 var dtd = CKEDITOR.dtd;
\r
543 var tailNbspRegex = /[\t\r\n ]*(?: |\xa0)$/;
\r
545 function indexOfFirstChildElement( element, tagNameList )
\r
548 children = element.children,
\r
549 length = children.length;
\r
551 for ( var i = 0 ; i < length ; i++ )
\r
553 child = children[ i ];
\r
554 if ( child.name && ( child.name in tagNameList ) )
\r
561 function getExtendNestedListFilter( isHtmlFilter )
\r
563 // An element filter function that corrects nested list start in an empty
\r
564 // list item for better displaying/outputting. (#3165)
\r
565 return function( listItem )
\r
567 var children = listItem.children,
\r
568 firstNestedListIndex = indexOfFirstChildElement( listItem, dtd.$list ),
\r
569 firstNestedList = children[ firstNestedListIndex ],
\r
570 nodeBefore = firstNestedList && firstNestedList.previous,
\r
574 && ( nodeBefore.name && nodeBefore.name == 'br'
\r
575 || nodeBefore.value && ( tailNbspmatch = nodeBefore.value.match( tailNbspRegex ) ) ) )
\r
577 var fillerNode = nodeBefore;
\r
579 // Always use 'nbsp' as filler node if we found a nested list appear
\r
580 // in front of a list item.
\r
581 if ( !( tailNbspmatch && tailNbspmatch.index ) && fillerNode == children[ 0 ] )
\r
582 children[ 0 ] = ( isHtmlFilter || CKEDITOR.env.ie ) ?
\r
583 new CKEDITOR.htmlParser.text( '\xa0' ) :
\r
584 new CKEDITOR.htmlParser.element( 'br', {} );
\r
586 // Otherwise the filler is not needed anymore.
\r
587 else if ( fillerNode.name == 'br' )
\r
588 children.splice( firstNestedListIndex - 1, 1 );
\r
590 fillerNode.value = fillerNode.value.replace( tailNbspRegex, '' );
\r
596 var defaultListDataFilterRules = { elements : {} };
\r
597 for( var i in dtd.$listItem )
\r
598 defaultListDataFilterRules.elements[ i ] = getExtendNestedListFilter();
\r
600 var defaultListHtmlFilterRules = { elements : {} };
\r
601 for( i in dtd.$listItem )
\r
602 defaultListHtmlFilterRules.elements[ i ] = getExtendNestedListFilter( true );
\r
604 CKEDITOR.plugins.add( 'list',
\r
606 init : function( editor )
\r
608 // Register commands.
\r
609 var numberedListCommand = new listCommand( 'numberedlist', 'ol' ),
\r
610 bulletedListCommand = new listCommand( 'bulletedlist', 'ul' );
\r
611 editor.addCommand( 'numberedlist', numberedListCommand );
\r
612 editor.addCommand( 'bulletedlist', bulletedListCommand );
\r
614 // Register the toolbar button.
\r
615 editor.ui.addButton( 'NumberedList',
\r
617 label : editor.lang.numberedlist,
\r
618 command : 'numberedlist'
\r
620 editor.ui.addButton( 'BulletedList',
\r
622 label : editor.lang.bulletedlist,
\r
623 command : 'bulletedlist'
\r
626 // Register the state changing handlers.
\r
627 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, numberedListCommand ) );
\r
628 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, bulletedListCommand ) );
\r
631 afterInit : function ( editor )
\r
633 var dataProcessor = editor.dataProcessor;
\r
634 if( dataProcessor )
\r
636 dataProcessor.dataFilter.addRules( defaultListDataFilterRules );
\r
637 dataProcessor.htmlFilter.addRules( defaultListHtmlFilterRules );
\r
641 requires : [ 'domiterator' ]
\r