2 Copyright (c) 2003-2012, 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 var whitespaces = CKEDITOR.dom.walker.whitespaces(),
\r
16 bookmarks = CKEDITOR.dom.walker.bookmark(),
\r
17 nonEmpty = function( node ){ return !( whitespaces( node ) || bookmarks( node ) );},
\r
18 blockBogus = CKEDITOR.dom.walker.bogus();
\r
20 function cleanUpDirection( element )
\r
22 var dir, parent, parentDir;
\r
23 if ( ( dir = element.getDirection() ) )
\r
25 parent = element.getParent();
\r
26 while ( parent && !( parentDir = parent.getDirection() ) )
\r
27 parent = parent.getParent();
\r
29 if ( dir == parentDir )
\r
30 element.removeAttribute( 'dir' );
\r
34 // Inheirt inline styles from another element.
\r
35 function inheirtInlineStyles( parent, el )
\r
37 var style = parent.getAttribute( 'style' );
\r
39 // Put parent styles before child styles.
\r
40 style && el.setAttribute( 'style',
\r
41 style.replace( /([^;])$/, '$1;' ) +
\r
42 ( el.getAttribute( 'style' ) || '' ) );
\r
45 CKEDITOR.plugins.list = {
\r
47 * Convert a DOM list tree into a data structure that is easier to
\r
48 * manipulate. This operation should be non-intrusive in the sense that it
\r
49 * does not change the DOM tree, with the exception that it may add some
\r
50 * markers to the list item nodes when database is specified.
\r
52 listToArray : function( listNode, database, baseArray, baseIndentLevel, grandparentNode )
\r
54 if ( !listNodeNames[ listNode.getName() ] )
\r
57 if ( !baseIndentLevel )
\r
58 baseIndentLevel = 0;
\r
62 // Iterate over all list items to and look for inner lists.
\r
63 for ( var i = 0, count = listNode.getChildCount() ; i < count ; i++ )
\r
65 var listItem = listNode.getChild( i );
\r
67 // Fixing malformed nested lists by moving it into a previous list item. (#6236)
\r
68 if( listItem.type == CKEDITOR.NODE_ELEMENT && listItem.getName() in CKEDITOR.dtd.$list )
\r
69 CKEDITOR.plugins.list.listToArray( listItem, database, baseArray, baseIndentLevel + 1 );
\r
71 // It may be a text node or some funny stuff.
\r
72 if ( listItem.$.nodeName.toLowerCase() != 'li' )
\r
75 var itemObj = { 'parent' : listNode, indent : baseIndentLevel, element : listItem, contents : [] };
\r
76 if ( !grandparentNode )
\r
78 itemObj.grandparent = listNode.getParent();
\r
79 if ( itemObj.grandparent && itemObj.grandparent.$.nodeName.toLowerCase() == 'li' )
\r
80 itemObj.grandparent = itemObj.grandparent.getParent();
\r
83 itemObj.grandparent = grandparentNode;
\r
86 CKEDITOR.dom.element.setMarker( database, listItem, 'listarray_index', baseArray.length );
\r
87 baseArray.push( itemObj );
\r
89 for ( var j = 0, itemChildCount = listItem.getChildCount(), child; j < itemChildCount ; j++ )
\r
91 child = listItem.getChild( j );
\r
92 if ( child.type == CKEDITOR.NODE_ELEMENT && listNodeNames[ child.getName() ] )
\r
93 // Note the recursion here, it pushes inner list items with
\r
94 // +1 indentation in the correct order.
\r
95 CKEDITOR.plugins.list.listToArray( child, database, baseArray, baseIndentLevel + 1, itemObj.grandparent );
\r
97 itemObj.contents.push( child );
\r
103 // Convert our internal representation of a list back to a DOM forest.
\r
104 arrayToList : function( listArray, database, baseIndex, paragraphMode, dir )
\r
108 if ( !listArray || listArray.length < baseIndex + 1 )
\r
111 doc = listArray[ baseIndex ].parent.getDocument(),
\r
112 retval = new CKEDITOR.dom.documentFragment( doc ),
\r
114 currentIndex = baseIndex,
\r
115 indentLevel = Math.max( listArray[ baseIndex ].indent, 0 ),
\r
116 currentListItem = null,
\r
119 paragraphName = ( paragraphMode == CKEDITOR.ENTER_P ? 'p' : 'div' );
\r
122 var item = listArray[ currentIndex ],
\r
123 itemGrandParent = item.grandparent;
\r
125 orgDir = item.element.getDirection( 1 );
\r
127 if ( item.indent == indentLevel )
\r
129 if ( !rootNode || listArray[ currentIndex ].parent.getName() != rootNode.getName() )
\r
131 rootNode = listArray[ currentIndex ].parent.clone( false, 1 );
\r
132 dir && rootNode.setAttribute( 'dir', dir );
\r
133 retval.append( rootNode );
\r
135 currentListItem = rootNode.append( item.element.clone( 0, 1 ) );
\r
137 if ( orgDir != rootNode.getDirection( 1 ) )
\r
138 currentListItem.setAttribute( 'dir', orgDir );
\r
140 for ( i = 0 ; i < item.contents.length ; i++ )
\r
141 currentListItem.append( item.contents[i].clone( 1, 1 ) );
\r
144 else if ( item.indent == Math.max( indentLevel, 0 ) + 1 )
\r
146 // Maintain original direction (#6861).
\r
147 var currDir = listArray[ currentIndex - 1 ].element.getDirection( 1 ),
\r
148 listData = CKEDITOR.plugins.list.arrayToList( listArray, null, currentIndex, paragraphMode,
\r
149 currDir != orgDir ? orgDir: null );
\r
151 // If the next block is an <li> with another list tree as the first
\r
152 // child, we'll need to append a filler (<br>/NBSP) or the list item
\r
153 // wouldn't be editable. (#6724)
\r
154 if ( !currentListItem.getChildCount() && CKEDITOR.env.ie && !( doc.$.documentMode > 7 ))
\r
155 currentListItem.append( doc.createText( '\xa0' ) );
\r
156 currentListItem.append( listData.listNode );
\r
157 currentIndex = listData.nextIndex;
\r
159 else if ( item.indent == -1 && !baseIndex && itemGrandParent )
\r
161 if ( listNodeNames[ itemGrandParent.getName() ] )
\r
163 currentListItem = item.element.clone( false, true );
\r
164 if ( orgDir != itemGrandParent.getDirection( 1 ) )
\r
165 currentListItem.setAttribute( 'dir', orgDir );
\r
168 currentListItem = new CKEDITOR.dom.documentFragment( doc );
\r
170 // Migrate all children to the new container,
\r
171 // apply the proper text direction.
\r
172 var dirLoose = itemGrandParent.getDirection( 1 ) != orgDir,
\r
174 className = li.getAttribute( 'class' ),
\r
175 style = li.getAttribute( 'style' );
\r
177 var needsBlock = currentListItem.type ==
\r
178 CKEDITOR.NODE_DOCUMENT_FRAGMENT &&
\r
179 ( paragraphMode != CKEDITOR.ENTER_BR || dirLoose ||
\r
180 style || className );
\r
182 var child, count = item.contents.length;
\r
183 for ( i = 0 ; i < count; i++ )
\r
185 child = item.contents[ i ];
\r
187 if ( child.type == CKEDITOR.NODE_ELEMENT && child.isBlockBoundary() )
\r
189 // Apply direction on content blocks.
\r
190 if ( dirLoose && !child.getDirection() )
\r
191 child.setAttribute( 'dir', orgDir );
\r
193 inheirtInlineStyles( li, child );
\r
195 className && child.addClass( className );
\r
197 else if ( needsBlock )
\r
199 // Establish new block to hold text direction and styles.
\r
202 block = doc.createElement( paragraphName );
\r
203 dirLoose && block.setAttribute( 'dir', orgDir );
\r
206 // Copy over styles to new block;
\r
207 style && block.setAttribute( 'style', style );
\r
208 className && block.setAttribute( 'class', className );
\r
210 block.append( child.clone( 1, 1 ) );
\r
213 currentListItem.append( block || child.clone( 1, 1 ) );
\r
216 if ( currentListItem.type == CKEDITOR.NODE_DOCUMENT_FRAGMENT
\r
217 && currentIndex != listArray.length - 1 )
\r
219 var last = currentListItem.getLast();
\r
220 if ( last && last.type == CKEDITOR.NODE_ELEMENT
\r
221 && last.getAttribute( 'type' ) == '_moz' )
\r
226 if ( !( last = currentListItem.getLast( nonEmpty )
\r
227 && last.type == CKEDITOR.NODE_ELEMENT
\r
228 && last.getName() in CKEDITOR.dtd.$block ) )
\r
230 currentListItem.append( doc.createElement( 'br' ) );
\r
234 var currentListItemName = currentListItem.$.nodeName.toLowerCase();
\r
235 if ( !CKEDITOR.env.ie && ( currentListItemName == 'div' || currentListItemName == 'p' ) )
\r
236 currentListItem.appendBogus();
\r
237 retval.append( currentListItem );
\r
246 if ( listArray.length <= currentIndex || Math.max( listArray[ currentIndex ].indent, 0 ) < indentLevel )
\r
252 var currentNode = retval.getFirst(),
\r
253 listRoot = listArray[ 0 ].parent;
\r
255 while ( currentNode )
\r
257 if ( currentNode.type == CKEDITOR.NODE_ELEMENT )
\r
259 // Clear marker attributes for the new list tree made of cloned nodes, if any.
\r
260 CKEDITOR.dom.element.clearMarkers( database, currentNode );
\r
262 // Clear redundant direction attribute specified on list items.
\r
263 if ( currentNode.getName() in CKEDITOR.dtd.$listItem )
\r
264 cleanUpDirection( currentNode );
\r
267 currentNode = currentNode.getNextSourceNode();
\r
271 return { listNode : retval, nextIndex : currentIndex };
\r
275 function onSelectionChange( evt )
\r
277 if ( evt.editor.readOnly )
\r
280 var path = evt.data.path,
\r
281 blockLimit = path.blockLimit,
\r
282 elements = path.elements,
\r
286 // Grouping should only happen under blockLimit.(#3940).
\r
287 for ( i = 0 ; i < elements.length && ( element = elements[ i ] )
\r
288 && !element.equals( blockLimit ); i++ )
\r
290 if ( listNodeNames[ elements[ i ].getName() ] )
\r
291 return this.setState( this.type == elements[ i ].getName() ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );
\r
294 return this.setState( CKEDITOR.TRISTATE_OFF );
\r
297 function changeListType( editor, groupObj, database, listsCreated )
\r
299 // This case is easy...
\r
300 // 1. Convert the whole list into a one-dimensional array.
\r
301 // 2. Change the list type by modifying the array.
\r
302 // 3. Recreate the whole list by converting the array to a list.
\r
303 // 4. Replace the original list with the recreated list.
\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 root = groupObj.root,
\r
318 doc = root.getDocument(),
\r
322 for ( i = 0 ; i < selectedListItems.length ; i++ )
\r
324 var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );
\r
325 listNode = listArray[ listIndex ].parent;
\r
327 // Switch to new list node for this particular item.
\r
328 if ( !listNode.is( this.type ) )
\r
330 newListNode = doc.createElement( this.type );
\r
331 // Copy all attributes, except from 'start' and 'type'.
\r
332 listNode.copyAttributes( newListNode, { start : 1, type : 1 } );
\r
333 // The list-style-type property should be ignored.
\r
334 newListNode.removeStyle( 'list-style-type' );
\r
335 listArray[ listIndex ].parent = newListNode;
\r
339 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );
\r
340 var child, length = newList.listNode.getChildCount();
\r
341 for ( i = 0 ; i < length && ( child = newList.listNode.getChild( i ) ) ; i++ )
\r
343 if ( child.getName() == this.type )
\r
344 listsCreated.push( child );
\r
346 newList.listNode.replace( groupObj.root );
\r
349 var headerTagRegex = /^h[1-6]$/;
\r
351 function createList( editor, groupObj, listsCreated )
\r
353 var contents = groupObj.contents,
\r
354 doc = groupObj.root.getDocument(),
\r
357 // It is possible to have the contents returned by DomRangeIterator to be the same as the root.
\r
358 // e.g. when we're running into table cells.
\r
359 // In such a case, enclose the childNodes of contents[0] into a <div>.
\r
360 if ( contents.length == 1 && contents[0].equals( groupObj.root ) )
\r
362 var divBlock = doc.createElement( 'div' );
\r
363 contents[0].moveChildren && contents[0].moveChildren( divBlock );
\r
364 contents[0].append( divBlock );
\r
365 contents[0] = divBlock;
\r
368 // Calculate the common parent node of all content blocks.
\r
369 var commonParent = groupObj.contents[0].getParent();
\r
370 for ( var i = 0 ; i < contents.length ; i++ )
\r
371 commonParent = commonParent.getCommonAncestor( contents[i].getParent() );
\r
373 var useComputedState = editor.config.useComputedState,
\r
374 listDir, explicitDirection;
\r
376 useComputedState = useComputedState === undefined || useComputedState;
\r
378 // We want to insert things that are in the same tree level only, so calculate the contents again
\r
379 // by expanding the selected blocks to the same tree level.
\r
380 for ( i = 0 ; i < contents.length ; i++ )
\r
382 var contentNode = contents[i],
\r
384 while ( ( parentNode = contentNode.getParent() ) )
\r
386 if ( parentNode.equals( commonParent ) )
\r
388 listContents.push( contentNode );
\r
390 // Determine the lists's direction.
\r
391 if ( !explicitDirection && contentNode.getDirection() )
\r
392 explicitDirection = 1;
\r
394 var itemDir = contentNode.getDirection( useComputedState );
\r
396 if ( listDir !== null )
\r
398 // If at least one LI have a different direction than current listDir, we can't have listDir.
\r
399 if ( listDir && listDir != itemDir )
\r
407 contentNode = parentNode;
\r
411 if ( listContents.length < 1 )
\r
414 // Insert the list to the DOM tree.
\r
415 var insertAnchor = listContents[ listContents.length - 1 ].getNext(),
\r
416 listNode = doc.createElement( this.type );
\r
418 listsCreated.push( listNode );
\r
420 var contentBlock, listItem;
\r
422 while ( listContents.length )
\r
424 contentBlock = listContents.shift();
\r
425 listItem = doc.createElement( 'li' );
\r
427 // Preserve preformat block and heading structure when converting to list item. (#5335) (#5271)
\r
428 if ( contentBlock.is( 'pre' ) || headerTagRegex.test( contentBlock.getName() ) )
\r
429 contentBlock.appendTo( listItem );
\r
432 contentBlock.copyAttributes( listItem );
\r
433 // Remove direction attribute after it was merged into list root. (#7657)
\r
434 if ( listDir && contentBlock.getDirection() )
\r
436 listItem.removeStyle( 'direction' );
\r
437 listItem.removeAttribute( 'dir' );
\r
439 contentBlock.moveChildren( listItem );
\r
440 contentBlock.remove();
\r
443 listItem.appendTo( listNode );
\r
446 // Apply list root dir only if it has been explicitly declared.
\r
447 if ( listDir && explicitDirection )
\r
448 listNode.setAttribute( 'dir', listDir );
\r
450 if ( insertAnchor )
\r
451 listNode.insertBefore( insertAnchor );
\r
453 listNode.appendTo( commonParent );
\r
456 function removeList( editor, groupObj, database )
\r
458 // This is very much like the change list type operation.
\r
459 // Except that we're changing the selected items' indent to -1 in the list array.
\r
460 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),
\r
461 selectedListItems = [];
\r
463 for ( var i = 0 ; i < groupObj.contents.length ; i++ )
\r
465 var itemNode = groupObj.contents[i];
\r
466 itemNode = itemNode.getAscendant( 'li', true );
\r
467 if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )
\r
469 selectedListItems.push( itemNode );
\r
470 CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );
\r
473 var lastListIndex = null;
\r
474 for ( i = 0 ; i < selectedListItems.length ; i++ )
\r
476 var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );
\r
477 listArray[listIndex].indent = -1;
\r
478 lastListIndex = listIndex;
\r
481 // After cutting parts of the list out with indent=-1, we still have to maintain the array list
\r
482 // model's nextItem.indent <= currentItem.indent + 1 invariant. Otherwise the array model of the
\r
483 // list cannot be converted back to a real DOM list.
\r
484 for ( i = lastListIndex + 1 ; i < listArray.length ; i++ )
\r
486 if ( listArray[i].indent > listArray[i-1].indent + 1 )
\r
488 var indentOffset = listArray[i-1].indent + 1 - listArray[i].indent;
\r
489 var oldIndent = listArray[i].indent;
\r
490 while ( listArray[i] && listArray[i].indent >= oldIndent )
\r
492 listArray[i].indent += indentOffset;
\r
499 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode,
\r
500 groupObj.root.getAttribute( 'dir' ) );
\r
502 // Compensate <br> before/after the list node if the surrounds are non-blocks.(#3836)
\r
503 var docFragment = newList.listNode, boundaryNode, siblingNode;
\r
504 function compensateBrs( isStart )
\r
506 if ( ( boundaryNode = docFragment[ isStart ? 'getFirst' : 'getLast' ]() )
\r
507 && !( boundaryNode.is && boundaryNode.isBlockBoundary() )
\r
508 && ( siblingNode = groupObj.root[ isStart ? 'getPrevious' : 'getNext' ]
\r
509 ( CKEDITOR.dom.walker.whitespaces( true ) ) )
\r
510 && !( siblingNode.is && siblingNode.isBlockBoundary( { br : 1 } ) ) )
\r
511 editor.document.createElement( 'br' )[ isStart ? 'insertBefore' : 'insertAfter' ]( boundaryNode );
\r
513 compensateBrs( true );
\r
516 docFragment.replace( groupObj.root );
\r
519 function listCommand( name, type )
\r
525 var elementType = CKEDITOR.dom.walker.nodeType( CKEDITOR.NODE_ELEMENT );
\r
527 // Merge child nodes with direction preserved. (#7448)
\r
528 function mergeChildren( from, into, refNode, forward )
\r
530 var child, itemDir;
\r
531 while ( ( child = from[ forward ? 'getLast' : 'getFirst' ]( elementType ) ) )
\r
533 if ( ( itemDir = child.getDirection( 1 ) ) !== into.getDirection( 1 ) )
\r
534 child.setAttribute( 'dir', itemDir );
\r
539 child[ forward ? 'insertBefore' : 'insertAfter' ]( refNode ) :
\r
540 into.append( child, forward );
\r
544 listCommand.prototype = {
\r
545 exec : function( editor )
\r
547 var doc = editor.document,
\r
548 config = editor.config,
\r
549 selection = editor.getSelection(),
\r
550 ranges = selection && selection.getRanges( true );
\r
552 // There should be at least one selected range.
\r
553 if ( !ranges || ranges.length < 1 )
\r
556 // Midas lists rule #1 says we can create a list even in an empty document.
\r
557 // But DOM iterator wouldn't run if the document is really empty.
\r
558 // So create a paragraph if the document is empty and we're going to create a list.
\r
559 if ( this.state == CKEDITOR.TRISTATE_OFF )
\r
561 var body = doc.getBody();
\r
562 if ( !body.getFirst( nonEmpty ) )
\r
564 config.enterMode == CKEDITOR.ENTER_BR ?
\r
565 body.appendBogus() :
\r
566 ranges[ 0 ].fixBlock( 1, config.enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' );
\r
568 selection.selectRanges( ranges );
\r
570 // Maybe a single range there enclosing the whole list,
\r
571 // turn on the list state manually(#4129).
\r
574 var range = ranges.length == 1 && ranges[ 0 ],
\r
575 enclosedNode = range && range.getEnclosedNode();
\r
576 if ( enclosedNode && enclosedNode.is
\r
577 && this.type == enclosedNode.getName() )
\r
578 this.setState( CKEDITOR.TRISTATE_ON );
\r
582 var bookmarks = selection.createBookmarks( true );
\r
584 // Group the blocks up because there are many cases where multiple lists have to be created,
\r
585 // or multiple lists have to be cancelled.
\r
586 var listGroups = [],
\r
588 rangeIterator = ranges.createIterator(),
\r
591 while ( ( range = rangeIterator.getNextRange() ) && ++index )
\r
593 var boundaryNodes = range.getBoundaryNodes(),
\r
594 startNode = boundaryNodes.startNode,
\r
595 endNode = boundaryNodes.endNode;
\r
597 if ( startNode.type == CKEDITOR.NODE_ELEMENT && startNode.getName() == 'td' )
\r
598 range.setStartAt( boundaryNodes.startNode, CKEDITOR.POSITION_AFTER_START );
\r
600 if ( endNode.type == CKEDITOR.NODE_ELEMENT && endNode.getName() == 'td' )
\r
601 range.setEndAt( boundaryNodes.endNode, CKEDITOR.POSITION_BEFORE_END );
\r
603 var iterator = range.createIterator(),
\r
606 iterator.forceBrBreak = ( this.state == CKEDITOR.TRISTATE_OFF );
\r
608 while ( ( block = iterator.getNextParagraph() ) )
\r
610 // Avoid duplicate blocks get processed across ranges.
\r
611 if( block.getCustomData( 'list_block' ) )
\r
614 CKEDITOR.dom.element.setMarker( database, block, 'list_block', 1 );
\r
616 var path = new CKEDITOR.dom.elementPath( block ),
\r
617 pathElements = path.elements,
\r
618 pathElementsCount = pathElements.length,
\r
621 blockLimit = path.blockLimit,
\r
624 // First, try to group by a list ancestor.
\r
625 for ( var i = pathElementsCount - 1; i >= 0 && ( element = pathElements[ i ] ); i-- )
\r
627 if ( listNodeNames[ element.getName() ]
\r
628 && blockLimit.contains( element ) ) // Don't leak outside block limit (#3940).
\r
630 // If we've encountered a list inside a block limit
\r
631 // The last group object of the block limit element should
\r
632 // no longer be valid. Since paragraphs after the list
\r
633 // should belong to a different group of paragraphs before
\r
634 // the list. (Bug #1309)
\r
635 blockLimit.removeCustomData( 'list_group_object_' + index );
\r
637 var groupObj = element.getCustomData( 'list_group_object' );
\r
639 groupObj.contents.push( block );
\r
642 groupObj = { root : element, contents : [ block ] };
\r
643 listGroups.push( groupObj );
\r
644 CKEDITOR.dom.element.setMarker( database, element, 'list_group_object', groupObj );
\r
651 if ( processedFlag )
\r
654 // No list ancestor? Group by block limit, but don't mix contents from different ranges.
\r
655 var root = blockLimit;
\r
656 if ( root.getCustomData( 'list_group_object_' + index ) )
\r
657 root.getCustomData( 'list_group_object_' + index ).contents.push( block );
\r
660 groupObj = { root : root, contents : [ block ] };
\r
661 CKEDITOR.dom.element.setMarker( database, root, 'list_group_object_' + index, groupObj );
\r
662 listGroups.push( groupObj );
\r
667 // Now we have two kinds of list groups, groups rooted at a list, and groups rooted at a block limit element.
\r
668 // We either have to build lists or remove lists, for removing a list does not makes sense when we are looking
\r
669 // at the group that's not rooted at lists. So we have three cases to handle.
\r
670 var listsCreated = [];
\r
671 while ( listGroups.length > 0 )
\r
673 groupObj = listGroups.shift();
\r
674 if ( this.state == CKEDITOR.TRISTATE_OFF )
\r
676 if ( listNodeNames[ groupObj.root.getName() ] )
\r
677 changeListType.call( this, editor, groupObj, database, listsCreated );
\r
679 createList.call( this, editor, groupObj, listsCreated );
\r
681 else if ( this.state == CKEDITOR.TRISTATE_ON && listNodeNames[ groupObj.root.getName() ] )
\r
682 removeList.call( this, editor, groupObj, database );
\r
685 // For all new lists created, merge into adjacent, same type lists.
\r
686 for ( i = 0 ; i < listsCreated.length ; i++ )
\r
687 mergeListSiblings( listsCreated[ i ] );
\r
689 // Clean up, restore selection and update toolbar button states.
\r
690 CKEDITOR.dom.element.clearAllMarkers( database );
\r
691 selection.selectBookmarks( bookmarks );
\r
696 // Merge list adjacent, of same type lists.
\r
697 function mergeListSiblings( listNode )
\r
700 ( mergeSibling = function( rtl )
\r
702 var sibling = listNode[ rtl ? 'getPrevious' : 'getNext' ]( nonEmpty );
\r
703 if ( sibling && sibling.type == CKEDITOR.NODE_ELEMENT &&
\r
704 sibling.is( listNode.getName() ) )
\r
706 // Move children order by merge direction.(#3820)
\r
707 mergeChildren( listNode, sibling, null, !rtl );
\r
710 listNode = sibling;
\r
716 var dtd = CKEDITOR.dtd;
\r
717 var tailNbspRegex = /[\t\r\n ]*(?: |\xa0)$/;
\r
719 function indexOfFirstChildElement( element, tagNameList )
\r
722 children = element.children,
\r
723 length = children.length;
\r
725 for ( var i = 0 ; i < length ; i++ )
\r
727 child = children[ i ];
\r
728 if ( child.name && ( child.name in tagNameList ) )
\r
735 function getExtendNestedListFilter( isHtmlFilter )
\r
737 // An element filter function that corrects nested list start in an empty
\r
738 // list item for better displaying/outputting. (#3165)
\r
739 return function( listItem )
\r
741 var children = listItem.children,
\r
742 firstNestedListIndex = indexOfFirstChildElement( listItem, dtd.$list ),
\r
743 firstNestedList = children[ firstNestedListIndex ],
\r
744 nodeBefore = firstNestedList && firstNestedList.previous,
\r
748 && ( nodeBefore.name && nodeBefore.name == 'br'
\r
749 || nodeBefore.value && ( tailNbspmatch = nodeBefore.value.match( tailNbspRegex ) ) ) )
\r
751 var fillerNode = nodeBefore;
\r
753 // Always use 'nbsp' as filler node if we found a nested list appear
\r
754 // in front of a list item.
\r
755 if ( !( tailNbspmatch && tailNbspmatch.index ) && fillerNode == children[ 0 ] )
\r
756 children[ 0 ] = ( isHtmlFilter || CKEDITOR.env.ie ) ?
\r
757 new CKEDITOR.htmlParser.text( '\xa0' ) :
\r
758 new CKEDITOR.htmlParser.element( 'br', {} );
\r
760 // Otherwise the filler is not needed anymore.
\r
761 else if ( fillerNode.name == 'br' )
\r
762 children.splice( firstNestedListIndex - 1, 1 );
\r
764 fillerNode.value = fillerNode.value.replace( tailNbspRegex, '' );
\r
770 var defaultListDataFilterRules = { elements : {} };
\r
771 for ( var i in dtd.$listItem )
\r
772 defaultListDataFilterRules.elements[ i ] = getExtendNestedListFilter();
\r
774 var defaultListHtmlFilterRules = { elements : {} };
\r
775 for ( i in dtd.$listItem )
\r
776 defaultListHtmlFilterRules.elements[ i ] = getExtendNestedListFilter( true );
\r
778 // Check if node is block element that recieves text.
\r
779 function isTextBlock( node )
\r
781 return node.type == CKEDITOR.NODE_ELEMENT &&
\r
782 ( node.getName() in CKEDITOR.dtd.$block ||
\r
783 node.getName() in CKEDITOR.dtd.$listItem ) &&
\r
784 CKEDITOR.dtd[ node.getName() ][ '#' ];
\r
787 // Merge the visual line content at the cursor range into the block.
\r
788 function joinNextLineToCursor( editor, cursor, nextCursor )
\r
790 editor.fire( 'saveSnapshot' );
\r
792 // Merge with previous block's content.
\r
793 nextCursor.enlarge( CKEDITOR.ENLARGE_LIST_ITEM_CONTENTS );
\r
794 var frag = nextCursor.extractContents();
\r
796 cursor.trim( false, true );
\r
797 var bm = cursor.createBookmark();
\r
799 // Kill original bogus;
\r
800 var currentPath = new CKEDITOR.dom.elementPath( cursor.startContainer );
\r
801 var currentLi = currentPath.lastElement.getAscendant( 'li', 1 );
\r
803 var bogus = currentPath.block.getBogus();
\r
804 bogus && bogus.remove();
\r
806 // Kill the tail br in extracted.
\r
807 var last = frag.getLast();
\r
808 if ( last && last.type == CKEDITOR.NODE_ELEMENT && last.is( 'br' ) )
\r
811 // Insert fragment at the range position.
\r
812 var nextNode = cursor.startContainer.getChild( cursor.startOffset );
\r
814 frag.insertBefore( nextNode );
\r
816 cursor.startContainer.append( frag );
\r
818 var nextPath = new CKEDITOR.dom.elementPath( nextCursor.startContainer );
\r
819 var nextLi = nextCursor.startContainer.getAscendant( 'li', 1 );
\r
821 // Move the sub list nested in the next list item.
\r
824 var sublist = getSubList( nextLi );
\r
827 // If next line is in the sub list of the current list item.
\r
828 if ( currentLi.contains( nextLi ) )
\r
830 mergeChildren( sublist, nextLi.getParent(), nextLi );
\r
833 // Migrate the sub list to current list item.
\r
835 currentLi.append( sublist );
\r
839 // Remove any remaining empty path blocks at next line after merging.
\r
840 while ( nextCursor.checkStartOfBlock() &&
\r
841 nextCursor.checkEndOfBlock() )
\r
843 nextPath = new CKEDITOR.dom.elementPath( nextCursor.startContainer );
\r
844 var nextBlock = nextPath.block, parent;
\r
846 // Check if also to remove empty list.
\r
847 if ( nextBlock.is( 'li' ) )
\r
849 parent = nextBlock.getParent();
\r
850 if ( nextBlock.equals( parent.getLast( nonEmpty ) )
\r
851 && nextBlock.equals( parent.getFirst( nonEmpty ) ) )
\r
852 nextBlock = parent;
\r
855 nextCursor.moveToPosition( nextBlock, CKEDITOR.POSITION_BEFORE_START );
\r
856 nextBlock.remove();
\r
859 // Check if need to further merge with the list resides after the merged block. (#9080)
\r
860 var walkerRng = nextCursor.clone(), body = editor.document.getBody();
\r
861 walkerRng.setEndAt( body, CKEDITOR.POSITION_BEFORE_END );
\r
862 var walker = new CKEDITOR.dom.walker( walkerRng );
\r
863 walker.evaluator = function( node ) { return nonEmpty( node ) && !blockBogus( node ); };
\r
864 var next = walker.next();
\r
865 if ( next && next.type == CKEDITOR.NODE_ELEMENT && next.getName() in CKEDITOR.dtd.$list )
\r
866 mergeListSiblings( next );
\r
868 cursor.moveToBookmark( bm );
\r
870 // Make fresh selection.
\r
873 editor.selectionChange( 1 );
\r
874 editor.fire( 'saveSnapshot' );
\r
877 function getSubList( li )
\r
879 var last = li.getLast( nonEmpty );
\r
880 return last && last.type == CKEDITOR.NODE_ELEMENT && last.getName() in listNodeNames ? last : null;
\r
883 CKEDITOR.plugins.add( 'list',
\r
885 init : function( editor )
\r
887 // Register commands.
\r
888 var numberedListCommand = editor.addCommand( 'numberedlist', new listCommand( 'numberedlist', 'ol' ) ),
\r
889 bulletedListCommand = editor.addCommand( 'bulletedlist', new listCommand( 'bulletedlist', 'ul' ) );
\r
891 // Register the toolbar button.
\r
892 editor.ui.addButton( 'NumberedList',
\r
894 label : editor.lang.numberedlist,
\r
895 command : 'numberedlist'
\r
897 editor.ui.addButton( 'BulletedList',
\r
899 label : editor.lang.bulletedlist,
\r
900 command : 'bulletedlist'
\r
903 // Register the state changing handlers.
\r
904 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, numberedListCommand ) );
\r
905 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, bulletedListCommand ) );
\r
907 // Handled backspace/del key to join list items. (#8248,#9080)
\r
908 editor.on( 'key', function( evt )
\r
910 var key = evt.data.keyCode;
\r
913 if ( editor.mode == 'wysiwyg' && key in { 8 : 1, 46 : 1 } )
\r
915 var sel = editor.getSelection(),
\r
916 range = sel.getRanges()[ 0 ];
\r
918 if ( !range.collapsed )
\r
921 var isBackspace = key == 8;
\r
922 var body = editor.document.getBody();
\r
923 var walker = new CKEDITOR.dom.walker( range.clone() );
\r
924 walker.evaluator = function( node ) { return nonEmpty( node ) && !blockBogus( node ); };
\r
926 var cursor = range.clone();
\r
930 var previous, joinWith;
\r
932 var path = new CKEDITOR.dom.elementPath( range.startContainer );
\r
934 // Join a sub list's first line, with the previous visual line in parent.
\r
935 if ( ( previous = path.contains( listNodeNames ) ) &&
\r
936 range.checkBoundaryOfElement( previous, CKEDITOR.START ) &&
\r
937 ( previous = previous.getParent() ) && previous.is( 'li' ) &&
\r
938 ( previous = getSubList( previous ) ) )
\r
940 joinWith = previous;
\r
941 previous = previous.getPrevious( nonEmpty );
\r
942 // Place cursor before the nested list.
\r
943 cursor.moveToPosition(
\r
944 previous && blockBogus( previous ) ? previous : joinWith,
\r
945 CKEDITOR.POSITION_BEFORE_START );
\r
947 // Join any line following a list, with the last visual line of the list.
\r
950 walker.range.setStartAt( body, CKEDITOR.POSITION_AFTER_START );
\r
951 walker.range.setEnd( range.startContainer, range.startOffset );
\r
952 previous = walker.previous();
\r
954 if ( previous && previous.type == CKEDITOR.NODE_ELEMENT &&
\r
955 ( previous.getName() in listNodeNames || previous.is( 'li' ) ) )
\r
957 if ( !previous.is( 'li' ) )
\r
959 walker.range.selectNodeContents( previous );
\r
961 walker.evaluator = isTextBlock;
\r
962 previous = walker.previous();
\r
965 joinWith = previous;
\r
966 // Place cursor at the end of previous block.
\r
967 cursor.moveToElementEditEnd( joinWith );
\r
973 joinNextLineToCursor( editor, cursor, range );
\r
979 var li = range.startContainer.getAscendant( 'li', 1 );
\r
982 walker.range.setEndAt( body, CKEDITOR.POSITION_BEFORE_END );
\r
984 var last = li.getLast( nonEmpty );
\r
985 var block = last && isTextBlock( last ) ? last : li;
\r
987 // Indicate cursor at the visual end of an list item.
\r
990 var next = walker.next();
\r
992 // When list item contains a sub list.
\r
993 if ( next && next.type == CKEDITOR.NODE_ELEMENT &&
\r
994 next.getName() in listNodeNames
\r
995 && next.equals( last ) )
\r
999 // Move to the first item in sub list.
\r
1000 next = walker.next();
\r
1002 // Right at the end of list item.
\r
1003 else if ( range.checkBoundaryOfElement( block, CKEDITOR.END ) )
\r
1007 if ( isAtEnd && next )
\r
1009 // Put cursor range there.
\r
1010 var nextLine = range.clone();
\r
1011 nextLine.moveToElementEditStart( next );
\r
1013 joinNextLineToCursor( editor, cursor, nextLine );
\r
1019 // The backspace/del could potentially put cursor at a bad position,
\r
1020 // being it handled or not, check immediately the selection to have it fixed.
\r
1021 setTimeout( function() { editor.selectionChange( 1 ); } );
\r
1026 afterInit : function ( editor )
\r
1028 var dataProcessor = editor.dataProcessor;
\r
1029 if ( dataProcessor )
\r
1031 dataProcessor.dataFilter.addRules( defaultListDataFilterRules );
\r
1032 dataProcessor.htmlFilter.addRules( defaultListHtmlFilterRules );
\r
1036 requires : [ 'domiterator' ]
\r