JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.4.2
[ckeditor.git] / _source / plugins / list / plugin.js
index 3898f2a..0b61c2d 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -29,7 +29,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        if ( !baseArray )\r
                                baseArray = [];\r
 \r
-                       // Iterate over all list items to get their contents and look for inner lists.\r
+                       // Iterate over all list items to and look for inner lists.\r
                        for ( var i = 0, count = listNode.getChildCount() ; i < count ; i++ )\r
                        {\r
                                var listItem = listNode.getChild( i );\r
@@ -37,7 +37,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                // It may be a text node or some funny stuff.\r
                                if ( listItem.$.nodeName.toLowerCase() != 'li' )\r
                                        continue;\r
-                               var itemObj = { 'parent' : listNode, indent : baseIndentLevel, contents : [] };\r
+\r
+                               var itemObj = { 'parent' : listNode, indent : baseIndentLevel, element : listItem, contents : [] };\r
                                if ( !grandparentNode )\r
                                {\r
                                        itemObj.grandparent = listNode.getParent();\r
@@ -51,9 +52,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                        CKEDITOR.dom.element.setMarker( database, listItem, 'listarray_index', baseArray.length );\r
                                baseArray.push( itemObj );\r
 \r
-                               for ( var j = 0, itemChildCount = listItem.getChildCount() ; j < itemChildCount ; j++ )\r
+                               for ( var j = 0, itemChildCount = listItem.getChildCount(), child; j < itemChildCount ; j++ )\r
                                {\r
-                                       var child = listItem.getChild( j );\r
+                                       child = listItem.getChild( j );\r
                                        if ( child.type == CKEDITOR.NODE_ELEMENT && listNodeNames[ child.getName() ] )\r
                                                // Note the recursion here, it pushes inner list items with\r
                                                // +1 indentation in the correct order.\r
@@ -66,7 +67,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                },\r
 \r
                // Convert our internal representation of a list back to a DOM forest.\r
-               arrayToList : function( listArray, database, baseIndex, paragraphMode )\r
+               arrayToList : function( listArray, database, baseIndex, paragraphMode, dir )\r
                {\r
                        if ( !baseIndex )\r
                                baseIndex = 0;\r
@@ -79,19 +80,19 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                indentLevel = Math.max( listArray[ baseIndex ].indent, 0 ),\r
                                currentListItem = null,\r
                                paragraphName = ( paragraphMode == CKEDITOR.ENTER_P ? 'p' : 'div' );\r
-                       while ( true )\r
+                       while ( 1 )\r
                        {\r
                                var item = listArray[ currentIndex ];\r
                                if ( item.indent == indentLevel )\r
                                {\r
                                        if ( !rootNode || listArray[ currentIndex ].parent.getName() != rootNode.getName() )\r
                                        {\r
-                                               rootNode = listArray[ currentIndex ].parent.clone( false, true );\r
+                                               rootNode = listArray[ currentIndex ].parent.clone( false, 1 );\r
                                                retval.append( rootNode );\r
                                        }\r
-                                       currentListItem = rootNode.append( doc.createElement( 'li' ) );\r
+                                       currentListItem = rootNode.append( item.element.clone( 0, 1 ) );\r
                                        for ( var i = 0 ; i < item.contents.length ; i++ )\r
-                                               currentListItem.append( item.contents[i].clone( true, true ) );\r
+                                               currentListItem.append( item.contents[i].clone( 1, 1 ) );\r
                                        currentIndex++;\r
                                }\r
                                else if ( item.indent == Math.max( indentLevel, 0 ) + 1 )\r
@@ -104,17 +105,29 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                {\r
                                        currentListItem;\r
                                        if ( listNodeNames[ item.grandparent.getName() ] )\r
-                                               currentListItem = doc.createElement( 'li' );\r
+                                               currentListItem = item.element.clone( false, true );\r
                                        else\r
                                        {\r
-                                               if ( paragraphMode != CKEDITOR.ENTER_BR && item.grandparent.getName() != 'td' )\r
+                                               // Create completely new blocks here.\r
+                                               if ( dir || item.element.hasAttributes() ||\r
+                                                       ( paragraphMode != CKEDITOR.ENTER_BR && item.grandparent.getName() != 'td' ) )\r
+                                               {\r
                                                        currentListItem = doc.createElement( paragraphName );\r
+                                                       item.element.copyAttributes( currentListItem, { type:1, value:1 } );\r
+                                                       dir && currentListItem.setAttribute( 'dir', dir );\r
+\r
+                                                       // There might be a case where there are no attributes in the element after all\r
+                                                       // (i.e. when "type" or "value" are the only attributes set). In this case, if enterMode = BR,\r
+                                                       // the current item should be a fragment.\r
+                                                       if ( !dir && paragraphMode == CKEDITOR.ENTER_BR && !currentListItem.hasAttributes() )\r
+                                                               currentListItem = new CKEDITOR.dom.documentFragment( doc );\r
+                                               }\r
                                                else\r
                                                        currentListItem = new CKEDITOR.dom.documentFragment( doc );\r
                                        }\r
 \r
                                        for ( i = 0 ; i < item.contents.length ; i++ )\r
-                                               currentListItem.append( item.contents[i].clone( true, true ) );\r
+                                               currentListItem.append( item.contents[i].clone( 1, 1 ) );\r
 \r
                                        if ( currentListItem.type == CKEDITOR.NODE_DOCUMENT_FRAGMENT\r
                                                 && currentIndex != listArray.length - 1 )\r
@@ -216,7 +229,13 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        CKEDITOR.dom.element.setMarker( database, itemNode, 'list_item_processed', true );\r
                }\r
 \r
-               var fakeParent = groupObj.root.getDocument().createElement( this.type );\r
+               var root = groupObj.root,\r
+                       fakeParent = root.getDocument().createElement( this.type );\r
+               // Copy all attributes, except from 'start' and 'type'.\r
+               root.copyAttributes( fakeParent, { start : 1, type : 1 } );\r
+               // The list-style-type property should be ignored.\r
+               fakeParent.removeStyle( 'list-style-type' );\r
+\r
                for ( i = 0 ; i < selectedListItems.length ; i++ )\r
                {\r
                        var listIndex = selectedListItems[i].getCustomData( 'listarray_index' );\r
@@ -232,6 +251,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                newList.listNode.replace( groupObj.root );\r
        }\r
 \r
+       var headerTagRegex = /^h[1-6]$/;\r
+\r
        function createList( editor, groupObj, listsCreated )\r
        {\r
                var contents = groupObj.contents,\r
@@ -254,6 +275,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                for ( var i = 0 ; i < contents.length ; i++ )\r
                        commonParent = commonParent.getCommonAncestor( contents[i].getParent() );\r
 \r
+               var useComputedState = editor.config.useComputedState,\r
+                       listDir, explicitDirection;\r
+\r
+               useComputedState = useComputedState === undefined || useComputedState;\r
+\r
                // We want to insert things that are in the same tree level only, so calculate the contents again\r
                // by expanding the selected blocks to the same tree level.\r
                for ( i = 0 ; i < contents.length ; i++ )\r
@@ -265,6 +291,22 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                if ( parentNode.equals( commonParent ) )\r
                                {\r
                                        listContents.push( contentNode );\r
+\r
+                                       // Determine the lists's direction.\r
+                                       if ( !explicitDirection && contentNode.getDirection() )\r
+                                               explicitDirection = 1;\r
+\r
+                                       var itemDir = contentNode.getDirection( useComputedState );\r
+\r
+                                       if ( listDir !== null )\r
+                                       {\r
+                                               // If at least one LI have a different direction than current listDir, we can't have listDir.\r
+                                               if ( listDir && listDir != itemDir )\r
+                                                       listDir = null;\r
+                                               else\r
+                                                       listDir = itemDir;\r
+                                       }\r
+\r
                                        break;\r
                                }\r
                                contentNode = parentNode;\r
@@ -279,18 +321,38 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        listNode = doc.createElement( this.type );\r
 \r
                listsCreated.push( listNode );\r
+\r
+               var contentBlock, listItem;\r
+\r
                while ( listContents.length )\r
                {\r
-                       var contentBlock = listContents.shift(),\r
-                               listItem = doc.createElement( 'li' );\r
-                       contentBlock.moveChildren( listItem );\r
-                       contentBlock.remove();\r
-                       listItem.appendTo( listNode );\r
+                       contentBlock = listContents.shift();\r
+                       listItem = doc.createElement( 'li' );\r
 \r
-                       // Append a bogus BR to force the LI to render at full height\r
-                       if ( !CKEDITOR.env.ie )\r
-                               listItem.appendBogus();\r
+                       // Preserve preformat block and heading structure when converting to list item. (#5335) (#5271)\r
+                       if ( contentBlock.is( 'pre' ) || headerTagRegex.test( contentBlock.getName() ) )\r
+                               contentBlock.appendTo( listItem );\r
+                       else\r
+                       {\r
+                               // Remove DIR attribute if it was merged into list root.\r
+                               if ( listDir && contentBlock.getDirection() )\r
+                               {\r
+                                       contentBlock.removeStyle( 'direction' );\r
+                                       contentBlock.removeAttribute( 'dir' );\r
+                               }\r
+\r
+                               contentBlock.copyAttributes( listItem );\r
+                               contentBlock.moveChildren( listItem );\r
+                               contentBlock.remove();\r
+                       }\r
+\r
+                       listItem.appendTo( listNode );\r
                }\r
+\r
+               // Apply list root dir only if it has been explicitly declared.\r
+               if ( listDir && explicitDirection )\r
+                       listNode.setAttribute( 'dir', listDir );\r
+\r
                if ( insertAnchor )\r
                        listNode.insertBefore( insertAnchor );\r
                else\r
@@ -340,7 +402,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        }\r
                }\r
 \r
-               var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode );\r
+               var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode,\r
+                       groupObj.root.getAttribute( 'dir' ) );\r
 \r
                // Compensate <br> before/after the list node if the surrounds are non-blocks.(#3836)\r
                var docFragment = newList.listNode, boundaryNode, siblingNode;\r
@@ -372,7 +435,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
                        var doc = editor.document,\r
                                selection = editor.getSelection(),\r
-                               ranges = selection && selection.getRanges();\r
+                               ranges = selection && selection.getRanges( true );\r
 \r
                        // There should be at least one selected range.\r
                        if ( !ranges || ranges.length < 1 )\r
@@ -390,7 +453,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                        var paragraph = doc.createElement( editor.config.enterMode == CKEDITOR.ENTER_P ? 'p' :\r
                                                        ( editor.config.enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'br' ) );\r
                                        paragraph.appendTo( body );\r
-                                       ranges = [ new CKEDITOR.dom.range( doc ) ];\r
+                                       ranges = new CKEDITOR.dom.rangeList( [ new CKEDITOR.dom.range( doc ) ] );\r
                                        // IE exception on inserting anything when anchor inside <br>.\r
                                        if ( paragraph.is( 'br' ) )\r
                                        {\r
@@ -409,9 +472,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                                enclosedNode = range && range.getEnclosedNode();\r
                                        if ( enclosedNode && enclosedNode.is\r
                                                && this.type == enclosedNode.getName() )\r
-                                       {\r
-                                               setState.call( this, editor, CKEDITOR.TRISTATE_ON );\r
-                                       }\r
+                                                       setState.call( this, editor, CKEDITOR.TRISTATE_ON );\r
                                }\r
                        }\r
 \r
@@ -420,12 +481,12 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        // Group the blocks up because there are many cases where multiple lists have to be created,\r
                        // or multiple lists have to be cancelled.\r
                        var listGroups = [],\r
-                               database = {};\r
+                               database = {},\r
+                               rangeIterator = ranges.createIterator(),\r
+                               index = 0;\r
 \r
-                       while ( ranges.length > 0 )\r
+                       while ( ( range = rangeIterator.getNextRange() ) && ++index )\r
                        {\r
-                               range = ranges.shift();\r
-\r
                                var boundaryNodes = range.getBoundaryNodes(),\r
                                        startNode = boundaryNodes.startNode,\r
                                        endNode = boundaryNodes.endNode;\r
@@ -443,11 +504,17 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
                                while ( ( block = iterator.getNextParagraph() ) )\r
                                {\r
+                                       // Avoid duplicate blocks get processed across ranges.\r
+                                       if( block.getCustomData( 'list_block' ) )\r
+                                               continue;\r
+                                       else\r
+                                               CKEDITOR.dom.element.setMarker( database, block, 'list_block', 1 );\r
+\r
                                        var path = new CKEDITOR.dom.elementPath( block ),\r
                                                pathElements = path.elements,\r
                                                pathElementsCount = pathElements.length,\r
                                                listNode = null,\r
-                                               processedFlag = false,\r
+                                               processedFlag = 0,\r
                                                blockLimit = path.blockLimit,\r
                                                element;\r
 \r
@@ -462,7 +529,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                                        // no longer be valid. Since paragraphs after the list\r
                                                        // should belong to a different group of paragraphs before\r
                                                        // the list. (Bug #1309)\r
-                                                       blockLimit.removeCustomData( 'list_group_object' );\r
+                                                       blockLimit.removeCustomData( 'list_group_object_' + index );\r
 \r
                                                        var groupObj = element.getCustomData( 'list_group_object' );\r
                                                        if ( groupObj )\r
@@ -473,7 +540,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                                                listGroups.push( groupObj );\r
                                                                CKEDITOR.dom.element.setMarker( database, element, 'list_group_object', groupObj );\r
                                                        }\r
-                                                       processedFlag = true;\r
+                                                       processedFlag = 1;\r
                                                        break;\r
                                                }\r
                                        }\r
@@ -481,14 +548,14 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                        if ( processedFlag )\r
                                                continue;\r
 \r
-                                       // No list ancestor? Group by block limit.\r
+                                       // No list ancestor? Group by block limit, but don't mix contents from different ranges.\r
                                        var root = blockLimit;\r
-                                       if ( root.getCustomData( 'list_group_object' ) )\r
-                                               root.getCustomData( 'list_group_object' ).contents.push( block );\r
+                                       if ( root.getCustomData( 'list_group_object_' + index ) )\r
+                                               root.getCustomData( 'list_group_object_' + index ).contents.push( block );\r
                                        else\r
                                        {\r
                                                groupObj = { root : root, contents : [ block ] };\r
-                                               CKEDITOR.dom.element.setMarker( database, root, 'list_group_object', groupObj );\r
+                                               CKEDITOR.dom.element.setMarker( database, root, 'list_group_object_' + index, groupObj );\r
                                                listGroups.push( groupObj );\r
                                        }\r
                                }\r
@@ -522,14 +589,14 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                        var sibling = listNode[ rtl ?\r
                                                'getPrevious' : 'getNext' ]( CKEDITOR.dom.walker.whitespaces( true ) );\r
                                        if ( sibling && sibling.getName &&\r
-                                            sibling.getName() == listCommand.type )\r
+                                                sibling.getName() == listCommand.type )\r
                                        {\r
                                                sibling.remove();\r
                                                // Move children order by merge direction.(#3820)\r
-                                               sibling.moveChildren( listNode, rtl ? true : false );\r
+                                               sibling.moveChildren( listNode, rtl );\r
                                        }\r
                                } )();\r
-                               mergeSibling( true );\r
+                               mergeSibling( 1 );\r
                        }\r
 \r
                        // Clean up, restore selection and update toolbar button states.\r
@@ -570,7 +637,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                nodeBefore = firstNestedList && firstNestedList.previous,\r
                                tailNbspmatch;\r
 \r
-                       if( nodeBefore\r
+                       if ( nodeBefore\r
                                && ( nodeBefore.name && nodeBefore.name == 'br'\r
                                        || nodeBefore.value && ( tailNbspmatch = nodeBefore.value.match( tailNbspRegex ) ) ) )\r
                        {\r
@@ -594,11 +661,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
        }\r
 \r
        var defaultListDataFilterRules = { elements : {} };\r
-       for( var i in dtd.$listItem )\r
+       for ( var i in dtd.$listItem )\r
                defaultListDataFilterRules.elements[ i ] = getExtendNestedListFilter();\r
 \r
        var defaultListHtmlFilterRules = { elements : {} };\r
-       for( i in dtd.$listItem )\r
+       for ( i in dtd.$listItem )\r
                defaultListHtmlFilterRules.elements[ i ] = getExtendNestedListFilter( true );\r
 \r
        CKEDITOR.plugins.add( 'list',\r
@@ -631,7 +698,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                afterInit : function ( editor )\r
                {\r
                        var dataProcessor = editor.dataProcessor;\r
-                       if( dataProcessor )\r
+                       if ( dataProcessor )\r
                        {\r
                                dataProcessor.dataFilter.addRules( defaultListDataFilterRules );\r
                                dataProcessor.htmlFilter.addRules( defaultListHtmlFilterRules );\r