_source/plugins/enterkey/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 (function()\r
   7 {\r
   8         CKEDITOR.plugins.add( 'enterkey',\r
   9         {\r
  10                 requires : [ 'keystrokes', 'indent' ],\r
  11 \r
  12                 init : function( editor )\r
  13                 {\r
  14                         var specialKeys = editor.specialKeys;\r
  15                         specialKeys[ 13 ] = enter;\r
  16                         specialKeys[ CKEDITOR.SHIFT + 13 ] = shiftEnter;\r
  17                 }\r
  18         });\r
  19 \r
  20         CKEDITOR.plugins.enterkey =\r
  21         {\r
  22                 enterBlock : function( editor, mode, range, forceMode )\r
  23                 {\r
  24                         // Get the range for the current selection.\r
  25                         range = range || getRange( editor );\r
  26 \r
  27                         // We may not have valid ranges to work on, like when inside a\r
  28                         // contenteditable=false element.\r
  29                         if ( !range )\r
  30                                 return;\r
  31 \r
  32                         var doc = range.document;\r
  33 \r
  34                         // Exit the list when we're inside an empty list item block. (#5376)\r
  35                         if ( range.checkStartOfBlock() && range.checkEndOfBlock() )\r
  36                         {\r
  37                                 var path = new CKEDITOR.dom.elementPath( range.startContainer ),\r
  38                                                 block = path.block;\r
  39 \r
  40                                 if ( block && ( block.is( 'li' ) || block.getParent().is( 'li' ) ) )\r
  41                                 {\r
  42                                         editor.execCommand( 'outdent' );\r
  43                                         return;\r
  44                                 }\r
  45                         }\r
  46 \r
  47                         // Determine the block element to be used.\r
  48                         var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );\r
  49 \r
  50                         // Split the range.\r
  51                         var splitInfo = range.splitBlock( blockTag );\r
  52 \r
  53                         if ( !splitInfo )\r
  54                                 return;\r
  55 \r
  56                         // Get the current blocks.\r
  57                         var previousBlock       = splitInfo.previousBlock,\r
  58                                 nextBlock               = splitInfo.nextBlock;\r
  59 \r
  60                         var isStartOfBlock      = splitInfo.wasStartOfBlock,\r
  61                                 isEndOfBlock    = splitInfo.wasEndOfBlock;\r
  62 \r
  63                         var node;\r
  64 \r
  65                         // If this is a block under a list item, split it as well. (#1647)\r
  66                         if ( nextBlock )\r
  67                         {\r
  68                                 node = nextBlock.getParent();\r
  69                                 if ( node.is( 'li' ) )\r
  70                                 {\r
  71                                         nextBlock.breakParent( node );\r
  72                                         nextBlock.move( nextBlock.getNext(), 1 );\r
  73                                 }\r
  74                         }\r
  75                         else if ( previousBlock && ( node = previousBlock.getParent() ) && node.is( 'li' ) )\r
  76                         {\r
  77                                 previousBlock.breakParent( node );\r
  78                                 range.moveToElementEditStart( previousBlock.getNext() );\r
  79                                 previousBlock.move( previousBlock.getPrevious() );\r
  80                         }\r
  81 \r
  82                         // If we have both the previous and next blocks, it means that the\r
  83                         // boundaries were on separated blocks, or none of them where on the\r
  84                         // block limits (start/end).\r
  85                         if ( !isStartOfBlock && !isEndOfBlock )\r
  86                         {\r
  87                                 // If the next block is an <li> with another list tree as the first\r
  88                                 // child, we'll need to append a filler (<br>/NBSP) or the list item\r
  89                                 // wouldn't be editable. (#1420)\r
  90                                 if ( nextBlock.is( 'li' )\r
  91                                          && ( node = nextBlock.getFirst( CKEDITOR.dom.walker.invisible( true ) ) )\r
  92                                          && node.is && node.is( 'ul', 'ol' ) )\r
  93                                         ( CKEDITOR.env.ie ? doc.createText( '\xa0' ) : doc.createElement( 'br' ) ).insertBefore( node );\r
  94 \r
  95                                 // Move the selection to the end block.\r
  96                                 if ( nextBlock )\r
  97                                         range.moveToElementEditStart( nextBlock );\r
  98                         }\r
  99                         else\r
 100                         {\r
 101                                 var newBlock,\r
 102                                         newBlockDir;\r
 103 \r
 104                                 if ( previousBlock )\r
 105                                 {\r
 106                                         // Do not enter this block if it's a header tag, or we are in\r
 107                                         // a Shift+Enter (#77). Create a new block element instead\r
 108                                         // (later in the code).\r
 109                                         if ( previousBlock.is( 'li' ) || !headerTagRegex.test( previousBlock.getName() ) )\r
 110                                         {\r
 111                                                 // Otherwise, duplicate the previous block.\r
 112                                                 newBlock = previousBlock.clone();\r
 113                                         }\r
 114                                 }\r
 115                                 else if ( nextBlock )\r
 116                                         newBlock = nextBlock.clone();\r
 117 \r
 118                                 if ( !newBlock )\r
 119                                 {\r
 120                                         newBlock = doc.createElement( blockTag );\r
 121                                         if ( previousBlock && ( newBlockDir = previousBlock.getDirection() ) )\r
 122                                                 newBlock.setAttribute( 'dir', newBlockDir );\r
 123                                 }\r
 124                                 // Force the enter block unless we're talking of a list item.\r
 125                                 else if ( forceMode && !newBlock.is( 'li' ) )\r
 126                                         newBlock.renameNode( blockTag );\r
 127 \r
 128                                 // Recreate the inline elements tree, which was available\r
 129                                 // before hitting enter, so the same styles will be available in\r
 130                                 // the new block.\r
 131                                 var elementPath = splitInfo.elementPath;\r
 132                                 if ( elementPath )\r
 133                                 {\r
 134                                         for ( var i = 0, len = elementPath.elements.length ; i < len ; i++ )\r
 135                                         {\r
 136                                                 var element = elementPath.elements[ i ];\r
 137 \r
 138                                                 if ( element.equals( elementPath.block ) || element.equals( elementPath.blockLimit ) )\r
 139                                                         break;\r
 140 \r
 141                                                 if ( CKEDITOR.dtd.$removeEmpty[ element.getName() ] )\r
 142                                                 {\r
 143                                                         element = element.clone();\r
 144                                                         newBlock.moveChildren( element );\r
 145                                                         newBlock.append( element );\r
 146                                                 }\r
 147                                         }\r
 148                                 }\r
 149 \r
 150                                 if ( !CKEDITOR.env.ie )\r
 151                                         newBlock.appendBogus();\r
 152 \r
 153                                 range.insertNode( newBlock );\r
 154 \r
 155                                 // This is tricky, but to make the new block visible correctly\r
 156                                 // we must select it.\r
 157                                 // The previousBlock check has been included because it may be\r
 158                                 // empty if we have fixed a block-less space (like ENTER into an\r
 159                                 // empty table cell).\r
 160                                 if ( CKEDITOR.env.ie && isStartOfBlock && ( !isEndOfBlock || !previousBlock.getChildCount() ) )\r
 161                                 {\r
 162                                         // Move the selection to the new block.\r
 163                                         range.moveToElementEditStart( isEndOfBlock ? previousBlock : newBlock );\r
 164                                         range.select();\r
 165                                 }\r
 166 \r
 167                                 // Move the selection to the new block.\r
 168                                 range.moveToElementEditStart( isStartOfBlock && !isEndOfBlock ? nextBlock : newBlock );\r
 169                 }\r
 170 \r
 171                         if ( !CKEDITOR.env.ie )\r
 172                         {\r
 173                                 if ( nextBlock )\r
 174                                 {\r
 175                                         // If we have split the block, adds a temporary span at the\r
 176                                         // range position and scroll relatively to it.\r
 177                                         var tmpNode = doc.createElement( 'span' );\r
 178 \r
 179                                         // We need some content for Safari.\r
 180                                         tmpNode.setHtml( '&nbsp;' );\r
 181 \r
 182                                         range.insertNode( tmpNode );\r
 183                                         tmpNode.scrollIntoView();\r
 184                                         range.deleteContents();\r
 185                                 }\r
 186                                 else\r
 187                                 {\r
 188                                         // We may use the above scroll logic for the new block case\r
 189                                         // too, but it gives some weird result with Opera.\r
 190                                         newBlock.scrollIntoView();\r
 191                                 }\r
 192                         }\r
 193 \r
 194                         range.select();\r
 195                 },\r
 196 \r
 197                 enterBr : function( editor, mode, range, forceMode )\r
 198                 {\r
 199                         // Get the range for the current selection.\r
 200                         range = range || getRange( editor );\r
 201 \r
 202                         // We may not have valid ranges to work on, like when inside a\r
 203                         // contenteditable=false element.\r
 204                         if ( !range )\r
 205                                 return;\r
 206 \r
 207                         var doc = range.document;\r
 208 \r
 209                         // Determine the block element to be used.\r
 210                         var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );\r
 211 \r
 212                         var isEndOfBlock = range.checkEndOfBlock();\r
 213 \r
 214                         var elementPath = new CKEDITOR.dom.elementPath( editor.getSelection().getStartElement() );\r
 215 \r
 216                         var startBlock = elementPath.block,\r
 217                                 startBlockTag = startBlock && elementPath.block.getName();\r
 218 \r
 219                         var isPre = false;\r
 220 \r
 221                         if ( !forceMode && startBlockTag == 'li' )\r
 222                         {\r
 223                                 enterBlock( editor, mode, range, forceMode );\r
 224                                 return;\r
 225                         }\r
 226 \r
 227                         // If we are at the end of a header block.\r
 228                         if ( !forceMode && isEndOfBlock && headerTagRegex.test( startBlockTag ) )\r
 229                         {\r
 230                                 var newBlock,\r
 231                                         newBlockDir;\r
 232 \r
 233                                 if ( newBlockDir = startBlock.getDirection() )\r
 234                                 {\r
 235                                         newBlock = doc.createElement( 'div' );\r
 236                                         newBlock.setAttribute( 'dir', newBlockDir );\r
 237                                         newBlock.insertAfter( startBlock );\r
 238                                         range.setStart( newBlock, 0 );\r
 239                                 }\r
 240                                 else\r
 241                                 {\r
 242                                         // Insert a <br> after the current paragraph.\r
 243                                         doc.createElement( 'br' ).insertAfter( startBlock );\r
 244 \r
 245                                         // A text node is required by Gecko only to make the cursor blink.\r
 246                                         if ( CKEDITOR.env.gecko )\r
 247                                                 doc.createText( '' ).insertAfter( startBlock );\r
 248 \r
 249                                         // IE has different behaviors regarding position.\r
 250                                         range.setStartAt( startBlock.getNext(), CKEDITOR.env.ie ? CKEDITOR.POSITION_BEFORE_START : CKEDITOR.POSITION_AFTER_START );\r
 251                                 }\r
 252                         }\r
 253                         else\r
 254                         {\r
 255                                 var lineBreak;\r
 256 \r
 257                                 isPre = ( startBlockTag == 'pre' );\r
 258 \r
 259                                 // Gecko prefers <br> as line-break inside <pre> (#4711).\r
 260                                 if ( isPre && !CKEDITOR.env.gecko )\r
 261                                         lineBreak = doc.createText( CKEDITOR.env.ie ? '\r' : '\n' );\r
 262                                 else\r
 263                                         lineBreak = doc.createElement( 'br' );\r
 264 \r
 265                                 range.deleteContents();\r
 266                                 range.insertNode( lineBreak );\r
 267 \r
 268                                 // A text node is required by Gecko only to make the cursor blink.\r
 269                                 // We need some text inside of it, so the bogus <br> is properly\r
 270                                 // created.\r
 271                                 if ( !CKEDITOR.env.ie )\r
 272                                         doc.createText( '\ufeff' ).insertAfter( lineBreak );\r
 273 \r
 274                                 // If we are at the end of a block, we must be sure the bogus node is available in that block.\r
 275                                 if ( isEndOfBlock && !CKEDITOR.env.ie )\r
 276                                         lineBreak.getParent().appendBogus();\r
 277 \r
 278                                 // Now we can remove the text node contents, so the caret doesn't\r
 279                                 // stop on it.\r
 280                                 if ( !CKEDITOR.env.ie )\r
 281                                         lineBreak.getNext().$.nodeValue = '';\r
 282                                 // IE has different behavior regarding position.\r
 283                                 if ( CKEDITOR.env.ie )\r
 284                                         range.setStartAt( lineBreak, CKEDITOR.POSITION_AFTER_END );\r
 285                                 else\r
 286                                         range.setStartAt( lineBreak.getNext(), CKEDITOR.POSITION_AFTER_START );\r
 287 \r
 288                                 // Scroll into view, for non IE.\r
 289                                 if ( !CKEDITOR.env.ie )\r
 290                                 {\r
 291                                         var dummy = null;\r
 292 \r
 293                                         // BR is not positioned in Opera and Webkit.\r
 294                                         if ( !CKEDITOR.env.gecko )\r
 295                                         {\r
 296                                                 dummy = doc.createElement( 'span' );\r
 297                                                 // We need have some contents for Webkit to position it\r
 298                                                 // under parent node. ( #3681)\r
 299                                                 dummy.setHtml('&nbsp;');\r
 300                                         }\r
 301                                         else\r
 302                                                 dummy = doc.createElement( 'br' );\r
 303 \r
 304                                         dummy.insertBefore( lineBreak.getNext() );\r
 305                                         dummy.scrollIntoView();\r
 306                                         dummy.remove();\r
 307                                 }\r
 308                         }\r
 309 \r
 310                         // This collapse guarantees the cursor will be blinking.\r
 311                         range.collapse( true );\r
 312 \r
 313                         range.select( isPre );\r
 314                 }\r
 315         };\r
 316 \r
 317         var plugin = CKEDITOR.plugins.enterkey,\r
 318                 enterBr = plugin.enterBr,\r
 319                 enterBlock = plugin.enterBlock,\r
 320                 headerTagRegex = /^h[1-6]$/;\r
 321 \r
 322         function shiftEnter( editor )\r
 323         {\r
 324                 // Only effective within document.\r
 325                 if ( editor.mode != 'wysiwyg' )\r
 326                         return false;\r
 327 \r
 328                 // On SHIFT+ENTER:\r
 329                 // 1. We want to enforce the mode to be respected, instead\r
 330                 // of cloning the current block. (#77)\r
 331                 // 2. Always perform a block break when inside <pre> (#5402).\r
 332                 if ( editor.getSelection().getStartElement().hasAscendant( 'pre', true ) )\r
 333                 {\r
 334                         setTimeout( function() { enterBlock( editor, editor.config.enterMode, null, true ); }, 0 );\r
 335                         return true;\r
 336                 }\r
 337                 else\r
 338                         return enter( editor, editor.config.shiftEnterMode, 1 );\r
 339         }\r
 340 \r
 341         function enter( editor, mode, forceMode )\r
 342         {\r
 343                 forceMode = editor.config.forceEnterMode || forceMode;\r
 344 \r
 345                 // Only effective within document.\r
 346                 if ( editor.mode != 'wysiwyg' )\r
 347                         return false;\r
 348 \r
 349                 if ( !mode )\r
 350                         mode = editor.config.enterMode;\r
 351 \r
 352                 // Use setTimout so the keys get cancelled immediatelly.\r
 353                 setTimeout( function()\r
 354                         {\r
 355                                 editor.fire( 'saveSnapshot' );  // Save undo step.\r
 356                                 if ( mode == CKEDITOR.ENTER_BR || editor.getSelection().getStartElement().hasAscendant( 'pre', 1 ) )\r
 357                                         enterBr( editor, mode, null, forceMode );\r
 358                                 else\r
 359                                         enterBlock( editor, mode, null, forceMode );\r
 360 \r
 361                         }, 0 );\r
 362 \r
 363                 return true;\r
 364         }\r
 365 \r
 366 \r
 367         function getRange( editor )\r
 368         {\r
 369                 // Get the selection ranges.\r
 370                 var ranges = editor.getSelection().getRanges( true );\r
 371 \r
 372                 // Delete the contents of all ranges except the first one.\r
 373                 for ( var i = ranges.length - 1 ; i > 0 ; i-- )\r
 374                 {\r
 375                         ranges[ i ].deleteContents();\r
 376                 }\r
 377 \r
 378                 // Return the first range.\r
 379                 return ranges[ 0 ];\r
 380         }\r
 381 })();\r