_source/plugins/indent/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2010, 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 Increse and decrease indent commands.\r
   8  */\r
   9 \r
  10 (function()\r
  11 {\r
  12         var listNodeNames = { ol : 1, ul : 1 };\r
  13 \r
  14         var isNotWhitespaces = CKEDITOR.dom.walker.whitespaces( true ),\r
  15                 isNotBookmark = CKEDITOR.dom.walker.bookmark( false, true );\r
  16 \r
  17         function setState( editor, state )\r
  18         {\r
  19                 editor.getCommand( this.name ).setState( state );\r
  20         }\r
  21 \r
  22         function onSelectionChange( evt )\r
  23         {\r
  24                 var editor = evt.editor;\r
  25 \r
  26                 var elementPath = evt.data.path,\r
  27                                 list = elementPath && elementPath.contains( listNodeNames );\r
  28 \r
  29                 if ( list )\r
  30                                 return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  31 \r
  32                 if ( !this.useIndentClasses && this.name == 'indent' )\r
  33                         return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  34 \r
  35                 var path = evt.data.path,\r
  36                         firstBlock = path.block || path.blockLimit;\r
  37                 if ( !firstBlock )\r
  38                         return setState.call( this, editor, CKEDITOR.TRISTATE_DISABLED );\r
  39 \r
  40                 if ( this.useIndentClasses )\r
  41                 {\r
  42                         var indentClass = firstBlock.$.className.match( this.classNameRegex ),\r
  43                                 indentStep = 0;\r
  44                         if ( indentClass )\r
  45                         {\r
  46                                 indentClass = indentClass[1];\r
  47                                 indentStep = this.indentClassMap[ indentClass ];\r
  48                         }\r
  49                         if ( ( this.name == 'outdent' && !indentStep ) ||\r
  50                                         ( this.name == 'indent' && indentStep == editor.config.indentClasses.length ) )\r
  51                                 return setState.call( this, editor, CKEDITOR.TRISTATE_DISABLED );\r
  52                         return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  53                 }\r
  54                 else\r
  55                 {\r
  56                         var indent = parseInt( firstBlock.getStyle( getIndentCssProperty( firstBlock ) ), 10 );\r
  57                         if ( isNaN( indent ) )\r
  58                                 indent = 0;\r
  59                         if ( indent <= 0 )\r
  60                                 return setState.call( this, editor, CKEDITOR.TRISTATE_DISABLED );\r
  61                         return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  62                 }\r
  63         }\r
  64 \r
  65         function indentCommand( editor, name )\r
  66         {\r
  67                 this.name = name;\r
  68                 this.useIndentClasses = editor.config.indentClasses && editor.config.indentClasses.length > 0;\r
  69                 if ( this.useIndentClasses )\r
  70                 {\r
  71                         this.classNameRegex = new RegExp( '(?:^|\\s+)(' + editor.config.indentClasses.join( '|' ) + ')(?=$|\\s)' );\r
  72                         this.indentClassMap = {};\r
  73                         for ( var i = 0 ; i < editor.config.indentClasses.length ; i++ )\r
  74                                 this.indentClassMap[ editor.config.indentClasses[i] ] = i + 1;\r
  75                 }\r
  76 \r
  77                 this.startDisabled = name == 'outdent';\r
  78         }\r
  79 \r
  80         // Returns the CSS property to be used for identing a given element.\r
  81         function getIndentCssProperty( element )\r
  82         {\r
  83                 return element.getComputedStyle( 'direction' ) == 'ltr' ? 'margin-left' : 'margin-right';\r
  84         }\r
  85 \r
  86         function isListItem( node )\r
  87         {\r
  88                 return node.type = CKEDITOR.NODE_ELEMENT && node.is( 'li' );\r
  89         }\r
  90 \r
  91         indentCommand.prototype = {\r
  92                 exec : function( editor )\r
  93                 {\r
  94                         var self = this, database = {};\r
  95 \r
  96                         function indentList( listNode )\r
  97                         {\r
  98                                 // Our starting and ending points of the range might be inside some blocks under a list item...\r
  99                                 // So before playing with the iterator, we need to expand the block to include the list items.\r
 100                                 var startContainer = range.startContainer,\r
 101                                         endContainer = range.endContainer;\r
 102                                 while ( startContainer && !startContainer.getParent().equals( listNode ) )\r
 103                                         startContainer = startContainer.getParent();\r
 104                                 while ( endContainer && !endContainer.getParent().equals( listNode ) )\r
 105                                         endContainer = endContainer.getParent();\r
 106 \r
 107                                 if ( !startContainer || !endContainer )\r
 108                                         return;\r
 109 \r
 110                                 // Now we can iterate over the individual items on the same tree depth.\r
 111                                 var block = startContainer,\r
 112                                         itemsToMove = [],\r
 113                                         stopFlag = false;\r
 114                                 while ( !stopFlag )\r
 115                                 {\r
 116                                         if ( block.equals( endContainer ) )\r
 117                                                 stopFlag = true;\r
 118                                         itemsToMove.push( block );\r
 119                                         block = block.getNext();\r
 120                                 }\r
 121                                 if ( itemsToMove.length < 1 )\r
 122                                         return;\r
 123 \r
 124                                 // Do indent or outdent operations on the array model of the list, not the\r
 125                                 // list's DOM tree itself. The array model demands that it knows as much as\r
 126                                 // possible about the surrounding lists, we need to feed it the further\r
 127                                 // ancestor node that is still a list.\r
 128                                 var listParents = listNode.getParents( true );\r
 129                                 for ( var i = 0 ; i < listParents.length ; i++ )\r
 130                                 {\r
 131                                         if ( listParents[i].getName && listNodeNames[ listParents[i].getName() ] )\r
 132                                         {\r
 133                                                 listNode = listParents[i];\r
 134                                                 break;\r
 135                                         }\r
 136                                 }\r
 137                                 var indentOffset = self.name == 'indent' ? 1 : -1,\r
 138                                         startItem = itemsToMove[0],\r
 139                                         lastItem = itemsToMove[ itemsToMove.length - 1 ];\r
 140 \r
 141                                 // Convert the list DOM tree into a one dimensional array.\r
 142                                 var listArray = CKEDITOR.plugins.list.listToArray( listNode, database );\r
 143 \r
 144                                 // Apply indenting or outdenting on the array.\r
 145                                 var baseIndent = listArray[ lastItem.getCustomData( 'listarray_index' ) ].indent;\r
 146                                 for ( i = startItem.getCustomData( 'listarray_index' ); i <= lastItem.getCustomData( 'listarray_index' ); i++ )\r
 147                                 {\r
 148                                         listArray[ i ].indent += indentOffset;\r
 149                                         // Make sure the newly created sublist get a brand-new element of the same type. (#5372)\r
 150                                         var listRoot = listArray[ i ].parent;\r
 151                                         listArray[ i ].parent = new CKEDITOR.dom.element( listRoot.getName(), listRoot.getDocument() );\r
 152                                 }\r
 153 \r
 154                                 for ( i = lastItem.getCustomData( 'listarray_index' ) + 1 ;\r
 155                                                 i < listArray.length && listArray[i].indent > baseIndent ; i++ )\r
 156                                         listArray[i].indent += indentOffset;\r
 157 \r
 158                                 // Convert the array back to a DOM forest (yes we might have a few subtrees now).\r
 159                                 // And replace the old list with the new forest.\r
 160                                 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode, 0 );\r
 161 \r
 162                                 // Avoid nested <li> after outdent even they're visually same,\r
 163                                 // recording them for later refactoring.(#3982)\r
 164                                 if ( self.name == 'outdent' )\r
 165                                 {\r
 166                                         var parentLiElement;\r
 167                                         if ( ( parentLiElement = listNode.getParent() ) && parentLiElement.is( 'li' ) )\r
 168                                         {\r
 169                                                 var children = newList.listNode.getChildren(),\r
 170                                                         pendingLis = [],\r
 171                                                         count = children.count(),\r
 172                                                         child;\r
 173 \r
 174                                                 for ( i = count - 1 ; i >= 0 ; i-- )\r
 175                                                 {\r
 176                                                         if ( ( child = children.getItem( i ) ) && child.is && child.is( 'li' )  )\r
 177                                                                 pendingLis.push( child );\r
 178                                                 }\r
 179                                         }\r
 180                                 }\r
 181 \r
 182                                 if ( newList )\r
 183                                         newList.listNode.replace( listNode );\r
 184 \r
 185                                 // Move the nested <li> to be appeared after the parent.\r
 186                                 if ( pendingLis && pendingLis.length )\r
 187                                 {\r
 188                                         for (  i = 0; i < pendingLis.length ; i++ )\r
 189                                         {\r
 190                                                 var li = pendingLis[ i ],\r
 191                                                         followingList = li;\r
 192 \r
 193                                                 // Nest preceding <ul>/<ol> inside current <li> if any.\r
 194                                                 while ( ( followingList = followingList.getNext() ) &&\r
 195                                                            followingList.is &&\r
 196                                                            followingList.getName() in listNodeNames )\r
 197                                                 {\r
 198                                                         // IE requires a filler NBSP for nested list inside empty list item,\r
 199                                                         // otherwise the list item will be inaccessiable. (#4476)\r
 200                                                         if ( CKEDITOR.env.ie && !li.getFirst( function( node ){ return isNotWhitespaces( node ) && isNotBookmark( node ); } ) )\r
 201                                                                 li.append( range.document.createText( '\u00a0' ) );\r
 202 \r
 203                                                         li.append( followingList );\r
 204                                                 }\r
 205 \r
 206                                                 li.insertAfter( parentLiElement );\r
 207                                         }\r
 208                                 }\r
 209                         }\r
 210 \r
 211                         function indentBlock()\r
 212                         {\r
 213                                 var iterator = range.createIterator(),\r
 214                                         enterMode = editor.config.enterMode;\r
 215                                 iterator.enforceRealBlocks = true;\r
 216                                 iterator.enlargeBr = enterMode != CKEDITOR.ENTER_BR;\r
 217                                 var block;\r
 218                                 while ( ( block = iterator.getNextParagraph() ) )\r
 219                                         indentElement( block );\r
 220                         }\r
 221 \r
 222                         function indentElement( element )\r
 223                         {\r
 224                                 if ( element.getCustomData( 'indent_processed' ) )\r
 225                                         return false;\r
 226 \r
 227                                 if ( self.useIndentClasses )\r
 228                                 {\r
 229                                         // Transform current class name to indent step index.\r
 230                                         var indentClass = element.$.className.match( self.classNameRegex ),\r
 231                                                         indentStep = 0;\r
 232                                         if ( indentClass )\r
 233                                         {\r
 234                                                 indentClass = indentClass[1];\r
 235                                                 indentStep = self.indentClassMap[ indentClass ];\r
 236                                         }\r
 237 \r
 238                                         // Operate on indent step index, transform indent step index back to class\r
 239                                         // name.\r
 240                                         if ( self.name == 'outdent' )\r
 241                                                 indentStep--;\r
 242                                         else\r
 243                                                 indentStep++;\r
 244 \r
 245                                         if ( indentStep < 0 )\r
 246                                                 return false;\r
 247 \r
 248                                         indentStep = Math.min( indentStep, editor.config.indentClasses.length );\r
 249                                         indentStep = Math.max( indentStep, 0 );\r
 250                                         var className = CKEDITOR.tools.ltrim( element.$.className.replace( self.classNameRegex, '' ) );\r
 251                                         if ( indentStep < 1 )\r
 252                                                 element.$.className = className;\r
 253                                         else\r
 254                                                 element.addClass( editor.config.indentClasses[ indentStep - 1 ] );\r
 255                                 }\r
 256                                 else\r
 257                                 {\r
 258                                         var indentCssProperty = getIndentCssProperty( element );\r
 259                                         var currentOffset = parseInt( element.getStyle( indentCssProperty ), 10 );\r
 260                                         if ( isNaN( currentOffset ) )\r
 261                                                 currentOffset = 0;\r
 262                                         currentOffset += ( self.name == 'indent' ? 1 : -1 ) * editor.config.indentOffset;\r
 263 \r
 264                                         if ( currentOffset < 0 )\r
 265                                                 return false;\r
 266 \r
 267                                         currentOffset = Math.max( currentOffset, 0 );\r
 268                                         currentOffset = Math.ceil( currentOffset / editor.config.indentOffset ) * editor.config.indentOffset;\r
 269                                         element.setStyle( indentCssProperty, currentOffset ? currentOffset + editor.config.indentUnit : '' );\r
 270                                         if ( element.getAttribute( 'style' ) === '' )\r
 271                                                 element.removeAttribute( 'style' );\r
 272                                 }\r
 273 \r
 274                                 CKEDITOR.dom.element.setMarker( database, element, 'indent_processed', true );\r
 275                                 return true;\r
 276                         }\r
 277 \r
 278                         var selection = editor.getSelection(),\r
 279                                 bookmarks = selection.createBookmarks( true ),\r
 280                                 ranges = selection && selection.getRanges( true ),\r
 281                                 range;\r
 282 \r
 283                         var iterator = ranges.createIterator();\r
 284                         while ( ( range = iterator.getNextRange() ) )\r
 285                         {\r
 286                                 var startContainer = range.startContainer,\r
 287                                         endContainer = range.endContainer,\r
 288                                         rangeRoot = range.getCommonAncestor(),\r
 289                                         nearestListBlock = rangeRoot;\r
 290 \r
 291                                 while ( nearestListBlock && !( nearestListBlock.type == CKEDITOR.NODE_ELEMENT &&\r
 292                                         listNodeNames[ nearestListBlock.getName() ] ) )\r
 293                                         nearestListBlock = nearestListBlock.getParent();\r
 294 \r
 295                                 // Avoid selection anchors under list root.\r
 296                                 // <ul>[<li>...</li>]</ul> =>   <ul><li>[...]</li></ul>\r
 297                                 if ( nearestListBlock && startContainer.type == CKEDITOR.NODE_ELEMENT\r
 298                                         && startContainer.getName() in listNodeNames )\r
 299                                 {\r
 300                                         var walker = new CKEDITOR.dom.walker( range );\r
 301                                         walker.evaluator = isListItem;\r
 302                                         range.startContainer = walker.next();\r
 303                                 }\r
 304 \r
 305                                 if ( nearestListBlock && endContainer.type == CKEDITOR.NODE_ELEMENT\r
 306                                         && endContainer.getName() in listNodeNames )\r
 307                                 {\r
 308                                         walker = new CKEDITOR.dom.walker( range );\r
 309                                         walker.evaluator = isListItem;\r
 310                                         range.endContainer = walker.previous();\r
 311                                 }\r
 312 \r
 313                                 if ( nearestListBlock  )\r
 314                                 {\r
 315                                         var firstListItem = nearestListBlock.getFirst( function( node )\r
 316                                                 {\r
 317                                                         return node.type == CKEDITOR.NODE_ELEMENT && node.is( 'li' );\r
 318                                                 }),\r
 319                                                 rangeStart = range.startContainer,\r
 320                                                 indentWholeList = firstListItem.equals( rangeStart ) || firstListItem.contains( rangeStart );\r
 321 \r
 322                                         // Indent the entire list if  cursor is inside the first list item. (#3893)\r
 323                                         if ( !( indentWholeList && indentElement( nearestListBlock ) ) )\r
 324                                                 indentList( nearestListBlock );\r
 325                                 }\r
 326                                 else\r
 327                                         indentBlock();\r
 328                         }\r
 329 \r
 330                         // Clean up the markers.\r
 331                         CKEDITOR.dom.element.clearAllMarkers( database );\r
 332 \r
 333                         editor.forceNextSelectionCheck();\r
 334                         selection.selectBookmarks( bookmarks );\r
 335                 }\r
 336         };\r
 337 \r
 338         CKEDITOR.plugins.add( 'indent',\r
 339         {\r
 340                 init : function( editor )\r
 341                 {\r
 342                         // Register commands.\r
 343                         var indent = new indentCommand( editor, 'indent' ),\r
 344                                 outdent = new indentCommand( editor, 'outdent' );\r
 345                         editor.addCommand( 'indent', indent );\r
 346                         editor.addCommand( 'outdent', outdent );\r
 347 \r
 348                         // Register the toolbar buttons.\r
 349                         editor.ui.addButton( 'Indent',\r
 350                                 {\r
 351                                         label : editor.lang.indent,\r
 352                                         command : 'indent'\r
 353                                 });\r
 354                         editor.ui.addButton( 'Outdent',\r
 355                                 {\r
 356                                         label : editor.lang.outdent,\r
 357                                         command : 'outdent'\r
 358                                 });\r
 359 \r
 360                         // Register the state changing handlers.\r
 361                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, indent ) );\r
 362                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, outdent ) );\r
 363 \r
 364                         // [IE6/7] Raw lists are using margin instead of padding for visual indentation in wysiwyg mode. (#3893)\r
 365                         if ( CKEDITOR.env.ie6Compat || CKEDITOR.env.ie7Compat )\r
 366                         {\r
 367                                 editor.addCss(\r
 368                                         "ul,ol" +\r
 369                                         "{" +\r
 370                                         "       margin-left: 0px;" +\r
 371                                         "       padding-left: 40px;" +\r
 372                                         "}" );\r
 373                         }\r
 374                 },\r
 375 \r
 376                 requires : [ 'domiterator', 'list' ]\r
 377         } );\r
 378 })();\r
 379 \r
 380 CKEDITOR.tools.extend( CKEDITOR.config,\r
 381         {\r
 382                 indentOffset : 40,\r
 383                 indentUnit : 'px',\r
 384                 indentClasses : null\r
 385         });\r
 386 \r
 387 /**\r
 388  * Size of each indentation step\r
 389  * @type Number\r
 390  * @example\r
 391  * config.indentOffset = 40;\r
 392  */\r
 393 \r
 394  /**\r
 395  * Unit for the indentation style\r
 396  * @type String\r
 397  * @example\r
 398  * config.indentUnit = 'px';\r
 399  */\r
 400 \r
 401  /**\r
 402  * List of classes to use for indenting the contents.\r
 403  * @type Array\r
 404  * @example\r
 405  * // Don't use classes for indenting. (this is the default value)\r
 406  * config.indentClasses = null;\r
 407  * @example\r
 408  * // Use the classes 'Indent1', 'Indent2', 'Indent3'\r
 409  * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];\r
 410  */\r
 411 \r
 412 /**\r
 413  * Size of each indentation step\r
 414  * @type Number\r
 415  * @default 40\r
 416  * @example\r
 417  * config.indentOffset = 4;\r
 418  */\r
 419 \r
 420  /**\r
 421  * Unit for the indentation style\r
 422  * @type String\r
 423  * @default 'px'\r
 424  * @example\r
 425  * config.indentUnit = 'em';\r
 426  */\r
 427 \r
 428  /**\r
 429  * List of classes to use for indenting the contents. If it's null, no classes will be used\r
 430  * and instead the {@link #indentUnit} and {@link #indentOffset} properties will be used.\r
 431  * @type Array\r
 432  * default null\r
 433  * @example\r
 434  * // Use the classes 'Indent1', 'Indent2', 'Indent3'\r
 435  * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];\r
 436  */\r