_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 elements = evt.data.path.elements,\r
  25                         listNode, listItem,\r
  26                         editor = evt.editor;\r
  27 \r
  28                 for ( var i = 0 ; i < elements.length ; i++ )\r
  29                 {\r
  30                         if ( elements[i].getName() == 'li' )\r
  31                         {\r
  32                                 listItem = elements[i];\r
  33                                 continue;\r
  34                         }\r
  35                         if ( listNodeNames[ elements[i].getName() ] )\r
  36                         {\r
  37                                 listNode = elements[i];\r
  38                                 break;\r
  39                         }\r
  40                 }\r
  41 \r
  42                 if ( listNode )\r
  43                 {\r
  44                         if ( this.name == 'outdent' )\r
  45                                 return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  46                         else\r
  47                         {\r
  48                                 while ( listItem && ( listItem = listItem.getPrevious( CKEDITOR.dom.walker.whitespaces( true ) ) ) )\r
  49                                 {\r
  50                                         if ( listItem.getName && listItem.getName() == 'li' )\r
  51                                                 return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  52                                 }\r
  53                                 return setState.call( this, editor, CKEDITOR.TRISTATE_DISABLED );\r
  54                         }\r
  55                 }\r
  56 \r
  57                 if ( !this.useIndentClasses && this.name == 'indent' )\r
  58                         return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  59 \r
  60                 var path = evt.data.path,\r
  61                         firstBlock = path.block || path.blockLimit;\r
  62                 if ( !firstBlock )\r
  63                         return setState.call( this, editor, CKEDITOR.TRISTATE_DISABLED );\r
  64 \r
  65                 if ( this.useIndentClasses )\r
  66                 {\r
  67                         var indentClass = firstBlock.$.className.match( this.classNameRegex ),\r
  68                                 indentStep = 0;\r
  69                         if ( indentClass )\r
  70                         {\r
  71                                 indentClass = indentClass[1];\r
  72                                 indentStep = this.indentClassMap[ indentClass ];\r
  73                         }\r
  74                         if ( ( this.name == 'outdent' && !indentStep ) ||\r
  75                                         ( this.name == 'indent' && indentStep == editor.config.indentClasses.length ) )\r
  76                                 return setState.call( this, editor, CKEDITOR.TRISTATE_DISABLED );\r
  77                         return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  78                 }\r
  79                 else\r
  80                 {\r
  81                         var indent = parseInt( firstBlock.getStyle( this.indentCssProperty ), 10 );\r
  82                         if ( isNaN( indent ) )\r
  83                                 indent = 0;\r
  84                         if ( indent <= 0 )\r
  85                                 return setState.call( this, editor, CKEDITOR.TRISTATE_DISABLED );\r
  86                         return setState.call( this, editor, CKEDITOR.TRISTATE_OFF );\r
  87                 }\r
  88         }\r
  89 \r
  90         function indentList( editor, range, listNode )\r
  91         {\r
  92                 // Our starting and ending points of the range might be inside some blocks under a list item...\r
  93                 // So before playing with the iterator, we need to expand the block to include the list items.\r
  94                 var startContainer = range.startContainer,\r
  95                         endContainer = range.endContainer;\r
  96                 while ( startContainer && !startContainer.getParent().equals( listNode ) )\r
  97                         startContainer = startContainer.getParent();\r
  98                 while ( endContainer && !endContainer.getParent().equals( listNode ) )\r
  99                         endContainer = endContainer.getParent();\r
 100 \r
 101                 if ( !startContainer || !endContainer )\r
 102                         return;\r
 103 \r
 104                 // Now we can iterate over the individual items on the same tree depth.\r
 105                 var block = startContainer,\r
 106                         itemsToMove = [],\r
 107                         stopFlag = false;\r
 108                 while ( !stopFlag )\r
 109                 {\r
 110                         if ( block.equals( endContainer ) )\r
 111                                 stopFlag = true;\r
 112                         itemsToMove.push( block );\r
 113                         block = block.getNext();\r
 114                 }\r
 115                 if ( itemsToMove.length < 1 )\r
 116                         return;\r
 117 \r
 118                 // Do indent or outdent operations on the array model of the list, not the\r
 119                 // list's DOM tree itself. The array model demands that it knows as much as\r
 120                 // possible about the surrounding lists, we need to feed it the further\r
 121                 // ancestor node that is still a list.\r
 122                 var listParents = listNode.getParents( true );\r
 123                 for ( var i = 0 ; i < listParents.length ; i++ )\r
 124                 {\r
 125                         if ( listParents[i].getName && listNodeNames[ listParents[i].getName() ] )\r
 126                         {\r
 127                                 listNode = listParents[i];\r
 128                                 break;\r
 129                         }\r
 130                 }\r
 131                 var indentOffset = this.name == 'indent' ? 1 : -1,\r
 132                         startItem = itemsToMove[0],\r
 133                         lastItem = itemsToMove[ itemsToMove.length - 1 ],\r
 134                         database = {};\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, 0 );\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 ( this.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                 // Clean up the markers.\r
 206                 CKEDITOR.dom.element.clearAllMarkers( database );\r
 207         }\r
 208 \r
 209         function indentBlock( editor, range )\r
 210         {\r
 211                 var iterator = range.createIterator(),\r
 212                         enterMode = editor.config.enterMode;\r
 213                 iterator.enforceRealBlocks = true;\r
 214                 iterator.enlargeBr = enterMode != CKEDITOR.ENTER_BR;\r
 215                 var block;\r
 216                 while ( ( block = iterator.getNextParagraph() ) )\r
 217                 {\r
 218 \r
 219                         if ( this.useIndentClasses )\r
 220                         {\r
 221                                 // Transform current class name to indent step index.\r
 222                                 var indentClass = block.$.className.match( this.classNameRegex ),\r
 223                                         indentStep = 0;\r
 224                                 if ( indentClass )\r
 225                                 {\r
 226                                         indentClass = indentClass[1];\r
 227                                         indentStep = this.indentClassMap[ indentClass ];\r
 228                                 }\r
 229 \r
 230                                 // Operate on indent step index, transform indent step index back to class\r
 231                                 // name.\r
 232                                 if ( this.name == 'outdent' )\r
 233                                         indentStep--;\r
 234                                 else\r
 235                                         indentStep++;\r
 236                                 indentStep = Math.min( indentStep, editor.config.indentClasses.length );\r
 237                                 indentStep = Math.max( indentStep, 0 );\r
 238                                 var className = CKEDITOR.tools.ltrim( block.$.className.replace( this.classNameRegex, '' ) );\r
 239                                 if ( indentStep < 1 )\r
 240                                         block.$.className = className;\r
 241                                 else\r
 242                                         block.$.className = CKEDITOR.tools.ltrim( className + ' ' + editor.config.indentClasses[ indentStep - 1 ] );\r
 243                         }\r
 244                         else\r
 245                         {\r
 246                                 var currentOffset = parseInt( block.getStyle( this.indentCssProperty ), 10 );\r
 247                                 if ( isNaN( currentOffset ) )\r
 248                                         currentOffset = 0;\r
 249                                 currentOffset += ( this.name == 'indent' ? 1 : -1 ) * editor.config.indentOffset;\r
 250                                 currentOffset = Math.max( currentOffset, 0 );\r
 251                                 currentOffset = Math.ceil( currentOffset / editor.config.indentOffset ) * editor.config.indentOffset;\r
 252                                 block.setStyle( this.indentCssProperty, currentOffset ? currentOffset + editor.config.indentUnit : '' );\r
 253                                 if ( block.getAttribute( 'style' ) === '' )\r
 254                                         block.removeAttribute( 'style' );\r
 255                         }\r
 256                 }\r
 257         }\r
 258 \r
 259         function indentCommand( editor, name )\r
 260         {\r
 261                 this.name = name;\r
 262                 this.useIndentClasses = editor.config.indentClasses && editor.config.indentClasses.length > 0;\r
 263                 if ( this.useIndentClasses )\r
 264                 {\r
 265                         this.classNameRegex = new RegExp( '(?:^|\\s+)(' + editor.config.indentClasses.join( '|' ) + ')(?=$|\\s)' );\r
 266                         this.indentClassMap = {};\r
 267                         for ( var i = 0 ; i < editor.config.indentClasses.length ; i++ )\r
 268                                 this.indentClassMap[ editor.config.indentClasses[i] ] = i + 1;\r
 269                 }\r
 270                 else\r
 271                         this.indentCssProperty = editor.config.contentsLangDirection == 'ltr' ? 'margin-left' : 'margin-right';\r
 272                 this.startDisabled = name == 'outdent';\r
 273         }\r
 274 \r
 275         indentCommand.prototype = {\r
 276                 exec : function( editor )\r
 277                 {\r
 278                         var selection = editor.getSelection(),\r
 279                                 range = selection && selection.getRanges()[0];\r
 280 \r
 281                         if ( !selection || !range )\r
 282                                 return;\r
 283 \r
 284                         var bookmarks = selection.createBookmarks( true ),\r
 285                                 nearestListBlock = range.getCommonAncestor();\r
 286 \r
 287                         while ( nearestListBlock && !( nearestListBlock.type == CKEDITOR.NODE_ELEMENT &&\r
 288                                 listNodeNames[ nearestListBlock.getName() ] ) )\r
 289                                 nearestListBlock = nearestListBlock.getParent();\r
 290 \r
 291                         if ( nearestListBlock )\r
 292                                 indentList.call( this, editor, range, nearestListBlock );\r
 293                         else\r
 294                                 indentBlock.call( this, editor, range );\r
 295 \r
 296                         editor.focus();\r
 297                         editor.forceNextSelectionCheck();\r
 298                         selection.selectBookmarks( bookmarks );\r
 299                 }\r
 300         };\r
 301 \r
 302         CKEDITOR.plugins.add( 'indent',\r
 303         {\r
 304                 init : function( editor )\r
 305                 {\r
 306                         // Register commands.\r
 307                         var indent = new indentCommand( editor, 'indent' ),\r
 308                                 outdent = new indentCommand( editor, 'outdent' );\r
 309                         editor.addCommand( 'indent', indent );\r
 310                         editor.addCommand( 'outdent', outdent );\r
 311 \r
 312                         // Register the toolbar buttons.\r
 313                         editor.ui.addButton( 'Indent',\r
 314                                 {\r
 315                                         label : editor.lang.indent,\r
 316                                         command : 'indent'\r
 317                                 });\r
 318                         editor.ui.addButton( 'Outdent',\r
 319                                 {\r
 320                                         label : editor.lang.outdent,\r
 321                                         command : 'outdent'\r
 322                                 });\r
 323 \r
 324                         // Register the state changing handlers.\r
 325                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, indent ) );\r
 326                         editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, outdent ) );\r
 327                 },\r
 328 \r
 329                 requires : [ 'domiterator', 'list' ]\r
 330         } );\r
 331 })();\r
 332 \r
 333 CKEDITOR.tools.extend( CKEDITOR.config,\r
 334         {\r
 335                 indentOffset : 40,\r
 336                 indentUnit : 'px',\r
 337                 indentClasses : null\r
 338         });\r
 339 \r
 340 /**\r
 341  * Size of each indentation step\r
 342  * @type Number\r
 343  * @example\r
 344  * config.indentOffset = 40;\r
 345  */\r
 346 \r
 347  /**\r
 348  * Unit for the indentation style\r
 349  * @type String\r
 350  * @example\r
 351  * config.indentUnit = 'px';\r
 352  */\r
 353 \r
 354  /**\r
 355  * List of classes to use for indenting the contents.\r
 356  * @type Array\r
 357  * @example\r
 358  * // Don't use classes for indenting. (this is the default value)\r
 359  * config.indentClasses = null;\r
 360  * @example\r
 361  * // Use the classes 'Indent1', 'Indent2', 'Indent3'\r
 362  * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];\r
 363  */\r
 364 \r
 365 /**\r
 366  * Size of each indentation step\r
 367  * @type Number\r
 368  * @default 40\r
 369  * @example\r
 370  * config.indentOffset = 4;\r
 371  */\r
 372 \r
 373  /**\r
 374  * Unit for the indentation style\r
 375  * @type String\r
 376  * @default 'px'\r
 377  * @example\r
 378  * config.indentUnit = 'em';\r
 379  */\r
 380 \r
 381  /**\r
 382  * List of classes to use for indenting the contents. If it's null, no classes will be used\r
 383  * and instead the {@link #indentUnit} and {@link #indentOffset} properties will be used.\r
 384  * @type Array\r
 385  * default null\r
 386  * @example\r
 387  * // Use the classes 'Indent1', 'Indent2', 'Indent3'\r
 388  * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];\r
 389  */\r