_source/plugins/list/plugin.js

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