Changeset 858

Timestamp:

09/21/07 15:56:59 (6 years ago)

Author:

martinkou

Message:

Uploaded custom list command implementation based on the array list model.

Location:

FCKeditor/branches/features/custom_list_command

Files:

• . (copied) (copied from FCKeditor/trunk)
• editor/_source/commandclasses/fcklistcommands.js (modified) (2 diffs)
• editor/_source/internals/fckcommands.js (modified) (1 diff)
• editor/_source/internals/fckdomtools.js (copied) (copied from FCKeditor/trunk/editor/_source/internals/fckdomtools.js)

FCKeditor/branches/features/custom_list_command/editor/_source/commandclasses/fcklistcommands.js

@@ -22 +22 @@
  */
 
-var FCKListCommand = function( name )
+// TODO:
+// 1. Handle unioning of lists and paragraphs.
+// 2. Creating separate lists inside table cells isn't working.
+
+var FCKListCommand = function( name, tagName )
 {
         this.Name = name ;
+        this.TagName = tagName ;
 }
 
@@ -31 +36 @@
         GetState : function()
         {
-                return FCK.GetNamedCommandState( this.Name ) ;
+                // Disabled if not WYSIWYG.
+                if ( FCK.EditMode != FCK_EDITMODE_WYSIWYG || ! FCK.EditorWindow )
+                        return FCK_TRISTATE_DISABLED ;
+
+                // We'll use the style system's convention to determine list state here...
+                // If the starting block is a descendant of an <ol> or <ul> node, then we're in a list.
+                var startContainer = FCKSelection.GetBoundaryParentElement( true ) ;
+                var listNode = FCKTools.GetElementAscensor( startContainer, this.TagName ) ;
+                if ( listNode )
+                        return FCK_TRISTATE_ON ;
+                else
+                        return FCK_TRISTATE_OFF ;
         },
 
         Execute : function()
         {
-                if ( FCKBrowserInfo.IsIE && this.GetState() == FCK_TRISTATE_OFF )
-                {
-                        // IE does not split selected <br> tags when it is making lists. (See #428)
-                        // So, pre-split the blocks for IE.
-                        var range = new FCKDomRange( FCK.EditorWindow ) ;
-                        range.MoveToSelection() ;
-                        var startNode = range._Range.startContainer ;
-                        var endNode = range._Range.endContainer ;
-                        if ( startNode.nodeType == 1 )
-                        {
-                                if ( startNode.firstChild )
+                FCKUndo.SaveUndoStep() ;
+
+                var range = new FCKDomRange( FCK.EditorWindow ) ;
+                range.MoveToSelection() ;
+                var bookmark = range.CreateBookmark() ;
+
+                // Group the blocks up because there are many cases where multiple lists have to be created,
+                // or multiple lists have to be cancelled.
+                var listGroups = [] ;
+                var markerObj = {} ;
+                var iterator = new FCKDomRangeIterator( range ) ;
+                var block ;
+                var state = this.GetState() ;
+                iterator.ForceBrBreak = ( state == FCK_TRISTATE_OFF ) ;
+                while ( ( block = iterator.GetNextParagraph() ) )
+                {
+                        var path = new FCKElementPath( block ) ;
+                        var listNode = null ;
+                        var processedFlag = false ;
+
+                        // First, try to group by a list ancestor.
+                        for ( var i = path.Elements.length - 1 ; i >= 0 ; i-- )
+                        {
+                                var el = path.Elements[i] ;
+                                if ( el.nodeName.IEquals( ['ol', 'ul'] ) )
                                 {
-                                        if ( startNode.childNodes.length <= range._Range.startOffset )
-                                                startNode = startNode.lastChild ;
+                                        var groupObj = el._FCK_ListGroupObject ;
+                                        if ( groupObj )
+                                                groupObj.contents.push( block ) ;
                                         else
-                                                startNode = startNode.childNodes[ range._Range.startOffset ] ;
+                                        {
+                                                groupObj = { 'root' : el, 'contents' : [ block ] } ;
+                                                listGroups.push( groupObj ) ;
+                                                FCKDomTools.SetElementMarker( markerObj, el, '_FCK_ListGroupObject', groupObj ) ;
+                                        }
+                                        processedFlag = true ;
+                                        break ;
                                 }
                         }
-                        if ( endNode.nodeType == 1 )
-                        {
-                                if ( endNode.firstChild )
+
+                        if ( processedFlag )
+                                continue ;
+
+                        // No list ancestor? Group by block limit.
+                        var root = path.BlockLimit ;
+                        if ( root._FCK_ListGroupObject )
+                                root._FCK_ListGroupObject.contents.push( block ) ;
+                        else
+                        {
+                                var groupObj = { 'root' : root, 'contents' : [ block ] } ;
+                                FCKDomTools.SetElementMarker( markerObj, root, '_FCK_ListGroupObject', groupObj ) ;
+                                listGroups.push( groupObj ) ;
+                        }
+                }
+
+                // Now we have two kinds of list groups, groups rooted at a list, and groups rooted at a block limit element.
+                // We either have to build lists or remove lists, for removing a list does not makes sense when we are looking
+                // at the group that's not rooted at lists. So we have three cases to handle.
+                while ( listGroups.length > 0 )
+                {
+                        var groupObj = listGroups.shift() ;
+                        if ( state == FCK_TRISTATE_OFF )
+                        {
+                                if ( groupObj.root.nodeName.IEquals( ['ul', 'ol'] ) )
+                                        this._ChangeListType( groupObj, markerObj ) ;
+                                else
+                                        this._CreateList( groupObj ) ;
+                        }
+                        else if ( state == FCK_TRISTATE_ON && groupObj.root.nodeName.IEquals( ['ul', 'ol'] ) )
+                                this._RemoveList( groupObj, markerObj ) ;
+                }
+
+                // Clean up, restore selection and update toolbar button states.
+                FCKDomTools.ClearElementMarkers( markerObj ) ;
+                range.MoveToBookmark( bookmark ) ;
+                range.Select() ;
+                FCK.Events.FireEvent( 'OnSelectionChange' ) ;
+        },
+
+        _ChangeListType : function( groupObj, markerObj )
+        {
+                // This case is easy...
+                // 1. Convert the whole list into a one-dimensional array.
+                // 2. Change the list type by modifying the array.
+                // 3. Recreate the whole list by converting the array to a list.
+                // 4. Replace the original list with the recreated list.
+                var listArray = FCKDomTools.ListToArray( groupObj.root, null, null, markerObj ) ;
+                var selectedListItems = [] ;
+                for ( var i = 0 ; i < groupObj.contents.length ; i++ )
+                {
+                        var itemNode = groupObj.contents[i] ;
+                        itemNode = FCKTools.GetElementAscensor( itemNode, 'li' ) ;
+                        if ( ! itemNode || itemNode._FCK_ListItem_Processed )
+                                continue ;
+                        selectedListItems.push( itemNode ) ;
+                        FCKDomTools.SetElementMarker( markerObj, itemNode, '_FCK_ListItem_Processed', true ) ;
+                }
+                var fakeParent = groupObj.root.ownerDocument.createElement( this.TagName ) ;
+                for ( var i = 0 ; i < selectedListItems.length ; i++ )
+                {
+                        var listIndex = selectedListItems[i]._FCK_ListArray_Index ;
+                        listArray[listIndex].parent = fakeParent ;
+                }
+                var newList = FCKDomTools.ArrayToList( listArray ) ;
+                groupObj.root.parentNode.replaceChild( newList.listNode, groupObj.root ) ;
+        },
+
+        _CreateList : function( groupObj )
+        {
+                var contents = groupObj.contents ;
+                var commonParent = groupObj.contents[0].parentNode ;
+                var listContents = [] ;
+                for ( var i = 0 ; i < contents.length ; i++ )
+                        commonParent = FCKDomTools.GetCommonParents( commonParent, contents[i].parentNode ).pop() ;
+                for ( var i = 0 ; i < contents.length ; i++ )
+                {
+                        var contentNode = contents[i] ;
+                        while ( contentNode.parentNode )
+                        { 
+                                if ( contentNode.parentNode == commonParent )
                                 {
-                                        if ( endNode.childNodes.length <= range._Range.endOffset )
-                                                endNode = endNode.lastChild ;
-                                        else
-                                                endNode = endNode.childNodes[ range._Range.endOffset ] ;
+                                        listContents.push( contentNode ) ;
+                                        break ;
                                 }
-                        }
-
-                        var brNodes = [] ;
-                        var curNode = startNode ;
-                        while ( curNode && curNode != endNode )
-                        {
-                                if ( curNode.nodeType == 1 && curNode.tagName.toLowerCase() == 'br' )
-                                        brNodes.push( curNode ) ;
-                                curNode = FCKTools.GetNextNode( curNode ) ;
-                        }
-
-                        for ( var i = brNodes.length - 1 ; i >= 0 ; i-- )
-                        {
-                                range.SetStart( brNodes[i], 3 ) ;
-                                range.SetEnd( brNodes[i], 3 ) ;
-                                brNodes[i].parentNode.removeChild( brNodes[i] ) ;
-                                range.SplitBlock() ;
-                        }
-
-                        range.SetStart( startNode, 1 ) ;
-                        range.SetEnd( endNode, 4 ) ;
-                        range.Select() ;
-                }
-                FCK.ExecuteNamedCommand( this.Name ) ;
+                                contentNode = contentNode.parentNode ;
+                        }
+                }
+
+                if ( listContents.length < 1 )
+                        return ;
+
+                var insertAnchor = listContents[listContents.length - 1].nextSibling ;
+                var doc = commonParent.ownerDocument ;
+                var listNode = doc.createElement( this.TagName ) ;
+                while ( listContents.length )
+                {
+                        var contentBlock = listContents.shift() ;
+                        var docFrag = doc.createDocumentFragment() ;
+                        while ( contentBlock.firstChild )
+                                docFrag.appendChild( contentBlock.removeChild( contentBlock.firstChild ) ) ;
+                        contentBlock.parentNode.removeChild( contentBlock ) ;
+                        var listItem = doc.createElement( 'li' ) ; 
+                        listItem.appendChild( docFrag ) ;
+                        listNode.appendChild( listItem ) ;
+                }
+                commonParent.insertBefore( listNode, insertAnchor ) ;
+        },
+
+        _RemoveList : function( groupObj, markerObj )
+        {
+                // This is very much like the change list type operation.
+                // Except that we're changing the selected items' indent to -1 in the list array.
+                var listArray = FCKDomTools.ListToArray( groupObj.root, null, null, markerObj ) ;
+                var selectedListItems = [] ;
+                for ( var i = 0 ; i < groupObj.contents.length ; i++ )
+                {
+                        var itemNode = groupObj.contents[i] ;
+                        itemNode = FCKTools.GetElementAscensor( itemNode, 'li' ) ;
+                        if ( ! itemNode || itemNode._FCK_ListItem_Processed )
+                                continue ;
+                        selectedListItems.push( itemNode ) ;
+                        FCKDomTools.SetElementMarker( markerObj, itemNode, '_FCK_ListItem_Processed', true ) ;
+                }
+                
+                var lastListIndex = null ;
+                for ( var i = 0 ; i < selectedListItems.length ; i++ )
+                {
+                        var listIndex = selectedListItems[i]._FCK_ListArray_Index ;
+                        listArray[listIndex].indent = -1 ;
+                        lastListIndex = listIndex ;
+                }
+
+                // After cutting parts of the list out with indent=-1, we still have to maintain the array list
+                // model's nextItem.indent <= currentItem.indent + 1 invariant. Otherwise the array model of the
+                // list cannot be converted back to a real DOM list.
+                for ( var i = lastListIndex + 1; i < listArray.length ; i++ )
+                {
+                        if ( listArray[i].indent > listArray[i-1].indent + 1 )
+                        {
+                                var indentOffset = listArray[i-1].indent + 1 - listArray[i].indent ;
+                                var oldIndent = listArray[i].indent ;
+                                while ( listArray[i] && listArray[i].indent >= oldIndent)
+                                {
+                                        listArray[i].indent += indentOffset ;
+                                        i++ ;
+                                }
+                                i-- ;
+                        }
+                }
+
+                var newList = FCKDomTools.ArrayToList( listArray ) ;
+                groupObj.root.parentNode.replaceChild( newList.listNode, groupObj.root ) ;
         }
 };

FCKeditor/branches/features/custom_list_command/editor/_source/internals/fckcommands.js

@@ -131 +131 @@
 
                 case 'SelectAll'                        : oCommand = new FCKSelectAllCommand() ; break ;
-                case 'InsertOrderedList'        : oCommand = new FCKListCommand( 'insertorderedlist' ) ; break ;
-                case 'InsertUnorderedList'      : oCommand = new FCKListCommand( 'insertunorderedlist' ) ; break ;
+                case 'InsertOrderedList'        : oCommand = new FCKListCommand( 'insertorderedlist', 'ol' ) ; break ;
+                case 'InsertUnorderedList'      : oCommand = new FCKListCommand( 'insertunorderedlist', 'ul' ) ; break ;
                 case 'ShowBlocks' : oCommand = new FCKShowBlockCommand( 'ShowBlocks', FCKConfig.StartupShowBlocks ? FCK_TRISTATE_ON : FCK_TRISTATE_OFF ) ; break ;