2 Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
8 CKEDITOR.plugins.add( 'enterkey',
\r
10 requires : [ 'keystrokes', 'indent' ],
\r
12 init : function( editor )
\r
14 var specialKeys = editor.specialKeys;
\r
15 specialKeys[ 13 ] = enter;
\r
16 specialKeys[ CKEDITOR.SHIFT + 13 ] = shiftEnter;
\r
21 headerTagRegex = /^h[1-6]$/;
\r
23 function shiftEnter( editor )
\r
25 // On SHIFT+ENTER we want to enforce the mode to be respected, instead
\r
26 // of cloning the current block. (#77)
\r
29 return enter( editor, editor.config.shiftEnterMode );
\r
32 function enter( editor, mode )
\r
34 // Only effective within document.
\r
35 if ( editor.mode != 'wysiwyg' )
\r
39 mode = editor.config.enterMode;
\r
41 // Use setTimout so the keys get cancelled immediatelly.
\r
42 setTimeout( function()
\r
44 editor.fire( 'saveSnapshot' ); // Save undo step.
\r
45 if ( mode == CKEDITOR.ENTER_BR || editor.getSelection().getStartElement().hasAscendant( 'pre', true ) )
\r
46 enterBr( editor, mode );
\r
48 enterBlock( editor, mode );
\r
56 function enterBlock( editor, mode, range )
\r
58 // Get the range for the current selection.
\r
59 range = range || getRange( editor );
\r
61 var doc = range.document;
\r
63 // Determine the block element to be used.
\r
64 var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );
\r
67 var splitInfo = range.splitBlock( blockTag );
\r
72 // Get the current blocks.
\r
73 var previousBlock = splitInfo.previousBlock,
\r
74 nextBlock = splitInfo.nextBlock;
\r
76 var isStartOfBlock = splitInfo.wasStartOfBlock,
\r
77 isEndOfBlock = splitInfo.wasEndOfBlock;
\r
81 // If this is a block under a list item, split it as well. (#1647)
\r
84 node = nextBlock.getParent();
\r
85 if ( node.is( 'li' ) )
\r
87 nextBlock.breakParent( node );
\r
88 nextBlock.move( nextBlock.getNext(), true );
\r
91 else if ( previousBlock && ( node = previousBlock.getParent() ) && node.is( 'li' ) )
\r
93 previousBlock.breakParent( node );
\r
94 range.moveToElementEditStart( previousBlock.getNext() );
\r
95 previousBlock.move( previousBlock.getPrevious() );
\r
98 // If we have both the previous and next blocks, it means that the
\r
99 // boundaries were on separated blocks, or none of them where on the
\r
100 // block limits (start/end).
\r
101 if ( !isStartOfBlock && !isEndOfBlock )
\r
103 // If the next block is an <li> with another list tree as the first
\r
104 // child, we'll need to append a filler (<br>/NBSP) or the list item
\r
105 // wouldn't be editable. (#1420)
\r
106 if ( nextBlock.is( 'li' )
\r
107 && ( node = nextBlock.getFirst( CKEDITOR.dom.walker.invisible( true ) ) )
\r
108 && node.is && node.is( 'ul', 'ol' ) )
\r
109 ( CKEDITOR.env.ie ? doc.createText( '\xa0' ) : doc.createElement( 'br' ) ).insertBefore( node );
\r
111 // Move the selection to the end block.
\r
113 range.moveToElementEditStart( nextBlock );
\r
118 if ( isStartOfBlock && isEndOfBlock && previousBlock.is( 'li' ) )
\r
120 editor.execCommand( 'outdent' );
\r
126 if ( previousBlock )
\r
128 // Do not enter this block if it's a header tag, or we are in
\r
129 // a Shift+Enter (#77). Create a new block element instead
\r
130 // (later in the code).
\r
131 if ( !forceMode && !headerTagRegex.test( previousBlock.getName() ) )
\r
133 // Otherwise, duplicate the previous block.
\r
134 newBlock = previousBlock.clone();
\r
137 else if ( nextBlock )
\r
138 newBlock = nextBlock.clone();
\r
141 newBlock = doc.createElement( blockTag );
\r
143 // Recreate the inline elements tree, which was available
\r
144 // before hitting enter, so the same styles will be available in
\r
146 var elementPath = splitInfo.elementPath;
\r
149 for ( var i = 0, len = elementPath.elements.length ; i < len ; i++ )
\r
151 var element = elementPath.elements[ i ];
\r
153 if ( element.equals( elementPath.block ) || element.equals( elementPath.blockLimit ) )
\r
156 if ( CKEDITOR.dtd.$removeEmpty[ element.getName() ] )
\r
158 element = element.clone();
\r
159 newBlock.moveChildren( element );
\r
160 newBlock.append( element );
\r
165 if ( !CKEDITOR.env.ie )
\r
166 newBlock.appendBogus();
\r
168 range.insertNode( newBlock );
\r
170 // This is tricky, but to make the new block visible correctly
\r
171 // we must select it.
\r
172 // The previousBlock check has been included because it may be
\r
173 // empty if we have fixed a block-less space (like ENTER into an
\r
174 // empty table cell).
\r
175 if ( CKEDITOR.env.ie && isStartOfBlock && ( !isEndOfBlock || !previousBlock.getChildCount() ) )
\r
177 // Move the selection to the new block.
\r
178 range.moveToElementEditStart( isEndOfBlock ? previousBlock : newBlock );
\r
182 // Move the selection to the new block.
\r
183 range.moveToElementEditStart( isStartOfBlock && !isEndOfBlock ? nextBlock : newBlock );
\r
186 if ( !CKEDITOR.env.ie )
\r
190 // If we have split the block, adds a temporary span at the
\r
191 // range position and scroll relatively to it.
\r
192 var tmpNode = doc.createElement( 'span' );
\r
194 // We need some content for Safari.
\r
195 tmpNode.setHtml( ' ' );
\r
197 range.insertNode( tmpNode );
\r
198 tmpNode.scrollIntoView();
\r
199 range.deleteContents();
\r
203 // We may use the above scroll logic for the new block case
\r
204 // too, but it gives some weird result with Opera.
\r
205 newBlock.scrollIntoView();
\r
212 function enterBr( editor, mode )
\r
214 // Get the range for the current selection.
\r
215 var range = getRange( editor ),
\r
216 doc = range.document;
\r
218 // Determine the block element to be used.
\r
219 var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );
\r
221 var isEndOfBlock = range.checkEndOfBlock();
\r
223 var elementPath = new CKEDITOR.dom.elementPath( editor.getSelection().getStartElement() );
\r
225 var startBlock = elementPath.block,
\r
226 startBlockTag = startBlock && elementPath.block.getName();
\r
230 if ( !forceMode && startBlockTag == 'li' )
\r
232 enterBlock( editor, mode, range );
\r
236 // If we are at the end of a header block.
\r
237 if ( !forceMode && isEndOfBlock && headerTagRegex.test( startBlockTag ) )
\r
239 // Insert a <br> after the current paragraph.
\r
240 doc.createElement( 'br' ).insertAfter( startBlock );
\r
242 // A text node is required by Gecko only to make the cursor blink.
\r
243 if ( CKEDITOR.env.gecko )
\r
244 doc.createText( '' ).insertAfter( startBlock );
\r
246 // IE has different behaviors regarding position.
\r
247 range.setStartAt( startBlock.getNext(), CKEDITOR.env.ie ? CKEDITOR.POSITION_BEFORE_START : CKEDITOR.POSITION_AFTER_START );
\r
253 isPre = ( startBlockTag == 'pre' );
\r
256 lineBreak = doc.createText( CKEDITOR.env.ie ? '\r' : '\n' );
\r
258 lineBreak = doc.createElement( 'br' );
\r
260 range.deleteContents();
\r
261 range.insertNode( lineBreak );
\r
263 // A text node is required by Gecko only to make the cursor blink.
\r
264 // We need some text inside of it, so the bogus <br> is properly
\r
266 if ( !CKEDITOR.env.ie )
\r
267 doc.createText( '\ufeff' ).insertAfter( lineBreak );
\r
269 // If we are at the end of a block, we must be sure the bogus node is available in that block.
\r
270 if ( isEndOfBlock && !CKEDITOR.env.ie )
\r
271 lineBreak.getParent().appendBogus();
\r
273 // Now we can remove the text node contents, so the caret doesn't
\r
275 if ( !CKEDITOR.env.ie )
\r
276 lineBreak.getNext().$.nodeValue = '';
\r
277 // IE has different behavior regarding position.
\r
278 if ( CKEDITOR.env.ie )
\r
279 range.setStartAt( lineBreak, CKEDITOR.POSITION_AFTER_END );
\r
281 range.setStartAt( lineBreak.getNext(), CKEDITOR.POSITION_AFTER_START );
\r
283 // Scroll into view, for non IE.
\r
284 if ( !CKEDITOR.env.ie )
\r
288 // BR is not positioned in Opera and Webkit.
\r
289 if ( !CKEDITOR.env.gecko )
\r
291 dummy = doc.createElement( 'span' );
\r
292 // We need have some contents for Webkit to position it
\r
293 // under parent node. ( #3681)
\r
294 dummy.setHtml(' ');
\r
297 dummy = doc.createElement( 'br' );
\r
299 dummy.insertBefore( lineBreak.getNext() );
\r
300 dummy.scrollIntoView();
\r
305 // This collapse guarantees the cursor will be blinking.
\r
306 range.collapse( true );
\r
308 range.select( isPre );
\r
311 function getRange( editor )
\r
313 // Get the selection ranges.
\r
314 var ranges = editor.getSelection().getRanges();
\r
316 // Delete the contents of all ranges except the first one.
\r
317 for ( var i = ranges.length - 1 ; i > 0 ; i-- )
\r
319 ranges[ i ].deleteContents();
\r
322 // Return the first range.
\r
323 return ranges[ 0 ];
\r