2 Copyright (c) 2003-2010, 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
61 else if ( item.command )
\r
62 editor.execCommand( item.command );
\r
66 menu.onEscape = function()
\r
72 var listeners = this._.listeners,
\r
75 var selection = this.editor.getSelection(),
\r
76 element = selection && selection.getStartElement();
\r
78 menu.onHide = CKEDITOR.tools.bind( function()
\r
82 if ( CKEDITOR.env.ie )
\r
84 var selection = editor.getSelection();
\r
85 selection && selection.unlock();
\r
88 this.onHide && this.onHide();
\r
92 // Call all listeners, filling the list of items to be displayed.
\r
93 for ( var i = 0 ; i < listeners.length ; i++ )
\r
95 var listenerItems = listeners[ i ]( element, selection );
\r
97 if ( listenerItems )
\r
99 for ( var itemName in listenerItems )
\r
101 var item = this.editor.getMenuItem( itemName );
\r
105 item.state = listenerItems[ itemName ];
\r
112 // Don't show context menu with zero items.
\r
113 menu.items.length && menu.show( offsetParent, corner || ( editor.lang.dir == 'rtl' ? 2 : 1 ), offsetX, offsetY );
\r
119 addTarget : function( element, nativeContextMenuOnCtrl )
\r
121 // Opera doesn't support 'contextmenu' event, we have duo approaches employed here:
\r
122 // 1. Inherit the 'button override' hack we introduced in v2 (#4530), while this require the Opera browser
\r
123 // option 'Allow script to detect context menu/right click events' to be always turned on.
\r
124 // 2. Considering the fact that ctrl/meta key is not been occupied
\r
125 // for multiple range selecting (like Gecko), we use this key
\r
126 // combination as a fallback for triggering context-menu. (#4530)
\r
127 if ( CKEDITOR.env.opera )
\r
129 var contextMenuOverrideButton;
\r
130 element.on( 'mousedown', function( evt )
\r
133 if ( evt.$.button != 2 )
\r
135 if ( evt.getKeystroke() == CKEDITOR.CTRL + 1 )
\r
136 element.fire( 'contextmenu', evt );
\r
140 if ( nativeContextMenuOnCtrl
\r
141 && ( evt.$.ctrlKey || evt.$.metaKey ) )
\r
144 var target = evt.getTarget();
\r
146 if ( !contextMenuOverrideButton )
\r
148 var ownerDoc = target.getDocument();
\r
149 contextMenuOverrideButton = ownerDoc.createElement( 'input' ) ;
\r
150 contextMenuOverrideButton.$.type = 'button' ;
\r
151 ownerDoc.getBody().append( contextMenuOverrideButton ) ;
\r
154 contextMenuOverrideButton.setAttribute( 'style', 'position:absolute;top:' + ( evt.$.clientY - 2 ) +
\r
155 'px;left:' + ( evt.$.clientX - 2 ) +
\r
156 'px;width:5px;height:5px;opacity:0.01' );
\r
160 element.on( 'mouseup', function ( evt )
\r
162 if ( contextMenuOverrideButton )
\r
164 contextMenuOverrideButton.remove();
\r
165 contextMenuOverrideButton = undefined;
\r
166 // Simulate 'contextmenu' event.
\r
167 element.fire( 'contextmenu', evt.data );
\r
172 element.on( 'contextmenu', function( event )
\r
174 var domEvent = event.data;
\r
176 if ( nativeContextMenuOnCtrl &&
\r
177 // Safari on Windows always show 'ctrlKey' as true in 'contextmenu' event,
\r
178 // which make this property unreliable. (#4826)
\r
179 ( CKEDITOR.env.webkit ? holdCtrlKey : domEvent.$.ctrlKey || domEvent.$.metaKey ) )
\r
182 // Selection will be unavailable after context menu shows up
\r
183 // in IE, lock it now.
\r
184 if ( CKEDITOR.env.ie )
\r
186 var selection = this.editor.getSelection();
\r
187 selection && selection.lock();
\r
190 // Cancel the browser context menu.
\r
191 domEvent.preventDefault();
\r
193 var offsetParent = domEvent.getTarget().getDocument().getDocumentElement(),
\r
194 offsetX = domEvent.$.clientX,
\r
195 offsetY = domEvent.$.clientY;
\r
197 CKEDITOR.tools.setTimeout( function()
\r
199 this._.onMenu( offsetParent, null, offsetX, offsetY );
\r
205 if ( CKEDITOR.env.webkit )
\r
208 onKeyDown = function( event )
\r
210 holdCtrlKey = event.data.$.ctrlKey || event.data.$.metaKey;
\r
212 resetOnKeyUp = function()
\r
217 element.on( 'keydown', onKeyDown );
\r
218 element.on( 'keyup', resetOnKeyUp );
\r
219 element.on( 'contextmenu', resetOnKeyUp );
\r
223 addListener : function( listenerFn )
\r
225 this._.listeners.push( listenerFn );
\r
228 show : function( offsetParent, corner, offsetX, offsetY )
\r
230 this.editor.focus();
\r
231 this._.onMenu( offsetParent || CKEDITOR.document.getDocumentElement(), corner, offsetX || 0, offsetY || 0 );
\r
237 * Whether to show the browser native context menu when the CTRL or the
\r
238 * META (Mac) key is pressed while opening the context menu.
\r
239 * @name CKEDITOR.config.browserContextMenuOnCtrl
\r
244 * config.browserContextMenuOnCtrl = false;
\r