/** * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md or http://ckeditor.com/license */ CKEDITOR.plugins.add( 'contextmenu', { requires: 'menu', // jscs:disable maximumLineLength lang: 'af,ar,az,bg,bn,bs,ca,cs,cy,da,de,de-ch,el,en,en-au,en-ca,en-gb,eo,es,es-mx,et,eu,fa,fi,fo,fr,fr-ca,gl,gu,he,hi,hr,hu,id,is,it,ja,ka,km,ko,ku,lt,lv,mk,mn,ms,nb,nl,no,oc,pl,pt,pt-br,ro,ru,si,sk,sl,sq,sr,sr-latn,sv,th,tr,tt,ug,uk,vi,zh,zh-cn', // %REMOVE_LINE_CORE% // jscs:enable maximumLineLength // Make sure the base class (CKEDITOR.menu) is loaded before it (http://dev.ckeditor.com/ticket/3318). onLoad: function() { /** * Class replacing the non-configurable native context menu with a configurable CKEditor's equivalent. * * @class * @extends CKEDITOR.menu */ CKEDITOR.plugins.contextMenu = CKEDITOR.tools.createClass( { base: CKEDITOR.menu, /** * Creates the CKEDITOR.plugins.contextMenu class instance. * * @constructor * @param {CKEDITOR.editor} editor */ $: function( editor ) { this.base.call( this, editor, { panel: { className: 'cke_menu_panel', attributes: { 'aria-label': editor.lang.contextmenu.options } } } ); }, proto: { /** * Starts watching on native context menu triggers (Option key, right click) on the given element. * * @param {CKEDITOR.dom.element} element * @param {Boolean} [nativeContextMenuOnCtrl] Whether to open native context menu if the * Ctrl key is held on opening the context menu. See {@link CKEDITOR.config#browserContextMenuOnCtrl}. */ addTarget: function( element, nativeContextMenuOnCtrl ) { element.on( 'contextmenu', function( event ) { var domEvent = event.data, isCtrlKeyDown = // Safari on Windows always show 'ctrlKey' as true in 'contextmenu' event, // which make this property unreliable. (http://dev.ckeditor.com/ticket/4826) ( CKEDITOR.env.webkit ? holdCtrlKey : ( CKEDITOR.env.mac ? domEvent.$.metaKey : domEvent.$.ctrlKey ) ); if ( nativeContextMenuOnCtrl && isCtrlKeyDown ) return; // Cancel the browser context menu. domEvent.preventDefault(); // Fix selection when non-editable element in Webkit/Blink (Mac) (http://dev.ckeditor.com/ticket/11306). if ( CKEDITOR.env.mac && CKEDITOR.env.webkit ) { var editor = this.editor, contentEditableParent = new CKEDITOR.dom.elementPath( domEvent.getTarget(), editor.editable() ).contains( function( el ) { // Return when non-editable or nested editable element is found. return el.hasAttribute( 'contenteditable' ); }, true ); // Exclude editor's editable. // Fake selection for non-editables only (to exclude nested editables). if ( contentEditableParent && contentEditableParent.getAttribute( 'contenteditable' ) == 'false' ) editor.getSelection().fake( contentEditableParent ); } var doc = domEvent.getTarget().getDocument(), offsetParent = domEvent.getTarget().getDocument().getDocumentElement(), fromFrame = !doc.equals( CKEDITOR.document ), scroll = doc.getWindow().getScrollPosition(), offsetX = fromFrame ? domEvent.$.clientX : domEvent.$.pageX || scroll.x + domEvent.$.clientX, offsetY = fromFrame ? domEvent.$.clientY : domEvent.$.pageY || scroll.y + domEvent.$.clientY; CKEDITOR.tools.setTimeout( function() { this.open( offsetParent, null, offsetX, offsetY ); // IE needs a short while to allow selection change before opening menu. (http://dev.ckeditor.com/ticket/7908) }, CKEDITOR.env.ie ? 200 : 0, this ); }, this ); if ( CKEDITOR.env.webkit ) { var holdCtrlKey, onKeyDown = function( event ) { holdCtrlKey = CKEDITOR.env.mac ? event.data.$.metaKey : event.data.$.ctrlKey; }, resetOnKeyUp = function() { holdCtrlKey = 0; }; element.on( 'keydown', onKeyDown ); element.on( 'keyup', resetOnKeyUp ); element.on( 'contextmenu', resetOnKeyUp ); } }, /** * Opens the context menu in the given location. See the {@link CKEDITOR.menu#show} method. * * @param {CKEDITOR.dom.element} offsetParent * @param {Number} [corner] * @param {Number} [offsetX] * @param {Number} [offsetY] */ open: function( offsetParent, corner, offsetX, offsetY ) { if ( this.editor.config.enableContextMenu === false ) { return; } this.editor.focus(); offsetParent = offsetParent || CKEDITOR.document.getDocumentElement(); // http://dev.ckeditor.com/ticket/9362: Force selection check to update commands' states in the new context. this.editor.selectionChange( 1 ); this.show( offsetParent, corner, offsetX, offsetY ); } } } ); }, beforeInit: function( editor ) { /** * @readonly * @property {CKEDITOR.plugins.contextMenu} contextMenu * @member CKEDITOR.editor */ var contextMenu = editor.contextMenu = new CKEDITOR.plugins.contextMenu( editor ); editor.on( 'contentDom', function() { contextMenu.addTarget( editor.editable(), editor.config.browserContextMenuOnCtrl !== false ); } ); editor.addCommand( 'contextMenu', { exec: function() { editor.contextMenu.open( editor.document.getBody() ); } } ); editor.setKeystroke( CKEDITOR.SHIFT + 121 /*F10*/, 'contextMenu' ); editor.setKeystroke( CKEDITOR.CTRL + CKEDITOR.SHIFT + 121 /*F10*/, 'contextMenu' ); } } ); /** * Whether to show the browser native context menu when the Ctrl or * Meta (Mac) key is pressed on opening the context menu with the * right mouse button click or the Menu key. * * config.browserContextMenuOnCtrl = false; * * @since 3.0.2 * @cfg {Boolean} [browserContextMenuOnCtrl=true] * @member CKEDITOR.config */ /** * Whether to enable the context menu. Regardless of the setting the [Context Menu](http://ckeditor.com/addon/contextmenu) * plugin is still loaded. * * config.enableContextMenu = false; * * @since 4.7.0 * @cfg {Boolean} [enableContextMenu=true] * @member CKEDITOR.config */