JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.5.1
[ckeditor.git] / _source / plugins / styles / plugin.js
index 37126f1..40dc6d1 100644 (file)
@@ -1,11 +1,21 @@
 /*\r
-Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
 CKEDITOR.plugins.add( 'styles',\r
 {\r
-       requires : [ 'selection' ]\r
+       requires : [ 'selection' ],\r
+       init : function( editor )\r
+       {\r
+               // This doesn't look like correct, but it's the safest way to proper\r
+               // pass the disableReadonlyStyling configuration to the style system\r
+               // without having to change any method signature in the API. (#6103)\r
+               editor.on( 'contentDom', function()\r
+                       {\r
+                               editor.document.setCustomData( 'cke_includeReadonly', !editor.config.disableReadonlyStyling );\r
+                       });\r
+       }\r
 });\r
 \r
 /**\r
@@ -82,6 +92,8 @@ CKEDITOR.STYLE_OBJECT = 3;
 \r
        var semicolonFixRegex = /\s*(?:;\s*|$)/;\r
 \r
+       var notBookmark = CKEDITOR.dom.walker.bookmark( 0, 1 );\r
+\r
        CKEDITOR.style = function( styleDefinition, variablesValues )\r
        {\r
                if ( variablesValues )\r
@@ -137,6 +149,8 @@ CKEDITOR.STYLE_OBJECT = 3;
                        return ( this.removeFromRange =\r
                                                this.type == CKEDITOR.STYLE_INLINE ?\r
                                                        removeInlineStyle\r
+                                               : this.type == CKEDITOR.STYLE_BLOCK ?\r
+                                                       removeBlockStyle\r
                                                : this.type == CKEDITOR.STYLE_OBJECT ?\r
                                                        removeObjectStyle\r
                                                : null ).call( this, range );\r
@@ -353,6 +367,35 @@ CKEDITOR.STYLE_OBJECT = 3;
                return ( styleDefinition._ST = stylesText );\r
        };\r
 \r
+       // Gets the parent element which blocks the styling for an element. This\r
+       // can be done through read-only elements (contenteditable=false) or\r
+       // elements with the "data-nostyle" attribute.\r
+       function getUnstylableParent( element )\r
+       {\r
+               var unstylable,\r
+                       editable;\r
+\r
+               while ( ( element = element.getParent() ) )\r
+               {\r
+                       if ( element.getName() == 'body' )\r
+                               break;\r
+\r
+                       if ( element.getAttribute( 'data-nostyle' ) )\r
+                               unstylable = element;\r
+                       else if ( !editable )\r
+                       {\r
+                               var contentEditable = element.getAttribute( 'contentEditable' );\r
+\r
+                               if ( contentEditable == 'false' )\r
+                                       unstylable = element;\r
+                               else if ( contentEditable == 'true' )\r
+                                       editable = 1;\r
+                       }\r
+               }\r
+\r
+               return unstylable;\r
+       }\r
+\r
        function applyInlineStyle( range )\r
        {\r
                var document = range.document;\r
@@ -375,11 +418,19 @@ CKEDITOR.STYLE_OBJECT = 3;
                var def = this._.definition;\r
                var isUnknownElement;\r
 \r
+               // Indicates that fully selected read-only elements are to be included in the styling range.\r
+               var includeReadonly = def.includeReadonly;\r
+\r
+               // If the read-only inclusion is not available in the definition, try\r
+               // to get it from the document data.\r
+               if ( includeReadonly == undefined )\r
+                       includeReadonly = document.getCustomData( 'cke_includeReadonly' );\r
+\r
                // Get the DTD definition for the element. Defaults to "span".\r
                var dtd = CKEDITOR.dtd[ elementName ] || ( isUnknownElement = true, CKEDITOR.dtd.span );\r
 \r
                // Expand the range.\r
-               range.enlarge( CKEDITOR.ENLARGE_ELEMENT );\r
+               range.enlarge( CKEDITOR.ENLARGE_ELEMENT, 1 );\r
                range.trim();\r
 \r
                // Get the first node to be processed and the last, which concludes the\r
@@ -392,6 +443,24 @@ CKEDITOR.STYLE_OBJECT = 3;
 \r
                var styleRange;\r
 \r
+               // Check if the boundaries are inside non stylable elements.\r
+               var firstUnstylable = getUnstylableParent( firstNode ),\r
+                       lastUnstylable = getUnstylableParent( lastNode );\r
+\r
+               // If the first element can't be styled, we'll start processing right\r
+               // after its unstylable root.\r
+               if ( firstUnstylable )\r
+                       currentNode = firstUnstylable.getNextSourceNode( true );\r
+\r
+               // If the last element can't be styled, we'll stop processing on its\r
+               // unstylable root.\r
+               if ( lastUnstylable )\r
+                       lastNode = lastUnstylable;\r
+\r
+               // Do nothing if the current node now follows the last node to be processed.\r
+               if ( currentNode.getPosition( lastNode ) == CKEDITOR.POSITION_FOLLOWING )\r
+                       currentNode = 0;\r
+\r
                while ( currentNode )\r
                {\r
                        var applyStyle = false;\r
@@ -405,8 +474,10 @@ CKEDITOR.STYLE_OBJECT = 3;
                        {\r
                                var nodeType = currentNode.type;\r
                                var nodeName = nodeType == CKEDITOR.NODE_ELEMENT ? currentNode.getName() : null;\r
+                               var nodeIsReadonly = nodeName && ( currentNode.getAttribute( 'contentEditable' ) == 'false' );\r
+                               var nodeIsNoStyle = nodeName && currentNode.getAttribute( 'data-nostyle' );\r
 \r
-                               if ( nodeName && currentNode.getAttribute( '_cke_bookmark' ) )\r
+                               if ( nodeName && currentNode.data( 'cke-bookmark' ) )\r
                                {\r
                                        currentNode = currentNode.getNextSourceNode( true );\r
                                        continue;\r
@@ -414,6 +485,8 @@ CKEDITOR.STYLE_OBJECT = 3;
 \r
                                // Check if the current node can be a child of the style element.\r
                                if ( !nodeName || ( dtd[ nodeName ]\r
+                                       && !nodeIsNoStyle\r
+                                       && ( !nodeIsReadonly || includeReadonly )\r
                                        && ( currentNode.getPosition( lastNode ) | CKEDITOR.POSITION_PRECEDING | CKEDITOR.POSITION_IDENTICAL | CKEDITOR.POSITION_IS_CONTAINED ) == ( CKEDITOR.POSITION_PRECEDING + CKEDITOR.POSITION_IDENTICAL + CKEDITOR.POSITION_IS_CONTAINED )\r
                                        && ( !def.childRule || def.childRule( currentNode ) ) ) )\r
                                {\r
@@ -435,9 +508,9 @@ CKEDITOR.STYLE_OBJECT = 3;
                                                        styleRange.setStartBefore( currentNode );\r
                                                }\r
 \r
-                                               // Non element nodes, or empty elements can be added\r
-                                               // completely to the range.\r
-                                               if ( nodeType == CKEDITOR.NODE_TEXT || ( nodeType == CKEDITOR.NODE_ELEMENT && !currentNode.getChildCount() ) )\r
+                                               // Non element nodes, readonly elements, or empty\r
+                                               // elements can be added completely to the range.\r
+                                               if ( nodeType == CKEDITOR.NODE_TEXT || nodeIsReadonly || ( nodeType == CKEDITOR.NODE_ELEMENT && !currentNode.getChildCount() ) )\r
                                                {\r
                                                        var includedNode = currentNode;\r
                                                        var parentNode;\r
@@ -445,8 +518,8 @@ CKEDITOR.STYLE_OBJECT = 3;
                                                        // This node is about to be included completelly, but,\r
                                                        // if this is the last node in its parent, we must also\r
                                                        // check if the parent itself can be added completelly\r
-                                                       // to the range.\r
-                                                       while ( !includedNode.$.nextSibling\r
+                                                       // to the range, otherwise apply the style immediately.\r
+                                                       while ( ( applyStyle = !includedNode.getNext( notBookmark ) )\r
                                                                && ( parentNode = includedNode.getParent(), dtd[ parentNode.getName() ] )\r
                                                                && ( parentNode.getPosition( firstNode ) | CKEDITOR.POSITION_FOLLOWING | CKEDITOR.POSITION_IDENTICAL | CKEDITOR.POSITION_IS_CONTAINED ) == ( CKEDITOR.POSITION_FOLLOWING + CKEDITOR.POSITION_IDENTICAL + CKEDITOR.POSITION_IS_CONTAINED )\r
                                                                && ( !def.childRule || def.childRule( parentNode ) ) )\r
@@ -456,12 +529,6 @@ CKEDITOR.STYLE_OBJECT = 3;
 \r
                                                        styleRange.setEndAfter( includedNode );\r
 \r
-                                                       // If the included node still is the last node in its\r
-                                                       // parent, it means that the parent can't be included\r
-                                                       // in this style DTD, so apply the style immediately.\r
-                                                       if ( !includedNode.$.nextSibling )\r
-                                                               applyStyle = true;\r
-\r
                                                }\r
                                        }\r
                                        else\r
@@ -471,7 +538,7 @@ CKEDITOR.STYLE_OBJECT = 3;
                                        applyStyle = true;\r
 \r
                                // Get the next node to be processed.\r
-                               currentNode = currentNode.getNextSourceNode();\r
+                               currentNode = currentNode.getNextSourceNode( nodeIsNoStyle || nodeIsReadonly );\r
                        }\r
 \r
                        // Apply the style if we have something to which apply it.\r
@@ -590,7 +657,7 @@ CKEDITOR.STYLE_OBJECT = 3;
                 * Make sure our range has included all "collpased" parent inline nodes so\r
                 * that our operation logic can be simpler.\r
                 */\r
-               range.enlarge( CKEDITOR.ENLARGE_ELEMENT );\r
+               range.enlarge( CKEDITOR.ENLARGE_ELEMENT, 1 );\r
 \r
                var bookmark = range.createBookmark(),\r
                        startNode = bookmark.startNode;\r
@@ -816,13 +883,55 @@ CKEDITOR.STYLE_OBJECT = 3;
                range.moveToBookmark( bookmark );\r
        }\r
 \r
+       function removeBlockStyle( range )\r
+       {\r
+               // Serializible bookmarks is needed here since\r
+               // elements may be merged.\r
+               var bookmark = range.createBookmark( 1 );\r
+\r
+               var iterator = range.createIterator();\r
+               iterator.enforceRealBlocks = true;\r
+               iterator.enlargeBr = this._.enterMode != CKEDITOR.ENTER_BR;\r
+\r
+               var block;\r
+               while ( ( block = iterator.getNextParagraph() ) )\r
+               {\r
+                       if ( this.checkElementRemovable( block ) )\r
+                       {\r
+                               // <pre> get special treatment.\r
+                               if ( block.is( 'pre' ) )\r
+                               {\r
+                                       var newBlock = this._.enterMode == CKEDITOR.ENTER_BR ?\r
+                                                               null : range.document.createElement(\r
+                                                                       this._.enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' );\r
+\r
+                                       newBlock && block.copyAttributes( newBlock );\r
+                                       replaceBlock( block, newBlock );\r
+                               }\r
+                               else\r
+                                        removeFromElement( this, block, 1 );\r
+                       }\r
+               }\r
+\r
+               range.moveToBookmark( bookmark );\r
+       }\r
+\r
        // Replace the original block with new one, with special treatment\r
        // for <pre> blocks to make sure content format is well preserved, and merging/splitting adjacent\r
        // when necessary.(#3188)\r
        function replaceBlock( block, newBlock )\r
        {\r
-               var newBlockIsPre       = newBlock.is( 'pre' );\r
-               var blockIsPre          = block.is( 'pre' );\r
+               // Block is to be removed, create a temp element to\r
+               // save contents.\r
+               var removeBlock = !newBlock;\r
+               if ( removeBlock )\r
+               {\r
+                       newBlock = block.getDocument().createElement( 'div' );\r
+                       block.copyAttributes( newBlock );\r
+               }\r
+\r
+               var newBlockIsPre       = newBlock && newBlock.is( 'pre' );\r
+               var blockIsPre  = block.is( 'pre' );\r
 \r
                var isToPre     = newBlockIsPre && !blockIsPre;\r
                var isFromPre   = !newBlockIsPre && blockIsPre;\r
@@ -831,7 +940,8 @@ CKEDITOR.STYLE_OBJECT = 3;
                        newBlock = toPre( block, newBlock );\r
                else if ( isFromPre )\r
                        // Split big <pre> into pieces before start to convert.\r
-                       newBlock = fromPres( splitIntoPres( block ), newBlock );\r
+                       newBlock = fromPres( removeBlock ?\r
+                                               [ block.getHtml() ] : splitIntoPres( block ), newBlock );\r
                else\r
                        block.moveChildren( newBlock );\r
 \r
@@ -842,9 +952,11 @@ CKEDITOR.STYLE_OBJECT = 3;
                        // Merge previous <pre> blocks.\r
                        mergePre( newBlock );\r
                }\r
+               else if ( removeBlock )\r
+                       removeNoAttribsElement( newBlock );\r
        }\r
 \r
-       var nonWhitespaces = CKEDITOR.dom.walker.whitespaces( true );\r
+       var nonWhitespaces = CKEDITOR.dom.walker.whitespaces( 1 );\r
        /**\r
         * Merge a <pre> block with a previous sibling if available.\r
         */\r
@@ -883,7 +995,7 @@ CKEDITOR.STYLE_OBJECT = 3;
        {\r
                // Exclude the ones at header OR at tail,\r
                // and ignore bookmark content between them.\r
-               var duoBrRegex = /(\S\s*)\n(?:\s|(<span[^>]+_cke_bookmark.*?\/span>))*\n(?!$)/gi,\r
+               var duoBrRegex = /(\S\s*)\n(?:\s|(<span[^>]+data-cke-bookmark.*?\/span>))*\n(?!$)/gi,\r
                        blockName = preBlock.getName(),\r
                        splitedHtml = replace( preBlock.getOuterHtml(),\r
                                duoBrRegex,\r
@@ -905,7 +1017,7 @@ CKEDITOR.STYLE_OBJECT = 3;
                var headBookmark = '',\r
                        tailBookmark = '';\r
 \r
-               str = str.replace( /(^<span[^>]+_cke_bookmark.*?\/span>)|(<span[^>]+_cke_bookmark.*?\/span>$)/gi,\r
+               str = str.replace( /(^<span[^>]+data-cke-bookmark.*?\/span>)|(<span[^>]+data-cke-bookmark.*?\/span>$)/gi,\r
                        function( str, m1, m2 ){\r
                                        m1 && ( headBookmark = m1 );\r
                                        m2 && ( tailBookmark = m2 );\r
@@ -918,7 +1030,10 @@ CKEDITOR.STYLE_OBJECT = 3;
         */\r
        function fromPres( preHtmls, newBlock )\r
        {\r
-               var docFrag = new CKEDITOR.dom.documentFragment( newBlock.getDocument() );\r
+               var docFrag;\r
+               if ( preHtmls.length > 1 )\r
+                       docFrag = new CKEDITOR.dom.documentFragment( newBlock.getDocument() );\r
+\r
                for ( var i = 0 ; i < preHtmls.length ; i++ )\r
                {\r
                        var blockHtml = preHtmls[ i ];\r
@@ -948,11 +1063,17 @@ CKEDITOR.STYLE_OBJECT = 3;
                                                return CKEDITOR.tools.repeat( '&nbsp;', match.length - 1 ) + ' ' ;\r
                                        } ) ;\r
 \r
-                       var newBlockClone = newBlock.clone();\r
-                       newBlockClone.setHtml(  blockHtml );\r
-                       docFrag.append( newBlockClone );\r
+                       if ( docFrag )\r
+                       {\r
+                               var newBlockClone = newBlock.clone();\r
+                               newBlockClone.setHtml(  blockHtml );\r
+                               docFrag.append( newBlockClone );\r
+                       }\r
+                       else\r
+                               newBlock.setHtml( blockHtml );\r
                }\r
-               return docFrag;\r
+\r
+               return docFrag || newBlock;\r
        }\r
 \r
        /**\r
@@ -960,6 +1081,9 @@ CKEDITOR.STYLE_OBJECT = 3;
         */\r
        function toPre( block, newBlock )\r
        {\r
+               var bogus = block.getBogus();\r
+               bogus && bogus.remove();\r
+\r
                // First trim the block content.\r
                var preHtml = block.getHtml();\r
 \r
@@ -982,6 +1106,7 @@ CKEDITOR.STYLE_OBJECT = 3;
                        var temp = block.getDocument().createElement( 'div' );\r
                        temp.append( newBlock );\r
                        newBlock.$.outerHTML =  '<pre>' + preHtml + '</pre>';\r
+                       newBlock.copyAttributes( temp.getFirst() );\r
                        newBlock = temp.getFirst().remove();\r
                }\r
                else\r
@@ -1021,7 +1146,12 @@ CKEDITOR.STYLE_OBJECT = 3;
                        element.removeStyle( styleName );\r
                }\r
 \r
-               removeEmpty && removeNoAttribsElement( element );\r
+               if ( removeEmpty )\r
+               {\r
+                       !CKEDITOR.dtd.$block[ element.getName() ] || style._.enterMode == CKEDITOR.ENTER_BR && !element.hasAttributes() ?\r
+                               removeNoAttribsElement( element ) :\r
+                               element.renameNode( style._.enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' );\r
+               }\r
        }\r
 \r
        // Removes a style from inside an element.\r
@@ -1098,21 +1228,37 @@ CKEDITOR.STYLE_OBJECT = 3;
                // leaving its children.\r
                if ( !element.hasAttributes() )\r
                {\r
-                       // Removing elements may open points where merging is possible,\r
-                       // so let's cache the first and last nodes for later checking.\r
-                       var firstChild  = element.getFirst();\r
-                       var lastChild   = element.getLast();\r
+                       if ( CKEDITOR.dtd.$block[ element.getName() ] )\r
+                       {\r
+                               var previous = element.getPrevious( nonWhitespaces ),\r
+                                               next = element.getNext( nonWhitespaces );\r
 \r
-                       element.remove( true );\r
+                               if ( previous && ( previous.type == CKEDITOR.NODE_TEXT || !previous.isBlockBoundary( { br : 1 } ) ) )\r
+                                       element.append( 'br', 1 );\r
+                               if ( next && ( next.type == CKEDITOR.NODE_TEXT || !next.isBlockBoundary( { br : 1 } ) ) )\r
+                                       element.append( 'br' );\r
 \r
-                       if ( firstChild )\r
+                               element.remove( true );\r
+                       }\r
+                       else\r
                        {\r
-                               // Check the cached nodes for merging.\r
-                               firstChild.type == CKEDITOR.NODE_ELEMENT && firstChild.mergeSiblings();\r
+                               // Removing elements may open points where merging is possible,\r
+                               // so let's cache the first and last nodes for later checking.\r
+                               var firstChild = element.getFirst();\r
+                               var lastChild = element.getLast();\r
+\r
+                               element.remove( true );\r
+\r
+                               if ( firstChild )\r
+                               {\r
+                                       // Check the cached nodes for merging.\r
+                                       firstChild.type == CKEDITOR.NODE_ELEMENT && firstChild.mergeSiblings();\r
+\r
+                                       if ( lastChild && !firstChild.equals( lastChild )\r
+                                                       && lastChild.type == CKEDITOR.NODE_ELEMENT )\r
+                                               lastChild.mergeSiblings();\r
+                               }\r
 \r
-                               if ( lastChild && !firstChild.equals( lastChild )\r
-                                       && lastChild.type == CKEDITOR.NODE_ELEMENT  )\r
-                                       lastChild.mergeSiblings();\r
                        }\r
                }\r
        }\r
@@ -1136,7 +1282,15 @@ CKEDITOR.STYLE_OBJECT = 3;
                if ( element )\r
                        element.copyAttributes( el );\r
 \r
-               return setupElement( el, style );\r
+               el = setupElement( el, style );\r
+\r
+               // Avoid ID duplication.\r
+               if ( targetDocument.getCustomData( 'doc_processing_style' ) && el.hasAttribute( 'id' ) )\r
+                       el.removeAttribute( 'id' );\r
+               else\r
+                       targetDocument.setCustomData( 'doc_processing_style', 1 );\r
+\r
+               return el;\r
        }\r
 \r
        function setupElement( el, style )\r
@@ -1353,9 +1507,7 @@ CKEDITOR.STYLE_OBJECT = 3;
        function applyStyle( document, remove )\r
        {\r
                var selection = document.getSelection(),\r
-                       // Bookmark the range so we can re-select it after processing.\r
-                       bookmarks = selection.createBookmarks( 1 ),\r
-                       ranges = selection.getRanges( 1 ),\r
+                       ranges = selection.getRanges(),\r
                        func = remove ? this.removeFromRange : this.applyToRange,\r
                        range;\r
 \r
@@ -1363,13 +1515,9 @@ CKEDITOR.STYLE_OBJECT = 3;
                while ( ( range = iterator.getNextRange() ) )\r
                        func.call( this, range );\r
 \r
-               if ( bookmarks.length == 1 && bookmarks[0].collapsed )\r
-               {\r
-                       selection.selectRanges( ranges );\r
-                       document.getById( bookmarks[ 0 ].startNode ).remove();\r
-               }\r
-               else\r
-                       selection.selectBookmarks( bookmarks );\r
+               selection.selectRanges( ranges );\r
+\r
+               document.removeCustomData( 'doc_processing_style' );\r
        }\r
 })();\r
 \r
@@ -1449,6 +1597,23 @@ CKEDITOR.editor.prototype.getStylesSet = function( callback )
 };\r
 \r
 /**\r
+ * Indicates that fully selected read-only elements will be included when\r
+ * applying the style (for inline styles only).\r
+ * @name CKEDITOR.style.includeReadonly\r
+ * @type Boolean\r
+ * @default false\r
+ * @since 3.5\r
+ */\r
+\r
+ /**\r
+  * Disables inline styling on read-only elements.\r
+  * @name CKEDITOR.config.disableReadonlyStyling\r
+  * @type Boolean\r
+  * @default false\r
+  * @since 3.5\r
+  */\r
+\r
+/**\r
  * The "styles definition set" to use in the editor. They will be used in the\r
  * styles combo and the Style selector of the div container. <br>\r
  * The styles may be defined in the page containing the editor, or can be\r