_source/plugins/indent/plugin.js

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