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