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