2 Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
6 CKEDITOR.plugins.add( 'contextmenu',
\r
8 requires : [ 'menu' ],
\r
10 beforeInit : function( editor )
\r
12 editor.contextMenu = new CKEDITOR.plugins.contextMenu( editor );
\r
14 editor.addCommand( 'contextMenu',
\r
18 editor.contextMenu.show( editor.document.getBody() );
\r
24 CKEDITOR.plugins.contextMenu = CKEDITOR.tools.createClass(
\r
26 $ : function( editor )
\r
28 this.id = 'cke_' + CKEDITOR.tools.getNextNumber();
\r
29 this.editor = editor;
\r
30 this._.listeners = [];
\r
31 this._.functionId = CKEDITOR.tools.addFunction( function( commandName )
\r
33 this._.panel.hide();
\r
35 editor.execCommand( commandName );
\r
42 onMenu : function( offsetParent, corner, offsetX, offsetY )
\r
44 var menu = this._.menu,
\r
45 editor = this.editor;
\r
54 menu = this._.menu = new CKEDITOR.menu( editor );
\r
55 menu.onClick = CKEDITOR.tools.bind( function( item )
\r
57 var noUnlock = true;
\r
60 if ( CKEDITOR.env.ie )
\r
65 else if ( item.command )
\r
66 editor.execCommand( item.command );
\r
71 menu.onEscape = function()
\r
75 if ( CKEDITOR.env.ie )
\r
76 editor.getSelection().unlock( true );
\r
80 var listeners = this._.listeners,
\r
83 var selection = this.editor.getSelection(),
\r
84 element = selection && selection.getStartElement();
\r
86 // Lock the selection in IE, so it can be restored when closing the
\r
88 if ( CKEDITOR.env.ie )
\r
91 menu.onHide = CKEDITOR.tools.bind( function()
\r
95 if ( CKEDITOR.env.ie )
\r
96 editor.getSelection().unlock();
\r
98 this.onHide && this.onHide();
\r
102 // Call all listeners, filling the list of items to be displayed.
\r
103 for ( var i = 0 ; i < listeners.length ; i++ )
\r
105 var listenerItems = listeners[ i ]( element, selection );
\r
107 if ( listenerItems )
\r
109 for ( var itemName in listenerItems )
\r
111 var item = this.editor.getMenuItem( itemName );
\r
115 item.state = listenerItems[ itemName ];
\r
122 // Don't show context menu with zero items.
\r
123 menu.items.length && menu.show( offsetParent, corner || ( editor.lang.dir == 'rtl' ? 2 : 1 ), offsetX, offsetY );
\r
129 addTarget : function( element, nativeContextMenuOnCtrl )
\r
131 // Opera doesn't support 'contextmenu' event, we have duo approaches employed here:
\r
132 // 1. Inherit the 'button override' hack we introduced in v2 (#4530), while this require the Opera browser
\r
133 // option 'Allow script to detect context menu/right click events' to be always turned on.
\r
134 // 2. Considering the fact that ctrl/meta key is not been occupied
\r
135 // for multiple range selecting (like Gecko), we use this key
\r
136 // combination as a fallback for triggering context-menu. (#4530)
\r
137 if ( CKEDITOR.env.opera )
\r
139 var contextMenuOverrideButton;
\r
140 element.on( 'mousedown', function( evt )
\r
143 if( evt.$.button != 2 )
\r
145 if ( evt.getKeystroke() == CKEDITOR.CTRL + 1 )
\r
146 element.fire( 'contextmenu', evt );
\r
150 if ( nativeContextMenuOnCtrl
\r
151 && ( evt.$.ctrlKey || evt.$.metaKey ) )
\r
154 var target = evt.getTarget();
\r
156 if( !contextMenuOverrideButton )
\r
158 var ownerDoc = target.getDocument();
\r
159 contextMenuOverrideButton = ownerDoc.createElement( 'input' ) ;
\r
160 contextMenuOverrideButton.$.type = 'button' ;
\r
161 ownerDoc.getBody().append( contextMenuOverrideButton ) ;
\r
164 contextMenuOverrideButton.setAttribute( 'style', 'position:absolute;top:' + ( evt.$.clientY - 2 ) +
\r
165 'px;left:' + ( evt.$.clientX - 2 ) +
\r
166 'px;width:5px;height:5px;opacity:0.01' );
\r
170 element.on( 'mouseup', function ( evt )
\r
172 if ( contextMenuOverrideButton )
\r
174 contextMenuOverrideButton.remove();
\r
175 contextMenuOverrideButton = undefined;
\r
176 // Simulate 'contextmenu' event.
\r
177 element.fire( 'contextmenu', evt.data );
\r
182 element.on( 'contextmenu', function( event )
\r
184 var domEvent = event.data;
\r
186 if ( nativeContextMenuOnCtrl &&
\r
187 // Safari on Windows always show 'ctrlKey' as true in 'contextmenu' event,
\r
188 // which make this property unreliable. (#4826)
\r
189 ( CKEDITOR.env.webkit ? holdCtrlKey : domEvent.$.ctrlKey || domEvent.$.metaKey ) )
\r
192 // Cancel the browser context menu.
\r
193 domEvent.preventDefault();
\r
195 var offsetParent = domEvent.getTarget().getDocument().getDocumentElement(),
\r
196 offsetX = domEvent.$.clientX,
\r
197 offsetY = domEvent.$.clientY;
\r
199 CKEDITOR.tools.setTimeout( function()
\r
201 this._.onMenu( offsetParent, null, offsetX, offsetY );
\r
207 if( CKEDITOR.env.webkit )
\r
210 onKeyDown = function( event )
\r
212 holdCtrlKey = event.data.$.ctrlKey || event.data.$.metaKey;
\r
214 resetOnKeyUp = function()
\r
219 element.on( 'keydown', onKeyDown );
\r
220 element.on( 'keyup', resetOnKeyUp );
\r
221 element.on( 'contextmenu', resetOnKeyUp );
\r
225 addListener : function( listenerFn )
\r
227 this._.listeners.push( listenerFn );
\r
230 show : function( offsetParent, corner, offsetX, offsetY )
\r
232 this.editor.focus();
\r
233 this._.onMenu( offsetParent || CKEDITOR.document.getDocumentElement(), corner, offsetX || 0, offsetY || 0 );
\r
239 * Whether to show the browser native context menu when the CTRL or the
\r
240 * META (Mac) key is pressed while opening the context menu.
\r
241 * @name CKEDITOR.config.browserContextMenuOnCtrl
\r
246 * config.browserContextMenuOnCtrl = false;
\r