_source/plugins/list/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
   3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
   4 */\r
   5 \r
   6 /**\r
   7  * @file Insert and remove numbered and bulleted lists.\r
   8  */\r
   9 \r
  10 (function()\r
  11 {\r
  12         var listNodeNames = { ol : 1, ul : 1 },\r
  13                 emptyTextRegex = /^[\n\r\t ]*$/;\r
  14 \r
  15         CKEDITOR.plugins.list = {\r
  16                 /*\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
  21                  */\r
  22                 listToArray : function( listNode, database, baseArray, baseIndentLevel, grandparentNode )\r
  23                 {\r
  24                         if ( !listNodeNames[ listNode.getName() ] )\r
  25                                 return [];\r
  26 \r
  27                         if ( !baseIndentLevel )\r
  28                                 baseIndentLevel = 0;\r
  29                         if ( !baseArray )\r
  30                                 baseArray = [];\r
  31 \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
  34                         {\r
  35                                 var listItem = listNode.getChild( i );\r
  36 \r
  37                                 // It may be a text node or some funny stuff.\r
  38                                 if ( listItem.$.nodeName.toLowerCase() != 'li' )\r
  39                                         continue;\r
  40 \r
  41                                 var itemObj = { 'parent' : listNode, indent : baseIndentLevel, element : listItem, contents : [] };\r
  42                                 if ( !grandparentNode )\r
  43                                 {\r
  44                                         itemObj.grandparent = listNode.getParent();\r
  45                                         if ( itemObj.grandparent && itemObj.grandparent.$.nodeName.toLowerCase() == 'li' )\r
  46                                                 itemObj.grandparent = itemObj.grandparent.getParent();\r
  47                                 }\r
  48                                 else\r
  49                                         itemObj.grandparent = grandparentNode;\r
  50 \r
  51                                 if ( database )\r
  52                                         CKEDITOR.dom.element.setMarker( database, listItem, 'listarray_index', baseArray.length );\r
  53                                 baseArray.push( itemObj );\r
  54 \r
  55                                 for ( var j = 0, itemChildCount = listItem.getChildCount(), child; j < itemChildCount ; j++ )\r
  56                                 {\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
  62                                         else\r
  63                                                 itemObj.contents.push( child );\r
  64                                 }\r
  65                         }\r
  66                         return baseArray;\r
  67                 },\r
  68 \r
  69                 // Convert our internal representation of a list back to a DOM forest.\r
  70                 arrayToList : function( listArray, database, baseIndex, paragraphMode )\r
  71                 {\r
  72                         if ( !baseIndex )\r
  73                                 baseIndex = 0;\r
  74                         if ( !listArray || listArray.length < baseIndex + 1 )\r
  75                                 return null;\r
  76                         var doc = listArray[ baseIndex ].parent.getDocument(),\r
  77                                 retval = new CKEDITOR.dom.documentFragment( doc ),\r
  78                                 rootNode = null,\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
  83                         while ( true )\r
  84                         {\r
  85                                 var item = listArray[ currentIndex ];\r
  86                                 if ( item.indent == indentLevel )\r
  87                                 {\r
  88                                         if ( !rootNode || listArray[ currentIndex ].parent.getName() != rootNode.getName() )\r
  89                                         {\r
  90                                                 rootNode = listArray[ currentIndex ].parent.clone( false, true );\r
  91                                                 retval.append( rootNode );\r
  92                                         }\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
  96                                         currentIndex++;\r
  97                                 }\r
  98                                 else if ( item.indent == Math.max( indentLevel, 0 ) + 1 )\r
  99                                 {\r
 100                                         var listData = CKEDITOR.plugins.list.arrayToList( listArray, null, currentIndex, paragraphMode );\r
 101                                         currentListItem.append( listData.listNode );\r
 102                                         currentIndex = listData.nextIndex;\r
 103                                 }\r
 104                                 else if ( item.indent == -1 && !baseIndex && item.grandparent )\r
 105                                 {\r
 106                                         currentListItem;\r
 107                                         if ( listNodeNames[ item.grandparent.getName() ] )\r
 108                                                 currentListItem = item.element.clone( false, true );\r
 109                                         else\r
 110                                         {\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
 114                                                 else\r
 115                                                         currentListItem = new CKEDITOR.dom.documentFragment( doc );\r
 116                                         }\r
 117 \r
 118                                         for ( i = 0 ; i < item.contents.length ; i++ )\r
 119                                                 currentListItem.append( item.contents[i].clone( true, true ) );\r
 120 \r
 121                                         if ( currentListItem.type == CKEDITOR.NODE_DOCUMENT_FRAGMENT\r
 122                                                  && currentIndex != listArray.length - 1 )\r
 123                                         {\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
 129                                         }\r
 130 \r
 131                                         if ( currentListItem.type == CKEDITOR.NODE_ELEMENT &&\r
 132                                                         currentListItem.getName() == paragraphName &&\r
 133                                                         currentListItem.$.firstChild )\r
 134                                         {\r
 135                                                 currentListItem.trim();\r
 136                                                 var firstChild = currentListItem.getFirst();\r
 137                                                 if ( firstChild.type == CKEDITOR.NODE_ELEMENT && firstChild.isBlockBoundary() )\r
 138                                                 {\r
 139                                                         var tmp = new CKEDITOR.dom.documentFragment( doc );\r
 140                                                         currentListItem.moveChildren( tmp );\r
 141                                                         currentListItem = tmp;\r
 142                                                 }\r
 143                                         }\r
 144 \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
 149                                         rootNode = null;\r
 150                                         currentIndex++;\r
 151                                 }\r
 152                                 else\r
 153                                         return null;\r
 154 \r
 155                                 if ( listArray.length <= currentIndex || Math.max( listArray[ currentIndex ].indent, 0 ) < indentLevel )\r
 156                                         break;\r
 157                         }\r
 158 \r
 159                         // Clear marker attributes for the new list tree made of cloned nodes, if any.\r
 160                         if ( database )\r
 161                         {\r
 162                                 var currentNode = retval.getFirst();\r
 163                                 while ( currentNode )\r
 164                                 {\r
 165                                         if ( currentNode.type == CKEDITOR.NODE_ELEMENT )\r
 166                                                 CKEDITOR.dom.element.clearMarkers( database, currentNode );\r
 167                                         currentNode = currentNode.getNextSourceNode();\r
 168                                 }\r
 169                         }\r
 170 \r
 171                         return { listNode : retval, nextIndex : currentIndex };\r
 172                 }\r
 173         };\r
 174 \r
 175         function setState( editor, state )\r
 176         {\r
 177                 editor.getCommand( this.name ).setState( state );\r
 178         }\r
 179 \r
 180         function onSelectionChange( evt )\r
 181         {\r
 182                 var path = evt.data.path,\r
 183                         blockLimit = path.blockLimit,\r
 184                         elements = path.elements,\r
 185                         element;\r
 186 \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
 190                 {\r
 191                         if ( listNodeNames[ elements[i].getName() ] )\r
 192                         {\r
 193                                 return setState.call( this, evt.editor,\r
 194                                                 this.type == elements[i].getName() ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );\r
 195                         }\r
 196                 }\r
 197 \r
 198                 return setState.call( this, evt.editor, CKEDITOR.TRISTATE_OFF );\r
 199         }\r
 200 \r
 201         function changeListType( editor, groupObj, database, listsCreated )\r
 202         {\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
 210 \r
 211                 for ( var i = 0 ; i < groupObj.contents.length ; i++ )\r
 212                 {\r
 213                         var itemNode = groupObj.contents[i];\r
 214                         itemNode = itemNode.getAscendant( 'li', true );\r
 215                         if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )\r
 216                                 continue;\r
 217                         selectedListItems.push( itemNode );\r
 218                         CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );\r
 219                 }\r
 220 \r
 221                 var root = groupObj.root,\r
 222                         fakeParent = root.getDocument().createElement( this.type );\r
 223                 // Copy all attributes, except from 'start' and 'type'.\r
 224                 root.copyAttributes( fakeParent, { start : 1, type : 1 } );\r
 225                 // The list-style-type property should be ignored.\r
 226                 fakeParent.removeStyle( 'list-style-type' );\r
 227 \r
 228                 for ( i = 0 ; i < selectedListItems.length ; i++ )\r
 229                 {\r
 230                         var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );\r
 231                         listArray[listIndex].parent = fakeParent;\r
 232                 }\r
 233                 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );\r
 234                 var child, length = newList.listNode.getChildCount();\r
 235                 for ( i = 0 ; i < length && ( child = newList.listNode.getChild( i ) ) ; i++ )\r
 236                 {\r
 237                         if ( child.getName() == this.type )\r
 238                                 listsCreated.push( child );\r
 239                 }\r
 240                 newList.listNode.replace( groupObj.root );\r
 241         }\r
 242 \r
 243         var headerTagRegex = /^h[1-6]$/;\r
 244 \r
 245         function createList( editor, groupObj, listsCreated )\r
 246         {\r
 247                 var contents = groupObj.contents,\r
 248                         doc = groupObj.root.getDocument(),\r
 249                         listContents = [];\r
 250 \r
 251                 // It is possible to have the contents returned by DomRangeIterator to be the same as the root.\r
 252                 // e.g. when we're running into table cells.\r
 253                 // In such a case, enclose the childNodes of contents[0] into a <div>.\r
 254                 if ( contents.length == 1 && contents[0].equals( groupObj.root ) )\r
 255                 {\r
 256                         var divBlock = doc.createElement( 'div' );\r
 257                         contents[0].moveChildren && contents[0].moveChildren( divBlock );\r
 258                         contents[0].append( divBlock );\r
 259                         contents[0] = divBlock;\r
 260                 }\r
 261 \r
 262                 // Calculate the common parent node of all content blocks.\r
 263                 var commonParent = groupObj.contents[0].getParent();\r
 264                 for ( var i = 0 ; i < contents.length ; i++ )\r
 265                         commonParent = commonParent.getCommonAncestor( contents[i].getParent() );\r
 266 \r
 267                 // We want to insert things that are in the same tree level only, so calculate the contents again\r
 268                 // by expanding the selected blocks to the same tree level.\r
 269                 for ( i = 0 ; i < contents.length ; i++ )\r
 270                 {\r
 271                         var contentNode = contents[i],\r
 272                                 parentNode;\r
 273                         while ( ( parentNode = contentNode.getParent() ) )\r
 274                         {\r
 275                                 if ( parentNode.equals( commonParent ) )\r
 276                                 {\r
 277                                         listContents.push( contentNode );\r
 278                                         break;\r
 279                                 }\r
 280                                 contentNode = parentNode;\r
 281                         }\r
 282                 }\r
 283 \r
 284                 if ( listContents.length < 1 )\r
 285                         return;\r
 286 \r
 287                 // Insert the list to the DOM tree.\r
 288                 var insertAnchor = listContents[ listContents.length - 1 ].getNext(),\r
 289                         listNode = doc.createElement( this.type );\r
 290 \r
 291                 listsCreated.push( listNode );\r
 292                 while ( listContents.length )\r
 293                 {\r
 294                         var contentBlock = listContents.shift(),\r
 295                                 listItem = doc.createElement( 'li' );\r
 296 \r
 297                         // Preserve heading structure when converting to list item. (#5271)\r
 298                         if ( headerTagRegex.test( contentBlock.getName() ) )\r
 299                                 contentBlock.appendTo( listItem );\r
 300                         else\r
 301                         {\r
 302                                 contentBlock.copyAttributes( listItem );\r
 303                                 contentBlock.moveChildren( listItem );\r
 304                                 contentBlock.remove();\r
 305                         }\r
 306 \r
 307                         listItem.appendTo( listNode );\r
 308 \r
 309                         // Append a bogus BR to force the LI to render at full height\r
 310                         if ( !CKEDITOR.env.ie )\r
 311                                 listItem.appendBogus();\r
 312                 }\r
 313                 if ( insertAnchor )\r
 314                         listNode.insertBefore( insertAnchor );\r
 315                 else\r
 316                         listNode.appendTo( commonParent );\r
 317         }\r
 318 \r
 319         function removeList( editor, groupObj, database )\r
 320         {\r
 321                 // This is very much like the change list type operation.\r
 322                 // Except that we're changing the selected items' indent to -1 in the list array.\r
 323                 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),\r
 324                         selectedListItems = [];\r
 325 \r
 326                 for ( var i = 0 ; i < groupObj.contents.length ; i++ )\r
 327                 {\r
 328                         var itemNode = groupObj.contents[i];\r
 329                         itemNode = itemNode.getAscendant( 'li', true );\r
 330                         if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )\r
 331                                 continue;\r
 332                         selectedListItems.push( itemNode );\r
 333                         CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );\r
 334                 }\r
 335 \r
 336                 var lastListIndex = null;\r
 337                 for ( i = 0 ; i < selectedListItems.length ; i++ )\r
 338                 {\r
 339                         var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );\r
 340                         listArray[listIndex].indent = -1;\r
 341                         lastListIndex = listIndex;\r
 342                 }\r
 343 \r
 344                 // After cutting parts of the list out with indent=-1, we still have to maintain the array list\r
 345                 // model's nextItem.indent <= currentItem.indent + 1 invariant. Otherwise the array model of the\r
 346                 // list cannot be converted back to a real DOM list.\r
 347                 for ( i = lastListIndex + 1 ; i < listArray.length ; i++ )\r
 348                 {\r
 349                         if ( listArray[i].indent > listArray[i-1].indent + 1 )\r
 350                         {\r
 351                                 var indentOffset = listArray[i-1].indent + 1 - listArray[i].indent;\r
 352                                 var oldIndent = listArray[i].indent;\r
 353                                 while ( listArray[i] && listArray[i].indent >= oldIndent )\r
 354                                 {\r
 355                                         listArray[i].indent += indentOffset;\r
 356                                         i++;\r
 357                                 }\r
 358                                 i--;\r
 359                         }\r
 360                 }\r
 361 \r
 362                 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );\r
 363 \r
 364                 // Compensate <br> before/after the list node if the surrounds are non-blocks.(#3836)\r
 365                 var docFragment = newList.listNode, boundaryNode, siblingNode;\r
 366                 function compensateBrs( isStart )\r
 367                 {\r
 368                         if ( ( boundaryNode = docFragment[ isStart ? 'getFirst' : 'getLast' ]() )\r
 369                                  && !( boundaryNode.is && boundaryNode.isBlockBoundary() )\r
 370                                  && ( siblingNode = groupObj.root[ isStart ? 'getPrevious' : 'getNext' ]\r
 371                                       ( CKEDITOR.dom.walker.whitespaces( true ) ) )\r
 372                                  && !( siblingNode.is && siblingNode.isBlockBoundary( { br : 1 } ) ) )\r
 373                                 editor.document.createElement( 'br' )[ isStart ? 'insertBefore' : 'insertAfter' ]( boundaryNode );\r
 374                 }\r
 375                 compensateBrs( true );\r
 376                 compensateBrs();\r
 377 \r
 378                 docFragment.replace( groupObj.root );\r
 379         }\r
 380 \r
 381         function listCommand( name, type )\r
 382         {\r
 383                 this.name = name;\r
 384                 this.type = type;\r
 385         }\r
 386 \r
 387         listCommand.prototype = {\r
 388                 exec : function( editor )\r
 389                 {\r
 390                         editor.focus();\r
 391 \r
 392                         var doc = editor.document,\r
 393                                 selection = editor.getSelection(),\r
 394                                 ranges = selection && selection.getRanges();\r
 395 \r
 396                         // There should be at least one selected range.\r
 397                         if ( !ranges || ranges.length < 1 )\r
 398                                 return;\r
 399 \r
 400                         // Midas lists rule #1 says we can create a list even in an empty document.\r
 401                         // But DOM iterator wouldn't run if the document is really empty.\r
 402                         // So create a paragraph if the document is empty and we're going to create a list.\r
 403                         if ( this.state == CKEDITOR.TRISTATE_OFF )\r
 404                         {\r
 405                                 var body = doc.getBody();\r
 406                                 body.trim();\r
 407                                 if ( !body.getFirst() )\r
 408                                 {\r
 409                                         var paragraph = doc.createElement( editor.config.enterMode == CKEDITOR.ENTER_P ? 'p' :\r
 410                                                         ( editor.config.enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'br' ) );\r
 411                                         paragraph.appendTo( body );\r
 412                                         ranges = [ new CKEDITOR.dom.range( doc ) ];\r
 413                                         // IE exception on inserting anything when anchor inside <br>.\r
 414                                         if ( paragraph.is( 'br' ) )\r
 415                                         {\r
 416                                                 ranges[ 0 ].setStartBefore( paragraph );\r
 417                                                 ranges[ 0 ].setEndAfter( paragraph );\r
 418                                         }\r
 419                                         else\r
 420                                                 ranges[ 0 ].selectNodeContents( paragraph );\r
 421                                         selection.selectRanges( ranges );\r
 422                                 }\r
 423                                 // Maybe a single range there enclosing the whole list,\r
 424                                 // turn on the list state manually(#4129).\r
 425                                 else\r
 426                                 {\r
 427                                         var range = ranges.length == 1 && ranges[ 0 ],\r
 428                                                 enclosedNode = range && range.getEnclosedNode();\r
 429                                         if ( enclosedNode && enclosedNode.is\r
 430                                                 && this.type == enclosedNode.getName() )\r
 431                                         {\r
 432                                                 setState.call( this, editor, CKEDITOR.TRISTATE_ON );\r
 433                                         }\r
 434                                 }\r
 435                         }\r
 436 \r
 437                         var bookmarks = selection.createBookmarks( true );\r
 438 \r
 439                         // Group the blocks up because there are many cases where multiple lists have to be created,\r
 440                         // or multiple lists have to be cancelled.\r
 441                         var listGroups = [],\r
 442                                 database = {};\r
 443 \r
 444                         while ( ranges.length > 0 )\r
 445                         {\r
 446                                 range = ranges.shift();\r
 447                                 var iterator = range.createIterator(),\r
 448                                         block;\r
 449 \r
 450                                 iterator.forceBrBreak = ( this.state == CKEDITOR.TRISTATE_OFF );\r
 451 \r
 452                                 while ( ( block = iterator.getNextParagraph() ) )\r
 453                                 {\r
 454                                         var path = new CKEDITOR.dom.elementPath( block ),\r
 455                                                 pathElements = path.elements,\r
 456                                                 pathElementsCount = pathElements.length,\r
 457                                                 listNode = null,\r
 458                                                 processedFlag = false,\r
 459                                                 blockLimit = path.blockLimit,\r
 460                                                 element;\r
 461 \r
 462                                         // First, try to group by a list ancestor.\r
 463                                         for ( var i = pathElementsCount - 1; i >= 0 && ( element = pathElements[ i ] ); i-- )\r
 464                                         {\r
 465                                                 if ( listNodeNames[ element.getName() ]\r
 466                                                          && blockLimit.contains( element ) )     // Don't leak outside block limit (#3940).\r
 467                                                 {\r
 468                                                         // If we've encountered a list inside a block limit\r
 469                                                         // The last group object of the block limit element should\r
 470                                                         // no longer be valid. Since paragraphs after the list\r
 471                                                         // should belong to a different group of paragraphs before\r
 472                                                         // the list. (Bug #1309)\r
 473                                                         blockLimit.removeCustomData( 'list_group_object' );\r
 474 \r
 475                                                         var groupObj = element.getCustomData( 'list_group_object' );\r
 476                                                         if ( groupObj )\r
 477                                                                 groupObj.contents.push( block );\r
 478                                                         else\r
 479                                                         {\r
 480                                                                 groupObj = { root : element, contents : [ block ] };\r
 481                                                                 listGroups.push( groupObj );\r
 482                                                                 CKEDITOR.dom.element.setMarker( database, element, 'list_group_object', groupObj );\r
 483                                                         }\r
 484                                                         processedFlag = true;\r
 485                                                         break;\r
 486                                                 }\r
 487                                         }\r
 488 \r
 489                                         if ( processedFlag )\r
 490                                                 continue;\r
 491 \r
 492                                         // No list ancestor? Group by block limit.\r
 493                                         var root = blockLimit;\r
 494                                         if ( root.getCustomData( 'list_group_object' ) )\r
 495                                                 root.getCustomData( 'list_group_object' ).contents.push( block );\r
 496                                         else\r
 497                                         {\r
 498                                                 groupObj = { root : root, contents : [ block ] };\r
 499                                                 CKEDITOR.dom.element.setMarker( database, root, 'list_group_object', groupObj );\r
 500                                                 listGroups.push( groupObj );\r
 501                                         }\r
 502                                 }\r
 503                         }\r
 504 \r
 505                         // Now we have two kinds of list groups, groups rooted at a list, and groups rooted at a block limit element.\r
 506                         // We either have to build lists or remove lists, for removing a list does not makes sense when we are looking\r
 507                         // at the group that's not rooted at lists. So we have three cases to handle.\r
 508                         var listsCreated = [];\r
 509                         while ( listGroups.length > 0 )\r
 510                         {\r
 511                                 groupObj = listGroups.shift();\r
 512                                 if ( this.state == CKEDITOR.TRISTATE_OFF )\r
 513                                 {\r
 514                                         if ( listNodeNames[ groupObj.root.getName() ] )\r
 515                                                 changeListType.call( this, editor, groupObj, database, listsCreated );\r
 516                                         else\r
 517                                                 createList.call( this, editor, groupObj, listsCreated );\r
 518                                 }\r
 519                                 else if ( this.state == CKEDITOR.TRISTATE_ON && listNodeNames[ groupObj.root.getName() ] )\r
 520                                         removeList.call( this, editor, groupObj, database );\r
 521                         }\r
 522 \r
 523                         // For all new lists created, merge adjacent, same type lists.\r
 524                         for ( i = 0 ; i < listsCreated.length ; i++ )\r
 525                         {\r
 526                                 listNode = listsCreated[i];\r
 527                                 var mergeSibling, listCommand = this;\r
 528                                 ( mergeSibling = function( rtl ){\r
 529 \r
 530                                         var sibling = listNode[ rtl ?\r
 531                                                 'getPrevious' : 'getNext' ]( CKEDITOR.dom.walker.whitespaces( true ) );\r
 532                                         if ( sibling && sibling.getName &&\r
 533                                              sibling.getName() == listCommand.type )\r
 534                                         {\r
 535                                                 sibling.remove();\r
 536                                                 // Move children order by merge direction.(#3820)\r
 537                                                 sibling.moveChildren( listNode, rtl ? true : false );\r
 538                                         }\r
 539                                 } )();\r
 540                                 mergeSibling( true );\r
 541                         }\r
 542 \r
 543                         // Clean up, restore selection and update toolbar button states.\r
 544                         CKEDITOR.dom.element.clearAllMarkers( database );\r
 545                         selection.selectBookmarks( bookmarks );\r
 546                         editor.focus();\r
 547                 }\r
 548         };\r
 549 \r
 550         var dtd = CKEDITOR.dtd;\r
 551         var tailNbspRegex = /[\t\r\n ]*(?:&nbsp;|\xa0)$/;\r
 552 \r
 553         function indexOfFirstChildElement( element, tagNameList )\r
 554         {\r
 555                 var child,\r
 556                         children = element.children,\r
 557                         length = children.length;\r
 558 \r
 559                 for ( var i = 0 ; i < length ; i++ )\r
 560                 {\r
 561                         child = children[ i ];\r
 562                         if ( child.name && ( child.name in tagNameList ) )\r
 563                                 return i;\r
 564                 }\r
 565 \r
 566                 return length;\r
 567         }\r
 568 \r
 569         function getExtendNestedListFilter( isHtmlFilter )\r
 570         {\r
 571                 // An element filter function that corrects nested list start in an empty\r
 572                 // list item for better displaying/outputting. (#3165)\r
 573                 return function( listItem )\r
 574                 {\r
 575                         var children = listItem.children,\r
 576                                 firstNestedListIndex = indexOfFirstChildElement( listItem, dtd.$list ),\r
 577                                 firstNestedList = children[ firstNestedListIndex ],\r
 578                                 nodeBefore = firstNestedList && firstNestedList.previous,\r
 579                                 tailNbspmatch;\r
 580 \r
 581                         if ( nodeBefore\r
 582                                 && ( nodeBefore.name && nodeBefore.name == 'br'\r
 583                                         || nodeBefore.value && ( tailNbspmatch = nodeBefore.value.match( tailNbspRegex ) ) ) )\r
 584                         {\r
 585                                 var fillerNode = nodeBefore;\r
 586 \r
 587                                 // Always use 'nbsp' as filler node if we found a nested list appear\r
 588                                 // in front of a list item.\r
 589                                 if ( !( tailNbspmatch && tailNbspmatch.index ) && fillerNode == children[ 0 ] )\r
 590                                         children[ 0 ] = ( isHtmlFilter || CKEDITOR.env.ie ) ?\r
 591                                                          new CKEDITOR.htmlParser.text( '\xa0' ) :\r
 592                                                                          new CKEDITOR.htmlParser.element( 'br', {} );\r
 593 \r
 594                                 // Otherwise the filler is not needed anymore.\r
 595                                 else if ( fillerNode.name == 'br' )\r
 596                                         children.splice( firstNestedListIndex - 1, 1 );\r
 597                                 else\r
 598                                         fillerNode.value = fillerNode.value.replace( tailNbspRegex, '' );\r
 599                         }\r
 600 \r
 601                 };\r
 602         }\r
 603 \r
 604         var defaultListDataFilterRules = { elements : {} };\r
 605         for ( var i in dtd.$listItem )\r
 606                 defaultListDataFilterRules.elements[ i ] = getExtendNestedListFilter();\r
 607 \r
 608         var defaultListHtmlFilterRules = { elements : {} };\r
 609         for ( i in dtd.$listItem )\r
 610                 defaultListHtmlFilterRules.elements[ i ] = getExtendNestedListFilter( true );\r
 611 \r
 612         CKEDITOR.plugins.add( 'list',\r
 613         {\r
 614                 init : function( editor )\r
 615                 {\r
 616                         // Register commands.\r
 617                         var numberedListCommand = new listCommand( 'numberedlist', 'ol' ),\r
 618                                 bulletedListCommand = new listCommand( 'bulletedlist', 'ul' );\r
 619                         editor.addCommand( 'numberedlist', numberedListCommand );\r
 620                         editor.addCommand( 'bulletedlist', bulletedListCommand );\r
 621 \r
 622                         // Register the toolbar button.\r
 623                         editor.ui.addButton( 'NumberedList',\r
 624                                 {\r
 625                                         label : editor.lang.numberedlist,\r
 626                                         command : 'numberedlist'\r
 627                                 } );\r
 628                         editor.ui.addButton( 'BulletedList',\r
 629                                 {\r
 630                                         label : editor.lang.bulletedlist,\r
 631                                         command : 'bulletedlist'\r
 632                                 } );\r
 633 \r
 634                         // Register the state changing handlers.\r
 635                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, numberedListCommand ) );\r
 636                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, bulletedListCommand ) );\r
 637                 },\r
 638 \r
 639                 afterInit : function ( editor )\r
 640                 {\r
 641                         var dataProcessor = editor.dataProcessor;\r
 642                         if ( dataProcessor )\r
 643                         {\r
 644                                 dataProcessor.dataFilter.addRules( defaultListDataFilterRules );\r
 645                                 dataProcessor.htmlFilter.addRules( defaultListHtmlFilterRules );\r
 646                         }\r
 647                 },\r
 648 \r
 649                 requires : [ 'domiterator' ]\r
 650         } );\r
 651 })();\r