rt/share/html/NoAuth/RichText/FCKeditor/editor/_source/internals/fckstyles.js

   1 /*\r
   2  * FCKeditor - The text editor for Internet - http://www.fckeditor.net\r
   3  * Copyright (C) 2003-2009 Frederico Caldeira Knabben\r
   4  *\r
   5  * == BEGIN LICENSE ==\r
   6  *\r
   7  * Licensed under the terms of any of the following licenses at your\r
   8  * choice:\r
   9  *\r
  10  *  - GNU General Public License Version 2 or later (the "GPL")\r
  11  *    http://www.gnu.org/licenses/gpl.html\r
  12  *\r
  13  *  - GNU Lesser General Public License Version 2.1 or later (the "LGPL")\r
  14  *    http://www.gnu.org/licenses/lgpl.html\r
  15  *\r
  16  *  - Mozilla Public License Version 1.1 or later (the "MPL")\r
  17  *    http://www.mozilla.org/MPL/MPL-1.1.html\r
  18  *\r
  19  * == END LICENSE ==\r
  20  *\r
  21  * Handles styles in a give document.\r
  22  */\r
  23 \r
  24 var FCKStyles = FCK.Styles =\r
  25 {\r
  26         _Callbacks : {},\r
  27         _ObjectStyles : {},\r
  28 \r
  29         ApplyStyle : function( style )\r
  30         {\r
  31                 if ( typeof style == 'string' )\r
  32                         style = this.GetStyles()[ style ] ;\r
  33 \r
  34                 if ( style )\r
  35                 {\r
  36                         if ( style.GetType() == FCK_STYLE_OBJECT )\r
  37                                 style.ApplyToObject( FCKSelection.GetSelectedElement() ) ;\r
  38                         else\r
  39                                 style.ApplyToSelection( FCK.EditorWindow ) ;\r
  40 \r
  41                         FCK.Events.FireEvent( 'OnSelectionChange' ) ;\r
  42                 }\r
  43         },\r
  44 \r
  45         RemoveStyle : function( style )\r
  46         {\r
  47                 if ( typeof style == 'string' )\r
  48                         style = this.GetStyles()[ style ] ;\r
  49 \r
  50                 if ( style )\r
  51                 {\r
  52                         style.RemoveFromSelection( FCK.EditorWindow ) ;\r
  53                         FCK.Events.FireEvent( 'OnSelectionChange' ) ;\r
  54                 }\r
  55         },\r
  56 \r
  57         /**\r
  58          * Defines a callback function to be called when the current state of a\r
  59          * specific style changes.\r
  60          */\r
  61         AttachStyleStateChange : function( styleName, callback, callbackOwner )\r
  62         {\r
  63                 var callbacks = this._Callbacks[ styleName ] ;\r
  64 \r
  65                 if ( !callbacks )\r
  66                         callbacks = this._Callbacks[ styleName ] = [] ;\r
  67 \r
  68                 callbacks.push( [ callback, callbackOwner ] ) ;\r
  69         },\r
  70 \r
  71         CheckSelectionChanges : function()\r
  72         {\r
  73                 var startElement = FCKSelection.GetBoundaryParentElement( true ) ;\r
  74 \r
  75                 if ( !startElement )\r
  76                         return ;\r
  77 \r
  78                 // Walks the start node parents path, checking all styles that are being listened.\r
  79                 var path = new FCKElementPath( startElement ) ;\r
  80                 var styles = this.GetStyles() ;\r
  81 \r
  82                 for ( var styleName in styles )\r
  83                 {\r
  84                         var callbacks = this._Callbacks[ styleName ] ;\r
  85 \r
  86                         if ( callbacks )\r
  87                         {\r
  88                                 var style = styles[ styleName ] ;\r
  89                                 var state = style.CheckActive( path ) ;\r
  90 \r
  91                                 if ( state != ( style._LastState || null ) )\r
  92                                 {\r
  93                                         style._LastState = state ;\r
  94 \r
  95                                         for ( var i = 0 ; i < callbacks.length ; i++ )\r
  96                                         {\r
  97                                                 var callback = callbacks[i][0] ;\r
  98                                                 var callbackOwner = callbacks[i][1] ;\r
  99 \r
 100                                                 callback.call( callbackOwner || window, styleName, state ) ;\r
 101                                         }\r
 102                                 }\r
 103                         }\r
 104                 }\r
 105         },\r
 106 \r
 107         CheckStyleInSelection : function( styleName )\r
 108         {\r
 109                 return false ;\r
 110         },\r
 111 \r
 112         _GetRemoveFormatTagsRegex : function ()\r
 113         {\r
 114                 var regex = new RegExp( '^(?:' + FCKConfig.RemoveFormatTags.replace( /,/g,'|' ) + ')$', 'i' ) ;\r
 115 \r
 116                 return (this._GetRemoveFormatTagsRegex = function()\r
 117                 {\r
 118                         return regex ;\r
 119                 })\r
 120                 && regex  ;\r
 121         },\r
 122 \r
 123         /**\r
 124          * Remove all styles from the current selection.\r
 125          * TODO:\r
 126          *  - This is almost a duplication of FCKStyle.RemoveFromRange. We should\r
 127          *    try to merge things.\r
 128          */\r
 129         RemoveAll : function()\r
 130         {\r
 131                 var range = new FCKDomRange( FCK.EditorWindow ) ;\r
 132                 range.MoveToSelection() ;\r
 133 \r
 134                 if ( range.CheckIsCollapsed() )\r
 135                         return ;\r
 136 \r
 137                         // Expand the range, if inside inline element boundaries.\r
 138                 range.Expand( 'inline_elements' ) ;\r
 139 \r
 140                 // Get the bookmark nodes.\r
 141                 // Bookmark the range so we can re-select it after processing.\r
 142                 var bookmark = range.CreateBookmark( true ) ;\r
 143 \r
 144                 // The style will be applied within the bookmark boundaries.\r
 145                 var startNode   = range.GetBookmarkNode( bookmark, true ) ;\r
 146                 var endNode             = range.GetBookmarkNode( bookmark, false ) ;\r
 147 \r
 148                 range.Release( true ) ;\r
 149 \r
 150                 var tagsRegex = this._GetRemoveFormatTagsRegex() ;\r
 151 \r
 152                 // We need to check the selection boundaries (bookmark spans) to break\r
 153                 // the code in a way that we can properly remove partially selected nodes.\r
 154                 // For example, removing a <b> style from\r
 155                 //              <b>This is [some text</b> to show <b>the] problem</b>\r
 156                 // ... where [ and ] represent the selection, must result:\r
 157                 //              <b>This is </b>[some text to show the]<b> problem</b>\r
 158                 // The strategy is simple, we just break the partial nodes before the\r
 159                 // removal logic, having something that could be represented this way:\r
 160                 //              <b>This is </b>[<b>some text</b> to show <b>the</b>]<b> problem</b>\r
 161 \r
 162                 // Let's start checking the start boundary.\r
 163                 var path = new FCKElementPath( startNode ) ;\r
 164                 var pathElements = path.Elements ;\r
 165                 var pathElement ;\r
 166 \r
 167                 for ( var i = 1 ; i < pathElements.length ; i++ )\r
 168                 {\r
 169                         pathElement = pathElements[i] ;\r
 170 \r
 171                         if ( pathElement == path.Block || pathElement == path.BlockLimit )\r
 172                                 break ;\r
 173 \r
 174                         // If this element can be removed (even partially).\r
 175                         if ( tagsRegex.test( pathElement.nodeName ) )\r
 176                                 FCKDomTools.BreakParent( startNode, pathElement, range ) ;\r
 177                 }\r
 178 \r
 179                 // Now the end boundary.\r
 180                 path = new FCKElementPath( endNode ) ;\r
 181                 pathElements = path.Elements ;\r
 182 \r
 183                 for ( var i = 1 ; i < pathElements.length ; i++ )\r
 184                 {\r
 185                         pathElement = pathElements[i] ;\r
 186 \r
 187                         if ( pathElement == path.Block || pathElement == path.BlockLimit )\r
 188                                 break ;\r
 189 \r
 190                         elementName = pathElement.nodeName.toLowerCase() ;\r
 191 \r
 192                         // If this element can be removed (even partially).\r
 193                         if ( tagsRegex.test( pathElement.nodeName ) )\r
 194                                 FCKDomTools.BreakParent( endNode, pathElement, range ) ;\r
 195                 }\r
 196 \r
 197                 // Navigate through all nodes between the bookmarks.\r
 198                 var currentNode = FCKDomTools.GetNextSourceNode( startNode, true, 1 ) ;\r
 199 \r
 200                 while ( currentNode )\r
 201                 {\r
 202                         // If we have reached the end of the selection, stop looping.\r
 203                         if ( currentNode == endNode )\r
 204                                 break ;\r
 205 \r
 206                         // Cache the next node to be processed. Do it now, because\r
 207                         // currentNode may be removed.\r
 208                         var nextNode = FCKDomTools.GetNextSourceNode( currentNode, false, 1 ) ;\r
 209 \r
 210                         // Remove elements nodes that match with this style rules.\r
 211                         if ( tagsRegex.test( currentNode.nodeName ) )\r
 212                                 FCKDomTools.RemoveNode( currentNode, true ) ;\r
 213                         else\r
 214                                 FCKDomTools.RemoveAttributes( currentNode, FCKConfig.RemoveAttributesArray );\r
 215 \r
 216                         currentNode = nextNode ;\r
 217                 }\r
 218 \r
 219                 range.SelectBookmark( bookmark ) ;\r
 220 \r
 221                 FCK.Events.FireEvent( 'OnSelectionChange' ) ;\r
 222         },\r
 223 \r
 224         GetStyle : function( styleName )\r
 225         {\r
 226                 return this.GetStyles()[ styleName ] ;\r
 227         },\r
 228 \r
 229         GetStyles : function()\r
 230         {\r
 231                 var styles = this._GetStyles ;\r
 232                 if ( !styles )\r
 233                 {\r
 234                         styles = this._GetStyles = FCKTools.Merge(\r
 235                                 this._LoadStylesCore(),\r
 236                                 this._LoadStylesCustom(),\r
 237                                 this._LoadStylesXml() ) ;\r
 238                 }\r
 239                 return styles ;\r
 240         },\r
 241 \r
 242         CheckHasObjectStyle : function( elementName )\r
 243         {\r
 244                 return !!this._ObjectStyles[ elementName ] ;\r
 245         },\r
 246 \r
 247         _LoadStylesCore : function()\r
 248         {\r
 249                 var styles = {};\r
 250                 var styleDefs = FCKConfig.CoreStyles ;\r
 251 \r
 252                 for ( var styleName in styleDefs )\r
 253                 {\r
 254                         // Core styles are prefixed with _FCK_.\r
 255                         var style = styles[ '_FCK_' + styleName ] = new FCKStyle( styleDefs[ styleName ] ) ;\r
 256                         style.IsCore = true ;\r
 257                 }\r
 258                 return styles ;\r
 259         },\r
 260 \r
 261         _LoadStylesCustom : function()\r
 262         {\r
 263                 var styles = {};\r
 264                 var styleDefs = FCKConfig.CustomStyles ;\r
 265 \r
 266                 if ( styleDefs )\r
 267                 {\r
 268                         for ( var styleName in styleDefs )\r
 269                         {\r
 270                                 var style = styles[ styleName ] = new FCKStyle( styleDefs[ styleName ] ) ;\r
 271                                 style.Name = styleName ;\r
 272                         }\r
 273                 }\r
 274 \r
 275                 return styles ;\r
 276         },\r
 277 \r
 278         _LoadStylesXml : function()\r
 279         {\r
 280                 var styles = {};\r
 281 \r
 282                 var stylesXmlPath = FCKConfig.StylesXmlPath ;\r
 283 \r
 284                 if ( !stylesXmlPath || stylesXmlPath.length == 0 )\r
 285                         return styles ;\r
 286 \r
 287                 // Load the XML file into a FCKXml object.\r
 288                 var xml = new FCKXml() ;\r
 289                 xml.LoadUrl( stylesXmlPath ) ;\r
 290 \r
 291                 var stylesXmlObj = FCKXml.TransformToObject( xml.SelectSingleNode( 'Styles' ) ) ;\r
 292 \r
 293                 // Get the "Style" nodes defined in the XML file.\r
 294                 var styleNodes = stylesXmlObj.$Style ;\r
 295 \r
 296                 // Check that it did contain some valid nodes\r
 297                 if ( !styleNodes )\r
 298                         return styles ;\r
 299 \r
 300                 // Add each style to our "Styles" collection.\r
 301                 for ( var i = 0 ; i < styleNodes.length ; i++ )\r
 302                 {\r
 303                         var styleNode = styleNodes[i] ;\r
 304 \r
 305                         var element = ( styleNode.element || '' ).toLowerCase() ;\r
 306 \r
 307                         if ( element.length == 0 )\r
 308                                 throw( 'The element name is required. Error loading "' + stylesXmlPath + '"' ) ;\r
 309 \r
 310                         var styleDef = {\r
 311                                 Element : element,\r
 312                                 Attributes : {},\r
 313                                 Styles : {},\r
 314                                 Overrides : []\r
 315                         } ;\r
 316 \r
 317                         // Get the attributes defined for the style (if any).\r
 318                         var attNodes = styleNode.$Attribute || [] ;\r
 319 \r
 320                         // Add the attributes to the style definition object.\r
 321                         for ( var j = 0 ; j < attNodes.length ; j++ )\r
 322                         {\r
 323                                 styleDef.Attributes[ attNodes[j].name ] = attNodes[j].value ;\r
 324                         }\r
 325 \r
 326                         // Get the styles defined for the style (if any).\r
 327                         var cssStyleNodes = styleNode.$Style || [] ;\r
 328 \r
 329                         // Add the attributes to the style definition object.\r
 330                         for ( j = 0 ; j < cssStyleNodes.length ; j++ )\r
 331                         {\r
 332                                 styleDef.Styles[ cssStyleNodes[j].name ] = cssStyleNodes[j].value ;\r
 333                         }\r
 334 \r
 335                         // Load override definitions.\r
 336                         var cssStyleOverrideNodes = styleNode.$Override ;\r
 337                         if ( cssStyleOverrideNodes )\r
 338                         {\r
 339                                 for ( j = 0 ; j < cssStyleOverrideNodes.length ; j++ )\r
 340                                 {\r
 341                                         var overrideNode = cssStyleOverrideNodes[j] ;\r
 342                                         var overrideDef =\r
 343                                         {\r
 344                                                 Element : overrideNode.element\r
 345                                         } ;\r
 346 \r
 347                                         var overrideAttNode = overrideNode.$Attribute ;\r
 348                                         if ( overrideAttNode )\r
 349                                         {\r
 350                                                 overrideDef.Attributes = {} ;\r
 351                                                 for ( var k = 0 ; k < overrideAttNode.length ; k++ )\r
 352                                                 {\r
 353                                                         var overrideAttValue = overrideAttNode[k].value || null ;\r
 354                                                         if ( overrideAttValue )\r
 355                                                         {\r
 356                                                                 // Check if the override attribute value is a regular expression.\r
 357                                                                 var regexMatch = overrideAttValue && FCKRegexLib.RegExp.exec( overrideAttValue ) ;\r
 358                                                                 if ( regexMatch )\r
 359                                                                         overrideAttValue = new RegExp( regexMatch[1], regexMatch[2] || '' ) ;\r
 360                                                         }\r
 361                                                         overrideDef.Attributes[ overrideAttNode[k].name ] = overrideAttValue ;\r
 362                                                 }\r
 363                                         }\r
 364 \r
 365                                         styleDef.Overrides.push( overrideDef ) ;\r
 366                                 }\r
 367                         }\r
 368 \r
 369                         var style = new FCKStyle( styleDef ) ;\r
 370                         style.Name = styleNode.name || element ;\r
 371 \r
 372                         if ( style.GetType() == FCK_STYLE_OBJECT )\r
 373                                 this._ObjectStyles[ element ] = true ;\r
 374 \r
 375                         // Add the style to the "Styles" collection using it's name as the key.\r
 376                         styles[ style.Name ] = style ;\r
 377                 }\r
 378 \r
 379                 return styles ;\r
 380         }\r
 381 } ;\r