2 Copyright (c) 2003-2010, 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
20 CKEDITOR.plugins.enterkey =
\r
22 enterBlock : function( editor, mode, range, forceMode )
\r
24 // Get the range for the current selection.
\r
25 range = range || getRange( editor );
\r
27 // We may not have valid ranges to work on, like when inside a
\r
28 // contenteditable=false element.
\r
32 var doc = range.document;
\r
34 // Exit the list when we're inside an empty list item block. (#5376)
\r
35 if ( range.checkStartOfBlock() && range.checkEndOfBlock() )
\r
37 var path = new CKEDITOR.dom.elementPath( range.startContainer ),
\r
40 if ( block && ( block.is( 'li' ) || block.getParent().is( 'li' ) ) )
\r
42 editor.execCommand( 'outdent' );
\r
47 // Determine the block element to be used.
\r
48 var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );
\r
51 var splitInfo = range.splitBlock( blockTag );
\r
56 // Get the current blocks.
\r
57 var previousBlock = splitInfo.previousBlock,
\r
58 nextBlock = splitInfo.nextBlock;
\r
60 var isStartOfBlock = splitInfo.wasStartOfBlock,
\r
61 isEndOfBlock = splitInfo.wasEndOfBlock;
\r
65 // If this is a block under a list item, split it as well. (#1647)
\r
68 node = nextBlock.getParent();
\r
69 if ( node.is( 'li' ) )
\r
71 nextBlock.breakParent( node );
\r
72 nextBlock.move( nextBlock.getNext(), true );
\r
75 else if ( previousBlock && ( node = previousBlock.getParent() ) && node.is( 'li' ) )
\r
77 previousBlock.breakParent( node );
\r
78 range.moveToElementEditStart( previousBlock.getNext() );
\r
79 previousBlock.move( previousBlock.getPrevious() );
\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
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
95 // Move the selection to the end block.
\r
97 range.moveToElementEditStart( nextBlock );
\r
103 if ( previousBlock )
\r
105 // Do not enter this block if it's a header tag, or we are in
\r
106 // a Shift+Enter (#77). Create a new block element instead
\r
107 // (later in the code).
\r
108 if ( previousBlock.is( 'li' ) || !headerTagRegex.test( previousBlock.getName() ) )
\r
110 // Otherwise, duplicate the previous block.
\r
111 newBlock = previousBlock.clone();
\r
114 else if ( nextBlock )
\r
115 newBlock = nextBlock.clone();
\r
118 newBlock = doc.createElement( blockTag );
\r
119 // Force the enter block unless we're talking of a list item.
\r
120 else if ( forceMode && !newBlock.is( 'li' ) )
\r
121 newBlock.renameNode( blockTag );
\r
123 // Recreate the inline elements tree, which was available
\r
124 // before hitting enter, so the same styles will be available in
\r
126 var elementPath = splitInfo.elementPath;
\r
129 for ( var i = 0, len = elementPath.elements.length ; i < len ; i++ )
\r
131 var element = elementPath.elements[ i ];
\r
133 if ( element.equals( elementPath.block ) || element.equals( elementPath.blockLimit ) )
\r
136 if ( CKEDITOR.dtd.$removeEmpty[ element.getName() ] )
\r
138 element = element.clone();
\r
139 newBlock.moveChildren( element );
\r
140 newBlock.append( element );
\r
145 if ( !CKEDITOR.env.ie )
\r
146 newBlock.appendBogus();
\r
148 range.insertNode( newBlock );
\r
150 // This is tricky, but to make the new block visible correctly
\r
151 // we must select it.
\r
152 // The previousBlock check has been included because it may be
\r
153 // empty if we have fixed a block-less space (like ENTER into an
\r
154 // empty table cell).
\r
155 if ( CKEDITOR.env.ie && isStartOfBlock && ( !isEndOfBlock || !previousBlock.getChildCount() ) )
\r
157 // Move the selection to the new block.
\r
158 range.moveToElementEditStart( isEndOfBlock ? previousBlock : newBlock );
\r
162 // Move the selection to the new block.
\r
163 range.moveToElementEditStart( isStartOfBlock && !isEndOfBlock ? nextBlock : newBlock );
\r
166 if ( !CKEDITOR.env.ie )
\r
170 // If we have split the block, adds a temporary span at the
\r
171 // range position and scroll relatively to it.
\r
172 var tmpNode = doc.createElement( 'span' );
\r
174 // We need some content for Safari.
\r
175 tmpNode.setHtml( ' ' );
\r
177 range.insertNode( tmpNode );
\r
178 tmpNode.scrollIntoView();
\r
179 range.deleteContents();
\r
183 // We may use the above scroll logic for the new block case
\r
184 // too, but it gives some weird result with Opera.
\r
185 newBlock.scrollIntoView();
\r
192 enterBr : function( editor, mode, range, forceMode )
\r
194 // Get the range for the current selection.
\r
195 range = range || getRange( editor );
\r
197 // We may not have valid ranges to work on, like when inside a
\r
198 // contenteditable=false element.
\r
202 var doc = range.document;
\r
204 // Determine the block element to be used.
\r
205 var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );
\r
207 var isEndOfBlock = range.checkEndOfBlock();
\r
209 var elementPath = new CKEDITOR.dom.elementPath( editor.getSelection().getStartElement() );
\r
211 var startBlock = elementPath.block,
\r
212 startBlockTag = startBlock && elementPath.block.getName();
\r
216 if ( !forceMode && startBlockTag == 'li' )
\r
218 enterBlock( editor, mode, range, forceMode );
\r
222 // If we are at the end of a header block.
\r
223 if ( !forceMode && isEndOfBlock && headerTagRegex.test( startBlockTag ) )
\r
225 // Insert a <br> after the current paragraph.
\r
226 doc.createElement( 'br' ).insertAfter( startBlock );
\r
228 // A text node is required by Gecko only to make the cursor blink.
\r
229 if ( CKEDITOR.env.gecko )
\r
230 doc.createText( '' ).insertAfter( startBlock );
\r
232 // IE has different behaviors regarding position.
\r
233 range.setStartAt( startBlock.getNext(), CKEDITOR.env.ie ? CKEDITOR.POSITION_BEFORE_START : CKEDITOR.POSITION_AFTER_START );
\r
239 isPre = ( startBlockTag == 'pre' );
\r
241 // Gecko prefers <br> as line-break inside <pre> (#4711).
\r
242 if ( isPre && !CKEDITOR.env.gecko )
\r
243 lineBreak = doc.createText( CKEDITOR.env.ie ? '\r' : '\n' );
\r
245 lineBreak = doc.createElement( 'br' );
\r
247 range.deleteContents();
\r
248 range.insertNode( lineBreak );
\r
250 // A text node is required by Gecko only to make the cursor blink.
\r
251 // We need some text inside of it, so the bogus <br> is properly
\r
253 if ( !CKEDITOR.env.ie )
\r
254 doc.createText( '\ufeff' ).insertAfter( lineBreak );
\r
256 // If we are at the end of a block, we must be sure the bogus node is available in that block.
\r
257 if ( isEndOfBlock && !CKEDITOR.env.ie )
\r
258 lineBreak.getParent().appendBogus();
\r
260 // Now we can remove the text node contents, so the caret doesn't
\r
262 if ( !CKEDITOR.env.ie )
\r
263 lineBreak.getNext().$.nodeValue = '';
\r
264 // IE has different behavior regarding position.
\r
265 if ( CKEDITOR.env.ie )
\r
266 range.setStartAt( lineBreak, CKEDITOR.POSITION_AFTER_END );
\r
268 range.setStartAt( lineBreak.getNext(), CKEDITOR.POSITION_AFTER_START );
\r
270 // Scroll into view, for non IE.
\r
271 if ( !CKEDITOR.env.ie )
\r
275 // BR is not positioned in Opera and Webkit.
\r
276 if ( !CKEDITOR.env.gecko )
\r
278 dummy = doc.createElement( 'span' );
\r
279 // We need have some contents for Webkit to position it
\r
280 // under parent node. ( #3681)
\r
281 dummy.setHtml(' ');
\r
284 dummy = doc.createElement( 'br' );
\r
286 dummy.insertBefore( lineBreak.getNext() );
\r
287 dummy.scrollIntoView();
\r
292 // This collapse guarantees the cursor will be blinking.
\r
293 range.collapse( true );
\r
295 range.select( isPre );
\r
299 var plugin = CKEDITOR.plugins.enterkey,
\r
300 enterBr = plugin.enterBr,
\r
301 enterBlock = plugin.enterBlock,
\r
302 headerTagRegex = /^h[1-6]$/;
\r
304 function shiftEnter( editor )
\r
306 // Only effective within document.
\r
307 if ( editor.mode != 'wysiwyg' )
\r
311 // 1. We want to enforce the mode to be respected, instead
\r
312 // of cloning the current block. (#77)
\r
313 // 2. Always perform a block break when inside <pre> (#5402).
\r
314 if ( editor.getSelection().getStartElement().hasAscendant( 'pre', true ) )
\r
316 setTimeout( function() { enterBlock( editor, editor.config.enterMode, null, true ); }, 0 );
\r
320 return enter( editor, editor.config.shiftEnterMode, true );
\r
323 function enter( editor, mode, forceMode )
\r
325 forceMode = editor.config.forceEnterMode || forceMode;
\r
327 // Only effective within document.
\r
328 if ( editor.mode != 'wysiwyg' )
\r
332 mode = editor.config.enterMode;
\r
334 // Use setTimout so the keys get cancelled immediatelly.
\r
335 setTimeout( function()
\r
337 editor.fire( 'saveSnapshot' ); // Save undo step.
\r
338 if ( mode == CKEDITOR.ENTER_BR || editor.getSelection().getStartElement().hasAscendant( 'pre', true ) )
\r
339 enterBr( editor, mode, null, forceMode );
\r
341 enterBlock( editor, mode, null, forceMode );
\r
349 function getRange( editor )
\r
351 // Get the selection ranges.
\r
352 var ranges = editor.getSelection().getRanges( true );
\r
354 // Delete the contents of all ranges except the first one.
\r
355 for ( var i = ranges.length - 1 ; i > 0 ; i-- )
\r
357 ranges[ i ].deleteContents();
\r
360 // Return the first range.
\r
361 return ranges[ 0 ];
\r