summaryrefslogtreecommitdiff
path: root/plugins/enterkey/plugin.js
diff options
context:
space:
mode:
authorlsces <lester@lsces.co.uk>2013-07-15 14:22:23 +0100
committerlsces <lester@lsces.co.uk>2013-07-15 14:22:23 +0100
commit6d4c4f12d15ae68d912972921997a8c5180c9aea (patch)
tree104274447272d09617c483cf6b0ee79559c9fe6f /plugins/enterkey/plugin.js
parentde6d09676a9527919813a4474cc28af554a35fe1 (diff)
downloadckeditor-6d4c4f12d15ae68d912972921997a8c5180c9aea.tar.gz
ckeditor-6d4c4f12d15ae68d912972921997a8c5180c9aea.tar.bz2
ckeditor-6d4c4f12d15ae68d912972921997a8c5180c9aea.zip
Upgrade to CKEditor V4
Directory structure changed so many files removed and replace in a new location This batch is the delete and add
Diffstat (limited to 'plugins/enterkey/plugin.js')
-rw-r--r--plugins/enterkey/plugin.js366
1 files changed, 366 insertions, 0 deletions
diff --git a/plugins/enterkey/plugin.js b/plugins/enterkey/plugin.js
new file mode 100644
index 0000000..4c077c3
--- /dev/null
+++ b/plugins/enterkey/plugin.js
@@ -0,0 +1,366 @@
+/**
+ * @license Copyright (c) 2003-2013, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.html or http://ckeditor.com/license
+ */
+
+(function() {
+ CKEDITOR.plugins.add( 'enterkey', {
+ // TODO: should not depend on a particular format plugin.
+ requires: 'indent',
+
+ init: function( editor ) {
+ editor.addCommand( 'enter', { modes:{wysiwyg:1 },
+ editorFocus: false,
+ exec: function( editor ) {
+ enter( editor );
+ }
+ });
+
+ editor.addCommand( 'shiftEnter', { modes:{wysiwyg:1 },
+ editorFocus: false,
+ exec: function( editor ) {
+ shiftEnter( editor );
+ }
+ });
+
+ editor.setKeystroke( [
+ [ 13, 'enter' ],
+ [ CKEDITOR.SHIFT + 13, 'shiftEnter' ]
+ ] );
+ }
+ });
+
+ var whitespaces = CKEDITOR.dom.walker.whitespaces(),
+ bookmark = CKEDITOR.dom.walker.bookmark();
+
+ CKEDITOR.plugins.enterkey = {
+ enterBlock: function( editor, mode, range, forceMode ) {
+ // Get the range for the current selection.
+ range = range || getRange( editor );
+
+ // We may not have valid ranges to work on, like when inside a
+ // contenteditable=false element.
+ if ( !range )
+ return;
+
+ var doc = range.document;
+
+ var atBlockStart = range.checkStartOfBlock(),
+ atBlockEnd = range.checkEndOfBlock(),
+ path = editor.elementPath( range.startContainer ),
+ block = path.block;
+
+ // Exit the list when we're inside an empty list item block. (#5376)
+ if ( atBlockStart && atBlockEnd ) {
+ // Exit the list when we're inside an empty list item block. (#5376)
+ if ( block && ( block.is( 'li' ) || block.getParent().is( 'li' ) ) ) {
+ editor.execCommand( 'outdent' );
+ return;
+ }
+
+ if ( block && block.getParent().is( 'blockquote' ) ) {
+ block.breakParent( block.getParent() );
+
+ // If we were at the start of <blockquote>, there will be an empty element before it now.
+ if ( !block.getPrevious().getFirst( CKEDITOR.dom.walker.invisible( 1 ) ) )
+ block.getPrevious().remove();
+
+ // If we were at the end of <blockquote>, there will be an empty element after it now.
+ if ( !block.getNext().getFirst( CKEDITOR.dom.walker.invisible( 1 ) ) )
+ block.getNext().remove();
+
+ range.moveToElementEditStart( block );
+ range.select();
+ return;
+ }
+ }
+ // Don't split <pre> if we're in the middle of it, act as shift enter key.
+ else if ( block && block.is( 'pre' ) ) {
+ if ( !atBlockEnd ) {
+ enterBr( editor, mode, range, forceMode );
+ return;
+ }
+ }
+
+ // Determine the block element to be used.
+ var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );
+
+ // Split the range.
+ var splitInfo = range.splitBlock( blockTag );
+
+ if ( !splitInfo )
+ return;
+
+ // Get the current blocks.
+ var previousBlock = splitInfo.previousBlock,
+ nextBlock = splitInfo.nextBlock;
+
+ var isStartOfBlock = splitInfo.wasStartOfBlock,
+ isEndOfBlock = splitInfo.wasEndOfBlock;
+
+ var node;
+
+ // If this is a block under a list item, split it as well. (#1647)
+ if ( nextBlock ) {
+ node = nextBlock.getParent();
+ if ( node.is( 'li' ) ) {
+ nextBlock.breakParent( node );
+ nextBlock.move( nextBlock.getNext(), 1 );
+ }
+ } else if ( previousBlock && ( node = previousBlock.getParent() ) && node.is( 'li' ) ) {
+ previousBlock.breakParent( node );
+ node = previousBlock.getNext();
+ range.moveToElementEditStart( node );
+ previousBlock.move( previousBlock.getPrevious() );
+ }
+
+ // If we have both the previous and next blocks, it means that the
+ // boundaries were on separated blocks, or none of them where on the
+ // block limits (start/end).
+ if ( !isStartOfBlock && !isEndOfBlock ) {
+ // If the next block is an <li> with another list tree as the first
+ // child, we'll need to append a filler (<br>/NBSP) or the list item
+ // wouldn't be editable. (#1420)
+ if ( nextBlock.is( 'li' ) ) {
+ var walkerRange = range.clone();
+ walkerRange.selectNodeContents( nextBlock );
+ var walker = new CKEDITOR.dom.walker( walkerRange );
+ walker.evaluator = function( node ) {
+ return !( bookmark( node ) || whitespaces( node ) || node.type == CKEDITOR.NODE_ELEMENT && node.getName() in CKEDITOR.dtd.$inline && !( node.getName() in CKEDITOR.dtd.$empty ) );
+ };
+
+ node = walker.next();
+ if ( node && node.type == CKEDITOR.NODE_ELEMENT && node.is( 'ul', 'ol' ) ) {
+ ( CKEDITOR.env.ie ? doc.createText( '\xa0' ) : doc.createElement( 'br' ) ).insertBefore( node );
+ }
+ }
+
+ // Move the selection to the end block.
+ if ( nextBlock )
+ range.moveToElementEditStart( nextBlock );
+ } else {
+ var newBlock, newBlockDir;
+
+ if ( previousBlock ) {
+ // Do not enter this block if it's a header tag, or we are in
+ // a Shift+Enter (#77). Create a new block element instead
+ // (later in the code).
+ if ( previousBlock.is( 'li' ) || !( headerTagRegex.test( previousBlock.getName() ) || previousBlock.is( 'pre' ) ) ) {
+ // Otherwise, duplicate the previous block.
+ newBlock = previousBlock.clone();
+ }
+ } else if ( nextBlock )
+ newBlock = nextBlock.clone();
+
+ if ( !newBlock ) {
+ // We have already created a new list item. (#6849)
+ if ( node && node.is( 'li' ) )
+ newBlock = node;
+ else {
+ newBlock = doc.createElement( blockTag );
+ if ( previousBlock && ( newBlockDir = previousBlock.getDirection() ) )
+ newBlock.setAttribute( 'dir', newBlockDir );
+ }
+ }
+ // Force the enter block unless we're talking of a list item.
+ else if ( forceMode && !newBlock.is( 'li' ) )
+ newBlock.renameNode( blockTag );
+
+ // Recreate the inline elements tree, which was available
+ // before hitting enter, so the same styles will be available in
+ // the new block.
+ var elementPath = splitInfo.elementPath;
+ if ( elementPath ) {
+ for ( var i = 0, len = elementPath.elements.length; i < len; i++ ) {
+ var element = elementPath.elements[ i ];
+
+ if ( element.equals( elementPath.block ) || element.equals( elementPath.blockLimit ) )
+ break;
+
+ if ( CKEDITOR.dtd.$removeEmpty[ element.getName() ] ) {
+ element = element.clone();
+ newBlock.moveChildren( element );
+ newBlock.append( element );
+ }
+ }
+ }
+
+ if ( !CKEDITOR.env.ie )
+ newBlock.appendBogus();
+
+ if ( !newBlock.getParent() )
+ range.insertNode( newBlock );
+
+ // list item start number should not be duplicated (#7330), but we need
+ // to remove the attribute after it's onto the DOM tree because of old IEs (#7581).
+ newBlock.is( 'li' ) && newBlock.removeAttribute( 'value' );
+
+ // This is tricky, but to make the new block visible correctly
+ // we must select it.
+ // The previousBlock check has been included because it may be
+ // empty if we have fixed a block-less space (like ENTER into an
+ // empty table cell).
+ if ( CKEDITOR.env.ie && isStartOfBlock && ( !isEndOfBlock || !previousBlock.getChildCount() ) ) {
+ // Move the selection to the new block.
+ range.moveToElementEditStart( isEndOfBlock ? previousBlock : newBlock );
+ range.select();
+ }
+
+ // Move the selection to the new block.
+ range.moveToElementEditStart( isStartOfBlock && !isEndOfBlock ? nextBlock : newBlock );
+ }
+
+ range.select();
+ range.scrollIntoView();
+ },
+
+ enterBr: function( editor, mode, range, forceMode ) {
+ // Get the range for the current selection.
+ range = range || getRange( editor );
+
+ // We may not have valid ranges to work on, like when inside a
+ // contenteditable=false element.
+ if ( !range )
+ return;
+
+ var doc = range.document;
+
+ // Determine the block element to be used.
+ var blockTag = ( mode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );
+
+ var isEndOfBlock = range.checkEndOfBlock();
+
+ var elementPath = new CKEDITOR.dom.elementPath( editor.getSelection().getStartElement() );
+
+ var startBlock = elementPath.block,
+ startBlockTag = startBlock && elementPath.block.getName();
+
+ var isPre = false;
+
+ if ( !forceMode && startBlockTag == 'li' ) {
+ enterBlock( editor, mode, range, forceMode );
+ return;
+ }
+
+ // If we are at the end of a header block.
+ if ( !forceMode && isEndOfBlock && headerTagRegex.test( startBlockTag ) ) {
+ var newBlock, newBlockDir;
+
+ if ( ( newBlockDir = startBlock.getDirection() ) ) {
+ newBlock = doc.createElement( 'div' );
+ newBlock.setAttribute( 'dir', newBlockDir );
+ newBlock.insertAfter( startBlock );
+ range.setStart( newBlock, 0 );
+ } else {
+ // Insert a <br> after the current paragraph.
+ doc.createElement( 'br' ).insertAfter( startBlock );
+
+ // A text node is required by Gecko only to make the cursor blink.
+ if ( CKEDITOR.env.gecko )
+ doc.createText( '' ).insertAfter( startBlock );
+
+ // IE has different behaviors regarding position.
+ range.setStartAt( startBlock.getNext(), CKEDITOR.env.ie ? CKEDITOR.POSITION_BEFORE_START : CKEDITOR.POSITION_AFTER_START );
+ }
+ } else {
+ var lineBreak;
+
+ // IE<8 prefers text node as line-break inside of <pre> (#4711).
+ if ( startBlockTag == 'pre' && CKEDITOR.env.ie && CKEDITOR.env.version < 8 )
+ lineBreak = doc.createText( '\r' );
+ else
+ lineBreak = doc.createElement( 'br' );
+
+ range.deleteContents();
+ range.insertNode( lineBreak );
+
+ // IE has different behavior regarding position.
+ if ( CKEDITOR.env.ie )
+ range.setStartAt( lineBreak, CKEDITOR.POSITION_AFTER_END );
+ else {
+ // A text node is required by Gecko only to make the cursor blink.
+ // We need some text inside of it, so the bogus <br> is properly
+ // created.
+ doc.createText( '\ufeff' ).insertAfter( lineBreak );
+
+ // If we are at the end of a block, we must be sure the bogus node is available in that block.
+ if ( isEndOfBlock )
+ lineBreak.getParent().appendBogus();
+
+ // Now we can remove the text node contents, so the caret doesn't
+ // stop on it.
+ lineBreak.getNext().$.nodeValue = '';
+
+ range.setStartAt( lineBreak.getNext(), CKEDITOR.POSITION_AFTER_START );
+
+ }
+ }
+
+ // This collapse guarantees the cursor will be blinking.
+ range.collapse( true );
+
+ range.select();
+ range.scrollIntoView();
+ }
+ };
+
+ var plugin = CKEDITOR.plugins.enterkey,
+ enterBr = plugin.enterBr,
+ enterBlock = plugin.enterBlock,
+ headerTagRegex = /^h[1-6]$/;
+
+ function shiftEnter( editor ) {
+ // Only effective within document.
+ if ( editor.mode != 'wysiwyg' )
+ return false;
+
+ // On SHIFT+ENTER:
+ // 1. We want to enforce the mode to be respected, instead
+ // of cloning the current block. (#77)
+ return enter( editor, editor.config.shiftEnterMode, 1 );
+ }
+
+ function enter( editor, mode, forceMode ) {
+ forceMode = editor.config.forceEnterMode || forceMode;
+
+ // Only effective within document.
+ if ( editor.mode != 'wysiwyg' )
+ return false;
+
+ if ( !mode )
+ mode = editor.config.enterMode;
+
+ // Check path block specialities:
+ // 1. Cannot be a un-splittable element, e.g. table caption;
+ // 2. Must not be the editable element itself. (blockless)
+ var path = editor.elementPath();
+ if ( !path.isContextFor( 'p' ) ) {
+ mode = CKEDITOR.ENTER_BR;
+ forceMode = 1;
+ }
+
+ editor.fire( 'saveSnapshot' ); // Save undo step.
+
+ if ( mode == CKEDITOR.ENTER_BR )
+ enterBr( editor, mode, null, forceMode );
+ else
+ enterBlock( editor, mode, null, forceMode );
+
+ editor.fire( 'saveSnapshot' );
+
+ return true;
+ }
+
+ function getRange( editor ) {
+ // Get the selection ranges.
+ var ranges = editor.getSelection().getRanges( true );
+
+ // Delete the contents of all ranges except the first one.
+ for ( var i = ranges.length - 1; i > 0; i-- ) {
+ ranges[ i ].deleteContents();
+ }
+
+ // Return the first range.
+ return ranges[ 0 ];
+ }
+})();