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