_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, dir )\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 ( 1 )\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, 1 );\r
  91                                                 retval.append( rootNode );\r
  92                                         }\r
  93                                         currentListItem = rootNode.append( item.element.clone( 0, 1 ) );\r
  94                                         for ( var i = 0 ; i < item.contents.length ; i++ )\r
  95                                                 currentListItem.append( item.contents[i].clone( 1, 1 ) );\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.\r
 112                                                 if ( dir || item.element.hasAttributes() ||\r
 113                                                         ( paragraphMode != CKEDITOR.ENTER_BR && item.grandparent.getName() != 'td' ) )\r
 114                                                 {\r
 115                                                         currentListItem = doc.createElement( paragraphName );\r
 116                                                         item.element.copyAttributes( currentListItem, { type:1, value:1 } );\r
 117                                                         dir && currentListItem.setAttribute( 'dir', dir );\r
 118 \r
 119                                                         // There might be a case where there are no attributes in the element after all\r
 120                                                         // (i.e. when "type" or "value" are the only attributes set). In this case, if enterMode = BR,\r
 121                                                         // the current item should be a fragment.\r
 122                                                         if ( !dir && paragraphMode == CKEDITOR.ENTER_BR && !currentListItem.hasAttributes() )\r
 123                                                                 currentListItem = new CKEDITOR.dom.documentFragment( doc );\r
 124                                                 }\r
 125                                                 else\r
 126                                                         currentListItem = new CKEDITOR.dom.documentFragment( doc );\r
 127                                         }\r
 128 \r
 129                                         for ( i = 0 ; i < item.contents.length ; i++ )\r
 130                                                 currentListItem.append( item.contents[i].clone( 1, 1 ) );\r
 131 \r
 132                                         if ( currentListItem.type == CKEDITOR.NODE_DOCUMENT_FRAGMENT\r
 133                                                  && currentIndex != listArray.length - 1 )\r
 134                                         {\r
 135                                                 if ( currentListItem.getLast()\r
 136                                                                 && currentListItem.getLast().type == CKEDITOR.NODE_ELEMENT\r
 137                                                                 && currentListItem.getLast().getAttribute( 'type' ) == '_moz' )\r
 138                                                         currentListItem.getLast().remove();\r
 139                                                 currentListItem.appendBogus();\r
 140                                         }\r
 141 \r
 142                                         if ( currentListItem.type == CKEDITOR.NODE_ELEMENT &&\r
 143                                                         currentListItem.getName() == paragraphName &&\r
 144                                                         currentListItem.$.firstChild )\r
 145                                         {\r
 146                                                 currentListItem.trim();\r
 147                                                 var firstChild = currentListItem.getFirst();\r
 148                                                 if ( firstChild.type == CKEDITOR.NODE_ELEMENT && firstChild.isBlockBoundary() )\r
 149                                                 {\r
 150                                                         var tmp = new CKEDITOR.dom.documentFragment( doc );\r
 151                                                         currentListItem.moveChildren( tmp );\r
 152                                                         currentListItem = tmp;\r
 153                                                 }\r
 154                                         }\r
 155 \r
 156                                         var currentListItemName = currentListItem.$.nodeName.toLowerCase();\r
 157                                         if ( !CKEDITOR.env.ie && ( currentListItemName == 'div' || currentListItemName == 'p' ) )\r
 158                                                 currentListItem.appendBogus();\r
 159                                         retval.append( currentListItem );\r
 160                                         rootNode = null;\r
 161                                         currentIndex++;\r
 162                                 }\r
 163                                 else\r
 164                                         return null;\r
 165 \r
 166                                 if ( listArray.length <= currentIndex || Math.max( listArray[ currentIndex ].indent, 0 ) < indentLevel )\r
 167                                         break;\r
 168                         }\r
 169 \r
 170                         // Clear marker attributes for the new list tree made of cloned nodes, if any.\r
 171                         if ( database )\r
 172                         {\r
 173                                 var currentNode = retval.getFirst();\r
 174                                 while ( currentNode )\r
 175                                 {\r
 176                                         if ( currentNode.type == CKEDITOR.NODE_ELEMENT )\r
 177                                                 CKEDITOR.dom.element.clearMarkers( database, currentNode );\r
 178                                         currentNode = currentNode.getNextSourceNode();\r
 179                                 }\r
 180                         }\r
 181 \r
 182                         return { listNode : retval, nextIndex : currentIndex };\r
 183                 }\r
 184         };\r
 185 \r
 186         function setState( editor, state )\r
 187         {\r
 188                 editor.getCommand( this.name ).setState( state );\r
 189         }\r
 190 \r
 191         function onSelectionChange( evt )\r
 192         {\r
 193                 var path = evt.data.path,\r
 194                         blockLimit = path.blockLimit,\r
 195                         elements = path.elements,\r
 196                         element;\r
 197 \r
 198                 // Grouping should only happen under blockLimit.(#3940).\r
 199                 for ( var i = 0 ; i < elements.length && ( element = elements[ i ] )\r
 200                           && !element.equals( blockLimit ); i++ )\r
 201                 {\r
 202                         if ( listNodeNames[ elements[i].getName() ] )\r
 203                         {\r
 204                                 return setState.call( this, evt.editor,\r
 205                                                 this.type == elements[i].getName() ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );\r
 206                         }\r
 207                 }\r
 208 \r
 209                 return setState.call( this, evt.editor, CKEDITOR.TRISTATE_OFF );\r
 210         }\r
 211 \r
 212         function changeListType( editor, groupObj, database, listsCreated )\r
 213         {\r
 214                 // This case is easy...\r
 215                 // 1. Convert the whole list into a one-dimensional array.\r
 216                 // 2. Change the list type by modifying the array.\r
 217                 // 3. Recreate the whole list by converting the array to a list.\r
 218                 // 4. Replace the original list with the recreated list.\r
 219                 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),\r
 220                         selectedListItems = [];\r
 221 \r
 222                 for ( var i = 0 ; i < groupObj.contents.length ; i++ )\r
 223                 {\r
 224                         var itemNode = groupObj.contents[i];\r
 225                         itemNode = itemNode.getAscendant( 'li', true );\r
 226                         if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )\r
 227                                 continue;\r
 228                         selectedListItems.push( itemNode );\r
 229                         CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );\r
 230                 }\r
 231 \r
 232                 var root = groupObj.root,\r
 233                         fakeParent = root.getDocument().createElement( this.type );\r
 234                 // Copy all attributes, except from 'start' and 'type'.\r
 235                 root.copyAttributes( fakeParent, { start : 1, type : 1 } );\r
 236                 // The list-style-type property should be ignored.\r
 237                 fakeParent.removeStyle( 'list-style-type' );\r
 238 \r
 239                 for ( i = 0 ; i < selectedListItems.length ; i++ )\r
 240                 {\r
 241                         var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );\r
 242                         listArray[listIndex].parent = fakeParent;\r
 243                 }\r
 244                 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );\r
 245                 var child, length = newList.listNode.getChildCount();\r
 246                 for ( i = 0 ; i < length && ( child = newList.listNode.getChild( i ) ) ; i++ )\r
 247                 {\r
 248                         if ( child.getName() == this.type )\r
 249                                 listsCreated.push( child );\r
 250                 }\r
 251                 newList.listNode.replace( groupObj.root );\r
 252         }\r
 253 \r
 254         var headerTagRegex = /^h[1-6]$/;\r
 255 \r
 256         function createList( editor, groupObj, listsCreated )\r
 257         {\r
 258                 var contents = groupObj.contents,\r
 259                         doc = groupObj.root.getDocument(),\r
 260                         listContents = [];\r
 261 \r
 262                 // It is possible to have the contents returned by DomRangeIterator to be the same as the root.\r
 263                 // e.g. when we're running into table cells.\r
 264                 // In such a case, enclose the childNodes of contents[0] into a <div>.\r
 265                 if ( contents.length == 1 && contents[0].equals( groupObj.root ) )\r
 266                 {\r
 267                         var divBlock = doc.createElement( 'div' );\r
 268                         contents[0].moveChildren && contents[0].moveChildren( divBlock );\r
 269                         contents[0].append( divBlock );\r
 270                         contents[0] = divBlock;\r
 271                 }\r
 272 \r
 273                 // Calculate the common parent node of all content blocks.\r
 274                 var commonParent = groupObj.contents[0].getParent();\r
 275                 for ( var i = 0 ; i < contents.length ; i++ )\r
 276                         commonParent = commonParent.getCommonAncestor( contents[i].getParent() );\r
 277 \r
 278                 var useComputedState = editor.config.useComputedState,\r
 279                         listDir, explicitDirection;\r
 280 \r
 281                 useComputedState = useComputedState === undefined || useComputedState;\r
 282 \r
 283                 // We want to insert things that are in the same tree level only, so calculate the contents again\r
 284                 // by expanding the selected blocks to the same tree level.\r
 285                 for ( i = 0 ; i < contents.length ; i++ )\r
 286                 {\r
 287                         var contentNode = contents[i],\r
 288                                 parentNode;\r
 289                         while ( ( parentNode = contentNode.getParent() ) )\r
 290                         {\r
 291                                 if ( parentNode.equals( commonParent ) )\r
 292                                 {\r
 293                                         listContents.push( contentNode );\r
 294 \r
 295                                         // Determine the lists's direction.\r
 296                                         if ( !explicitDirection && contentNode.getDirection() )\r
 297                                                 explicitDirection = 1;\r
 298 \r
 299                                         var itemDir = contentNode.getDirection( useComputedState );\r
 300 \r
 301                                         if ( listDir !== null )\r
 302                                         {\r
 303                                                 // If at least one LI have a different direction than current listDir, we can't have listDir.\r
 304                                                 if ( listDir && listDir != itemDir )\r
 305                                                         listDir = null;\r
 306                                                 else\r
 307                                                         listDir = itemDir;\r
 308                                         }\r
 309 \r
 310                                         break;\r
 311                                 }\r
 312                                 contentNode = parentNode;\r
 313                         }\r
 314                 }\r
 315 \r
 316                 if ( listContents.length < 1 )\r
 317                         return;\r
 318 \r
 319                 // Insert the list to the DOM tree.\r
 320                 var insertAnchor = listContents[ listContents.length - 1 ].getNext(),\r
 321                         listNode = doc.createElement( this.type );\r
 322 \r
 323                 listsCreated.push( listNode );\r
 324 \r
 325                 var contentBlock, listItem;\r
 326 \r
 327                 while ( listContents.length )\r
 328                 {\r
 329                         contentBlock = listContents.shift();\r
 330                         listItem = doc.createElement( 'li' );\r
 331 \r
 332                         // Preserve preformat block and heading structure when converting to list item. (#5335) (#5271)\r
 333                         if ( contentBlock.is( 'pre' ) || headerTagRegex.test( contentBlock.getName() ) )\r
 334                                 contentBlock.appendTo( listItem );\r
 335                         else\r
 336                         {\r
 337                                 // Remove DIR attribute if it was merged into list root.\r
 338                                 if ( listDir && contentBlock.getDirection() )\r
 339                                 {\r
 340                                         contentBlock.removeStyle( 'direction' );\r
 341                                         contentBlock.removeAttribute( 'dir' );\r
 342                                 }\r
 343 \r
 344                                 contentBlock.copyAttributes( listItem );\r
 345                                 contentBlock.moveChildren( listItem );\r
 346                                 contentBlock.remove();\r
 347                         }\r
 348 \r
 349                         listItem.appendTo( listNode );\r
 350                 }\r
 351 \r
 352                 // Apply list root dir only if it has been explicitly declared.\r
 353                 if ( listDir && explicitDirection )\r
 354                         listNode.setAttribute( 'dir', listDir );\r
 355 \r
 356                 if ( insertAnchor )\r
 357                         listNode.insertBefore( insertAnchor );\r
 358                 else\r
 359                         listNode.appendTo( commonParent );\r
 360         }\r
 361 \r
 362         function removeList( editor, groupObj, database )\r
 363         {\r
 364                 // This is very much like the change list type operation.\r
 365                 // Except that we're changing the selected items' indent to -1 in the list array.\r
 366                 var listArray = CKEDITOR.plugins.list.listToArray( groupObj.root, database ),\r
 367                         selectedListItems = [];\r
 368 \r
 369                 for ( var i = 0 ; i < groupObj.contents.length ; i++ )\r
 370                 {\r
 371                         var itemNode = groupObj.contents[i];\r
 372                         itemNode = itemNode.getAscendant( 'li', true );\r
 373                         if ( !itemNode || itemNode.getCustomData( 'list_item_processed' ) )\r
 374                                 continue;\r
 375                         selectedListItems.push( itemNode );\r
 376                         CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );\r
 377                 }\r
 378 \r
 379                 var lastListIndex = null;\r
 380                 for ( i = 0 ; i < selectedListItems.length ; i++ )\r
 381                 {\r
 382                         var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );\r
 383                         listArray[listIndex].indent = -1;\r
 384                         lastListIndex = listIndex;\r
 385                 }\r
 386 \r
 387                 // After cutting parts of the list out with indent=-1, we still have to maintain the array list\r
 388                 // model's nextItem.indent <= currentItem.indent + 1 invariant. Otherwise the array model of the\r
 389                 // list cannot be converted back to a real DOM list.\r
 390                 for ( i = lastListIndex + 1 ; i < listArray.length ; i++ )\r
 391                 {\r
 392                         if ( listArray[i].indent > listArray[i-1].indent + 1 )\r
 393                         {\r
 394                                 var indentOffset = listArray[i-1].indent + 1 - listArray[i].indent;\r
 395                                 var oldIndent = listArray[i].indent;\r
 396                                 while ( listArray[i] && listArray[i].indent >= oldIndent )\r
 397                                 {\r
 398                                         listArray[i].indent += indentOffset;\r
 399                                         i++;\r
 400                                 }\r
 401                                 i--;\r
 402                         }\r
 403                 }\r
 404 \r
 405                 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode,\r
 406                         groupObj.root.getAttribute( 'dir' ) );\r
 407 \r
 408                 // Compensate <br> before/after the list node if the surrounds are non-blocks.(#3836)\r
 409                 var docFragment = newList.listNode, boundaryNode, siblingNode;\r
 410                 function compensateBrs( isStart )\r
 411                 {\r
 412                         if ( ( boundaryNode = docFragment[ isStart ? 'getFirst' : 'getLast' ]() )\r
 413                                  && !( boundaryNode.is && boundaryNode.isBlockBoundary() )\r
 414                                  && ( siblingNode = groupObj.root[ isStart ? 'getPrevious' : 'getNext' ]\r
 415                                       ( CKEDITOR.dom.walker.whitespaces( true ) ) )\r
 416                                  && !( siblingNode.is && siblingNode.isBlockBoundary( { br : 1 } ) ) )\r
 417                                 editor.document.createElement( 'br' )[ isStart ? 'insertBefore' : 'insertAfter' ]( boundaryNode );\r
 418                 }\r
 419                 compensateBrs( true );\r
 420                 compensateBrs();\r
 421 \r
 422                 docFragment.replace( groupObj.root );\r
 423         }\r
 424 \r
 425         function listCommand( name, type )\r
 426         {\r
 427                 this.name = name;\r
 428                 this.type = type;\r
 429         }\r
 430 \r
 431         listCommand.prototype = {\r
 432                 exec : function( editor )\r
 433                 {\r
 434                         editor.focus();\r
 435 \r
 436                         var doc = editor.document,\r
 437                                 selection = editor.getSelection(),\r
 438                                 ranges = selection && selection.getRanges( true );\r
 439 \r
 440                         // There should be at least one selected range.\r
 441                         if ( !ranges || ranges.length < 1 )\r
 442                                 return;\r
 443 \r
 444                         // Midas lists rule #1 says we can create a list even in an empty document.\r
 445                         // But DOM iterator wouldn't run if the document is really empty.\r
 446                         // So create a paragraph if the document is empty and we're going to create a list.\r
 447                         if ( this.state == CKEDITOR.TRISTATE_OFF )\r
 448                         {\r
 449                                 var body = doc.getBody();\r
 450                                 body.trim();\r
 451                                 if ( !body.getFirst() )\r
 452                                 {\r
 453                                         var paragraph = doc.createElement( editor.config.enterMode == CKEDITOR.ENTER_P ? 'p' :\r
 454                                                         ( editor.config.enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'br' ) );\r
 455                                         paragraph.appendTo( body );\r
 456                                         ranges = new CKEDITOR.dom.rangeList( [ new CKEDITOR.dom.range( doc ) ] );\r
 457                                         // IE exception on inserting anything when anchor inside <br>.\r
 458                                         if ( paragraph.is( 'br' ) )\r
 459                                         {\r
 460                                                 ranges[ 0 ].setStartBefore( paragraph );\r
 461                                                 ranges[ 0 ].setEndAfter( paragraph );\r
 462                                         }\r
 463                                         else\r
 464                                                 ranges[ 0 ].selectNodeContents( paragraph );\r
 465                                         selection.selectRanges( ranges );\r
 466                                 }\r
 467                                 // Maybe a single range there enclosing the whole list,\r
 468                                 // turn on the list state manually(#4129).\r
 469                                 else\r
 470                                 {\r
 471                                         var range = ranges.length == 1 && ranges[ 0 ],\r
 472                                                 enclosedNode = range && range.getEnclosedNode();\r
 473                                         if ( enclosedNode && enclosedNode.is\r
 474                                                 && this.type == enclosedNode.getName() )\r
 475                                                         setState.call( this, editor, CKEDITOR.TRISTATE_ON );\r
 476                                 }\r
 477                         }\r
 478 \r
 479                         var bookmarks = selection.createBookmarks( true );\r
 480 \r
 481                         // Group the blocks up because there are many cases where multiple lists have to be created,\r
 482                         // or multiple lists have to be cancelled.\r
 483                         var listGroups = [],\r
 484                                 database = {},\r
 485                                 rangeIterator = ranges.createIterator(),\r
 486                                 index = 0;\r
 487 \r
 488                         while ( ( range = rangeIterator.getNextRange() ) && ++index )\r
 489                         {\r
 490                                 var boundaryNodes = range.getBoundaryNodes(),\r
 491                                         startNode = boundaryNodes.startNode,\r
 492                                         endNode = boundaryNodes.endNode;\r
 493 \r
 494                                 if ( startNode.type == CKEDITOR.NODE_ELEMENT && startNode.getName() == 'td' )\r
 495                                         range.setStartAt( boundaryNodes.startNode, CKEDITOR.POSITION_AFTER_START );\r
 496 \r
 497                                 if ( endNode.type == CKEDITOR.NODE_ELEMENT && endNode.getName() == 'td' )\r
 498                                         range.setEndAt( boundaryNodes.endNode, CKEDITOR.POSITION_BEFORE_END );\r
 499 \r
 500                                 var iterator = range.createIterator(),\r
 501                                         block;\r
 502 \r
 503                                 iterator.forceBrBreak = ( this.state == CKEDITOR.TRISTATE_OFF );\r
 504 \r
 505                                 while ( ( block = iterator.getNextParagraph() ) )\r
 506                                 {\r
 507                                         // Avoid duplicate blocks get processed across ranges.\r
 508                                         if( block.getCustomData( 'list_block' ) )\r
 509                                                 continue;\r
 510                                         else\r
 511                                                 CKEDITOR.dom.element.setMarker( database, block, 'list_block', 1 );\r
 512 \r
 513                                         var path = new CKEDITOR.dom.elementPath( block ),\r
 514                                                 pathElements = path.elements,\r
 515                                                 pathElementsCount = pathElements.length,\r
 516                                                 listNode = null,\r
 517                                                 processedFlag = 0,\r
 518                                                 blockLimit = path.blockLimit,\r
 519                                                 element;\r
 520 \r
 521                                         // First, try to group by a list ancestor.\r
 522                                         for ( var i = pathElementsCount - 1; i >= 0 && ( element = pathElements[ i ] ); i-- )\r
 523                                         {\r
 524                                                 if ( listNodeNames[ element.getName() ]\r
 525                                                          && blockLimit.contains( element ) )     // Don't leak outside block limit (#3940).\r
 526                                                 {\r
 527                                                         // If we've encountered a list inside a block limit\r
 528                                                         // The last group object of the block limit element should\r
 529                                                         // no longer be valid. Since paragraphs after the list\r
 530                                                         // should belong to a different group of paragraphs before\r
 531                                                         // the list. (Bug #1309)\r
 532                                                         blockLimit.removeCustomData( 'list_group_object_' + index );\r
 533 \r
 534                                                         var groupObj = element.getCustomData( 'list_group_object' );\r
 535                                                         if ( groupObj )\r
 536                                                                 groupObj.contents.push( block );\r
 537                                                         else\r
 538                                                         {\r
 539                                                                 groupObj = { root : element, contents : [ block ] };\r
 540                                                                 listGroups.push( groupObj );\r
 541                                                                 CKEDITOR.dom.element.setMarker( database, element, 'list_group_object', groupObj );\r
 542                                                         }\r
 543                                                         processedFlag = 1;\r
 544                                                         break;\r
 545                                                 }\r
 546                                         }\r
 547 \r
 548                                         if ( processedFlag )\r
 549                                                 continue;\r
 550 \r
 551                                         // No list ancestor? Group by block limit, but don't mix contents from different ranges.\r
 552                                         var root = blockLimit;\r
 553                                         if ( root.getCustomData( 'list_group_object_' + index ) )\r
 554                                                 root.getCustomData( 'list_group_object_' + index ).contents.push( block );\r
 555                                         else\r
 556                                         {\r
 557                                                 groupObj = { root : root, contents : [ block ] };\r
 558                                                 CKEDITOR.dom.element.setMarker( database, root, 'list_group_object_' + index, groupObj );\r
 559                                                 listGroups.push( groupObj );\r
 560                                         }\r
 561                                 }\r
 562                         }\r
 563 \r
 564                         // Now we have two kinds of list groups, groups rooted at a list, and groups rooted at a block limit element.\r
 565                         // We either have to build lists or remove lists, for removing a list does not makes sense when we are looking\r
 566                         // at the group that's not rooted at lists. So we have three cases to handle.\r
 567                         var listsCreated = [];\r
 568                         while ( listGroups.length > 0 )\r
 569                         {\r
 570                                 groupObj = listGroups.shift();\r
 571                                 if ( this.state == CKEDITOR.TRISTATE_OFF )\r
 572                                 {\r
 573                                         if ( listNodeNames[ groupObj.root.getName() ] )\r
 574                                                 changeListType.call( this, editor, groupObj, database, listsCreated );\r
 575                                         else\r
 576                                                 createList.call( this, editor, groupObj, listsCreated );\r
 577                                 }\r
 578                                 else if ( this.state == CKEDITOR.TRISTATE_ON && listNodeNames[ groupObj.root.getName() ] )\r
 579                                         removeList.call( this, editor, groupObj, database );\r
 580                         }\r
 581 \r
 582                         // For all new lists created, merge adjacent, same type lists.\r
 583                         for ( i = 0 ; i < listsCreated.length ; i++ )\r
 584                         {\r
 585                                 listNode = listsCreated[i];\r
 586                                 var mergeSibling, listCommand = this;\r
 587                                 ( mergeSibling = function( rtl ){\r
 588 \r
 589                                         var sibling = listNode[ rtl ?\r
 590                                                 'getPrevious' : 'getNext' ]( CKEDITOR.dom.walker.whitespaces( true ) );\r
 591                                         if ( sibling && sibling.getName &&\r
 592                                                  sibling.getName() == listCommand.type )\r
 593                                         {\r
 594                                                 sibling.remove();\r
 595                                                 // Move children order by merge direction.(#3820)\r
 596                                                 sibling.moveChildren( listNode, rtl );\r
 597                                         }\r
 598                                 } )();\r
 599                                 mergeSibling( 1 );\r
 600                         }\r
 601 \r
 602                         // Clean up, restore selection and update toolbar button states.\r
 603                         CKEDITOR.dom.element.clearAllMarkers( database );\r
 604                         selection.selectBookmarks( bookmarks );\r
 605                         editor.focus();\r
 606                 }\r
 607         };\r
 608 \r
 609         var dtd = CKEDITOR.dtd;\r
 610         var tailNbspRegex = /[\t\r\n ]*(?:&nbsp;|\xa0)$/;\r
 611 \r
 612         function indexOfFirstChildElement( element, tagNameList )\r
 613         {\r
 614                 var child,\r
 615                         children = element.children,\r
 616                         length = children.length;\r
 617 \r
 618                 for ( var i = 0 ; i < length ; i++ )\r
 619                 {\r
 620                         child = children[ i ];\r
 621                         if ( child.name && ( child.name in tagNameList ) )\r
 622                                 return i;\r
 623                 }\r
 624 \r
 625                 return length;\r
 626         }\r
 627 \r
 628         function getExtendNestedListFilter( isHtmlFilter )\r
 629         {\r
 630                 // An element filter function that corrects nested list start in an empty\r
 631                 // list item for better displaying/outputting. (#3165)\r
 632                 return function( listItem )\r
 633                 {\r
 634                         var children = listItem.children,\r
 635                                 firstNestedListIndex = indexOfFirstChildElement( listItem, dtd.$list ),\r
 636                                 firstNestedList = children[ firstNestedListIndex ],\r
 637                                 nodeBefore = firstNestedList && firstNestedList.previous,\r
 638                                 tailNbspmatch;\r
 639 \r
 640                         if ( nodeBefore\r
 641                                 && ( nodeBefore.name && nodeBefore.name == 'br'\r
 642                                         || nodeBefore.value && ( tailNbspmatch = nodeBefore.value.match( tailNbspRegex ) ) ) )\r
 643                         {\r
 644                                 var fillerNode = nodeBefore;\r
 645 \r
 646                                 // Always use 'nbsp' as filler node if we found a nested list appear\r
 647                                 // in front of a list item.\r
 648                                 if ( !( tailNbspmatch && tailNbspmatch.index ) && fillerNode == children[ 0 ] )\r
 649                                         children[ 0 ] = ( isHtmlFilter || CKEDITOR.env.ie ) ?\r
 650                                                          new CKEDITOR.htmlParser.text( '\xa0' ) :\r
 651                                                                          new CKEDITOR.htmlParser.element( 'br', {} );\r
 652 \r
 653                                 // Otherwise the filler is not needed anymore.\r
 654                                 else if ( fillerNode.name == 'br' )\r
 655                                         children.splice( firstNestedListIndex - 1, 1 );\r
 656                                 else\r
 657                                         fillerNode.value = fillerNode.value.replace( tailNbspRegex, '' );\r
 658                         }\r
 659 \r
 660                 };\r
 661         }\r
 662 \r
 663         var defaultListDataFilterRules = { elements : {} };\r
 664         for ( var i in dtd.$listItem )\r
 665                 defaultListDataFilterRules.elements[ i ] = getExtendNestedListFilter();\r
 666 \r
 667         var defaultListHtmlFilterRules = { elements : {} };\r
 668         for ( i in dtd.$listItem )\r
 669                 defaultListHtmlFilterRules.elements[ i ] = getExtendNestedListFilter( true );\r
 670 \r
 671         CKEDITOR.plugins.add( 'list',\r
 672         {\r
 673                 init : function( editor )\r
 674                 {\r
 675                         // Register commands.\r
 676                         var numberedListCommand = new listCommand( 'numberedlist', 'ol' ),\r
 677                                 bulletedListCommand = new listCommand( 'bulletedlist', 'ul' );\r
 678                         editor.addCommand( 'numberedlist', numberedListCommand );\r
 679                         editor.addCommand( 'bulletedlist', bulletedListCommand );\r
 680 \r
 681                         // Register the toolbar button.\r
 682                         editor.ui.addButton( 'NumberedList',\r
 683                                 {\r
 684                                         label : editor.lang.numberedlist,\r
 685                                         command : 'numberedlist'\r
 686                                 } );\r
 687                         editor.ui.addButton( 'BulletedList',\r
 688                                 {\r
 689                                         label : editor.lang.bulletedlist,\r
 690                                         command : 'bulletedlist'\r
 691                                 } );\r
 692 \r
 693                         // Register the state changing handlers.\r
 694                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, numberedListCommand ) );\r
 695                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, bulletedListCommand ) );\r
 696                 },\r
 697 \r
 698                 afterInit : function ( editor )\r
 699                 {\r
 700                         var dataProcessor = editor.dataProcessor;\r
 701                         if ( dataProcessor )\r
 702                         {\r
 703                                 dataProcessor.dataFilter.addRules( defaultListDataFilterRules );\r
 704                                 dataProcessor.htmlFilter.addRules( defaultListHtmlFilterRules );\r
 705                         }\r
 706                 },\r
 707 \r
 708                 requires : [ 'domiterator' ]\r
 709         } );\r
 710 })();\r