X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=_source%2Fplugins%2Fmenu%2Fplugin.js;h=0165d31041297c431818dc672e997019b615397a;hb=f0610347140239143439a511ee2bd48cb784f470;hp=ed91d1c6b85b70a624ee374350b459bf28fb3d24;hpb=c6e377a02b54abc07129d72b632763c727476a15;p=ckeditor.git

diff --git a/_source/plugins/menu/plugin.js b/_source/plugins/menu/plugin.js
index ed91d1c..0165d31 100644
--- a/_source/plugins/menu/plugin.js
+++ b/_source/plugins/menu/plugin.js
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
+Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
 For licensing, see LICENSE.html or http://ckeditor.com/license
 */
 
@@ -14,17 +14,36 @@ CKEDITOR.plugins.add( 'menu',
 		for ( var i = 0 ; i < groups.length ; i++ )
 			groupsOrder[ groups[ i ] ] = i + 1;
 
+		/**
+		 * Registers an item group to the editor context menu in order to make it
+		 * possible to associate it with menu items later.
+		 * @name CKEDITOR.editor.prototype.addMenuGroup
+		 * @param {String} name Specify a group name.
+		 * @param {Number} [order=100] Define the display sequence of this group
+		 *  	inside the menu. A smaller value gets displayed first.
+		 */
 		editor.addMenuGroup = function( name, order )
 			{
 				groupsOrder[ name ] = order || 100;
 			};
 
+		/**
+		 * Adds an item from the specified definition to the editor context menu.
+		 * @name CKEDITOR.editor.prototype.addMenuItem
+		 * @param {String} name The menu item name.
+		 * @param {CKEDITOR.menu.definition} definition The menu item definition.
+		 */
 		editor.addMenuItem = function( name, definition )
 			{
 				if ( groupsOrder[ definition.group ] )
 					menuItems[ name ] = new CKEDITOR.menuItem( this, name, definition );
 			};
 
+		/**
+		 * Adds one or more items from the specified definition array to the editor context menu.
+		 * @name CKEDITOR.editor.prototype.addMenuItems
+		 * @param {Array} definitions List of definitions for each menu item as if {@link CKEDITOR.editor.addMenuItem} is called.
+		 */
 		editor.addMenuItems = function( definitions )
 			{
 				for ( var itemName in definitions )
@@ -33,10 +52,27 @@ CKEDITOR.plugins.add( 'menu',
 				}
 			};
 
+		/**
+		 * Retrieves a particular menu item definition from the editor context menu.
+		 * @name CKEDITOR.editor.prototype.getMenuItem
+		 * @param {String} name The name of the desired menu item.
+		 * @return {CKEDITOR.menu.definition}
+		 */
 		editor.getMenuItem = function( name )
 			{
 				return menuItems[ name ];
 			};
+
+		/**
+		 * Removes a particular menu item added before from the editor context menu.
+		 * @name CKEDITOR.editor.prototype.removeMenuItem
+		 * @param {String} name The name of the desired menu item.
+		 * @since 3.6.1
+		 */
+		editor.removeMenuItem = function( name )
+			{
+				delete menuItems[ name ];
+			};
 	},
 
 	requires : [ 'floatpanel' ]
@@ -46,18 +82,108 @@ CKEDITOR.plugins.add( 'menu',
 {
 	CKEDITOR.menu = CKEDITOR.tools.createClass(
 	{
-		$ : function( editor, level )
+		$ : function( editor, definition )
 		{
-			this.id = 'cke_' + CKEDITOR.tools.getNextNumber();
+			definition = this._.definition = definition || {};
+			this.id = CKEDITOR.tools.getNextId();
 
 			this.editor = editor;
 			this.items = [];
+			this._.listeners = [];
 
-			this._.level = level || 1;
+			this._.level = definition.level || 1;
+
+			var panelDefinition = CKEDITOR.tools.extend( {}, definition.panel,
+			{
+				css : editor.skin.editor.css,
+				level : this._.level - 1,
+				block : {}
+			} );
+
+			var attrs = panelDefinition.block.attributes = ( panelDefinition.attributes || {} );
+			// Provide default role of 'menu'.
+			!attrs.role && ( attrs.role = 'menu' );
+			this._.panelDefinition = panelDefinition;
 		},
 
 		_ :
 		{
+			onShow : function()
+			{
+				var selection = this.editor.getSelection();
+
+				// Selection will be unavailable after menu shows up
+				// in IE, lock it now.
+				if ( CKEDITOR.env.ie )
+					selection && selection.lock();
+
+				var element = selection && selection.getStartElement(),
+					listeners = this._.listeners,
+					includedItems = [];
+
+				this.removeAll();
+				// Call all listeners, filling the list of items to be displayed.
+				for ( var i = 0 ; i < listeners.length ; i++ )
+				{
+					var listenerItems = listeners[ i ]( element, selection );
+
+					if ( listenerItems )
+					{
+						for ( var itemName in listenerItems )
+						{
+							var item = this.editor.getMenuItem( itemName );
+
+							if ( item && ( !item.command || this.editor.getCommand( item.command ).state ) )
+							{
+								item.state = listenerItems[ itemName ];
+								this.add( item );
+							}
+						}
+					}
+				}
+			},
+
+			onClick : function( item )
+			{
+				this.hide( false );
+
+				if ( item.onClick )
+					item.onClick();
+				else if ( item.command )
+					this.editor.execCommand( item.command );
+			},
+
+			onEscape : function( keystroke )
+			{
+				var parent = this.parent;
+				// 1. If it's sub-menu, restore the last focused item
+				// of upper level menu.
+				// 2. In case of a top-menu, close it.
+				if ( parent )
+				{
+					parent._.panel.hideChild();
+					// Restore parent block item focus.
+					var parentBlock = parent._.panel._.panel._.currentBlock,
+						parentFocusIndex =  parentBlock._.focusIndex;
+					parentBlock._.markItem( parentFocusIndex );
+				}
+				else if ( keystroke == 27 )
+					this.hide();
+
+				return false;
+			},
+
+			onHide : function()
+			{
+				if ( CKEDITOR.env.ie )
+				{
+					var selection = this.editor.getSelection();
+					selection && selection.unlock();
+				}
+
+				this.onHide && this.onHide();
+			},
+
 			showSubMenu : function( index )
 			{
 				var menu = this._.subMenu,
@@ -72,15 +198,20 @@ CKEDITOR.plugins.add( 'menu',
 					return;
 				}
 
+				// Record parent menu focused item first (#3389).
+				var block = this._.panel.getBlock( this.id );
+				block._.focusIndex = index;
+
 				// Create the submenu, if not available, or clean the existing
 				// one.
 				if ( menu )
 					menu.removeAll();
 				else
 				{
-					menu = this._.subMenu = new CKEDITOR.menu( this.editor, this._.level + 1 );
+					menu = this._.subMenu = new CKEDITOR.menu( this.editor,
+								   CKEDITOR.tools.extend( {}, this._.definition, { level : this._.level + 1 }, true ) );
 					menu.parent = this;
-					menu.onClick = CKEDITOR.tools.bind( this.onClick, this );
+					menu._.onClick = CKEDITOR.tools.bind( this._.onClick, this );
 				}
 
 				// Add all submenu items to the menu.
@@ -122,6 +253,17 @@ CKEDITOR.plugins.add( 'menu',
 
 			show : function( offsetParent, corner, offsetX, offsetY )
 			{
+				// Not for sub menu.
+				if ( !this.parent )
+				{
+					this._.onShow();
+					// Don't menu with zero items.
+					if ( ! this.items.length )
+						return;
+				}
+
+				corner = corner || ( this.editor.lang.dir == 'rtl' ? 2 : 1 );
+
 				var items = this.items,
 					editor = this.editor,
 					panel = this._.panel,
@@ -130,29 +272,26 @@ CKEDITOR.plugins.add( 'menu',
 				// Create the floating panel for this menu.
 				if ( !panel )
 				{
-					panel = this._.panel = new CKEDITOR.ui.floatPanel( this.editor, CKEDITOR.document.getBody(),
-						{
-							css : editor.skin.editor.css,
-							level : this._.level - 1,
-							className : editor.skinClass + ' cke_contextmenu'
-						},
-						this._.level);
+					panel = this._.panel = new CKEDITOR.ui.floatPanel( this.editor,
+						CKEDITOR.document.getBody(),
+						this._.panelDefinition,
+						this._.level );
 
-					panel.onEscape = CKEDITOR.tools.bind( function()
+					panel.onEscape = CKEDITOR.tools.bind( function( keystroke )
 					{
-						this.onEscape && this.onEscape();
-						this.hide();
+						if ( this._.onEscape( keystroke ) === false )
+							return false;
 					},
 					this );
 
 					panel.onHide = CKEDITOR.tools.bind( function()
 					{
-						this.onHide && this.onHide();
+						this._.onHide && this._.onHide();
 					},
 					this );
 
 					// Create an autosize block inside the panel.
-					var block = panel.addBlock( this.id );
+					var block = panel.addBlock( this.id, this._.panelDefinition.block );
 					block.autoSize = true;
 
 					var keys = block.keys;
@@ -160,8 +299,9 @@ CKEDITOR.plugins.add( 'menu',
 					keys[ 9 ]	= 'next';					// TAB
 					keys[ 38 ]	= 'prev';					// ARROW-UP
 					keys[ CKEDITOR.SHIFT + 9 ]	= 'prev';	// SHIFT + TAB
-					keys[ 32 ]	= 'click';					// SPACE
-					keys[ 39 ]	= 'click';					// ARROW-RIGHT
+					keys[ ( editor.lang.dir == 'rtl' ? 37 : 39 ) ]= CKEDITOR.env.ie ? 'mouseup' : 'click';  // ARROW-RIGHT/ARROW-LEFT(rtl)
+					keys[ 32 ]	= CKEDITOR.env.ie ? 'mouseup' : 'click';					// SPACE
+					CKEDITOR.env.ie && ( keys[ 13 ] = 'mouseup' );		// Manage ENTER, since onclick is blocked in IE (#8041).
 
 					element = this._.element = block.element;
 					element.addClass( editor.skinClass );
@@ -173,15 +313,15 @@ CKEDITOR.plugins.add( 'menu',
 					this._.itemOverFn = CKEDITOR.tools.addFunction( function( index )
 						{
 							clearTimeout( this._.showSubTimeout );
-							this._.showSubTimeout = CKEDITOR.tools.setTimeout( this._.showSubMenu, editor.config.menu_subMenuDelay, this, [ index ] );
+							this._.showSubTimeout = CKEDITOR.tools.setTimeout( this._.showSubMenu, editor.config.menu_subMenuDelay || 400, this, [ index ] );
 						},
-						this);
+						this );
 
 					this._.itemOutFn = CKEDITOR.tools.addFunction( function( index )
 						{
 							clearTimeout( this._.showSubTimeout );
 						},
-						this);
+						this );
 
 					this._.itemClickFn = CKEDITOR.tools.addFunction( function( index )
 						{
@@ -196,16 +336,19 @@ CKEDITOR.plugins.add( 'menu',
 							if ( item.getItems )
 								this._.showSubMenu( index );
 							else
-								this.onClick && this.onClick( item );
+								this._.onClick( item );
 						},
-						this);
+						this );
 				}
 
 				// Put the items in the right order.
 				sortItems( items );
 
+				var chromeRoot = editor.container.getChild( 1 ),
+					mixedContentClass = chromeRoot.hasClass( 'cke_mixed_dir_content' ) ? ' cke_mixed_dir_content' : '';
+
 				// Build the HTML that composes the menu and its items.
-				var output = [ '<div class="cke_menu">' ];
+				var output = [ '<div class="cke_menu' + mixedContentClass + '" role="presentation">' ];
 
 				var length = items.length,
 					lastGroup = length && items[ 0 ].group;
@@ -215,7 +358,7 @@ CKEDITOR.plugins.add( 'menu',
 					var item = items[ i ];
 					if ( lastGroup != item.group )
 					{
-						output.push( '<div class="cke_menuseparator"></div>' );
+						output.push( '<div class="cke_menuseparator" role="separator"></div>' );
 						lastGroup = item.group;
 					}
 
@@ -227,6 +370,8 @@ CKEDITOR.plugins.add( 'menu',
 				// Inject the HTML inside the panel.
 				element.setHtml( output.join( '' ) );
 
+				CKEDITOR.ui.fire( 'ready', this );
+
 				// Show the panel.
 				if ( this.parent )
 					this.parent._.panel.showAsChild( panel, this.id, offsetParent, corner, offsetX, offsetY );
@@ -236,9 +381,15 @@ CKEDITOR.plugins.add( 'menu',
 				editor.fire( 'menuShow', [ panel ] );
 			},
 
-			hide : function()
+			addListener : function( listenerFn )
 			{
-				this._.panel && this._.panel.hide();
+				this._.listeners.push( listenerFn );
+			},
+
+			hide : function( returnFocus )
+			{
+				this._.onHide && this._.onHide();
+				this._.panel && this._.panel.hide( returnFocus );
 			}
 		}
 	});
@@ -257,77 +408,80 @@ CKEDITOR.plugins.add( 'menu',
 					0;
 			});
 	}
-})();
-
-CKEDITOR.menuItem = CKEDITOR.tools.createClass(
-{
-	$ : function( editor, name, definition )
+	CKEDITOR.menuItem = CKEDITOR.tools.createClass(
 	{
-		CKEDITOR.tools.extend( this, definition,
-			// Defaults
-			{
-				order : 0,
-				className : 'cke_button_' + name
-			});
+		$ : function( editor, name, definition )
+		{
+			CKEDITOR.tools.extend( this, definition,
+				// Defaults
+				{
+					order : 0,
+					className : 'cke_button_' + name
+				});
 
-		// Transform the group name into its order number.
-		this.group = editor._.menuGroups[ this.group ];
+			// Transform the group name into its order number.
+			this.group = editor._.menuGroups[ this.group ];
 
-		this.editor = editor;
-		this.name = name;
-	},
+			this.editor = editor;
+			this.name = name;
+		},
 
-	proto :
-	{
-		render : function( menu, index, output )
+		proto :
 		{
-			var id = menu.id + String( index ),
-				state = ( typeof this.state == 'undefined' ) ? CKEDITOR.TRISTATE_OFF : this.state;
+			render : function( menu, index, output )
+			{
+				var id = menu.id + String( index ),
+					state = ( typeof this.state == 'undefined' ) ? CKEDITOR.TRISTATE_OFF : this.state;
+
+				var classes = ' cke_' + (
+					state == CKEDITOR.TRISTATE_ON ? 'on' :
+					state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' :
+					'off' );
 
-			var classes = ' cke_' + (
-				state == CKEDITOR.TRISTATE_ON ? 'on' :
-				state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' :
-				'off' );
+				var htmlLabel = this.label;
 
-			var htmlLabel = this.label;
-			if ( state == CKEDITOR.TRISTATE_DISABLED )
-				htmlLabel = this.editor.lang.common.unavailable.replace( '%1', htmlLabel );
+				if ( this.className )
+					classes += ' ' + this.className;
 
-			if ( this.className )
-				classes += ' ' + this.className;
+			var hasSubMenu = this.getItems;
 
 			output.push(
-				'<span class="cke_menuitem">' +
+				'<span class="cke_menuitem' + ( this.icon && this.icon.indexOf( '.png' ) == -1 ? ' cke_noalphafix' : '' ) + '">' +
 				'<a id="', id, '"' +
 					' class="', classes, '" href="javascript:void(\'', ( this.label || '' ).replace( "'", '' ), '\')"' +
 					' title="', this.label, '"' +
 					' tabindex="-1"' +
 					'_cke_focus=1' +
-					' hidefocus="true"' );
+					' hidefocus="true"' +
+					' role="menuitem"' +
+					( hasSubMenu ? 'aria-haspopup="true"' : '' ) +
+					( state == CKEDITOR.TRISTATE_DISABLED ? 'aria-disabled="true"' : '' ) +
+					( state == CKEDITOR.TRISTATE_ON ? 'aria-pressed="true"' : '' ) );
+
+				// Some browsers don't cancel key events in the keydown but in the
+				// keypress.
+				// TODO: Check if really needed for Gecko+Mac.
+				if ( CKEDITOR.env.opera || ( CKEDITOR.env.gecko && CKEDITOR.env.mac ) )
+				{
+					output.push(
+						' onkeypress="return false;"' );
+				}
 
-			// Some browsers don't cancel key events in the keydown but in the
-			// keypress.
-			// TODO: Check if really needed for Gecko+Mac.
-			if ( CKEDITOR.env.opera || ( CKEDITOR.env.gecko && CKEDITOR.env.mac ) )
-			{
-				output.push(
-					' onkeypress="return false;"' );
-			}
+				// With Firefox, we need to force the button to redraw, otherwise it
+				// will remain in the focus state.
+				if ( CKEDITOR.env.gecko )
+				{
+					output.push(
+						' onblur="this.style.cssText = this.style.cssText;"' );
+				}
 
-			// With Firefox, we need to force the button to redraw, otherwise it
-			// will remain in the focus state.
-			if ( CKEDITOR.env.gecko )
-			{
+				var offset = ( this.iconOffset || 0 ) * -16;
 				output.push(
-					' onblur="this.style.cssText = this.style.cssText;"' );
-			}
-
-			var offset = ( this.iconOffset || 0 ) * -16;
-			output.push(
 //					' onkeydown="return CKEDITOR.ui.button._.keydown(', index, ', event);"' +
 					' onmouseover="CKEDITOR.tools.callFunction(', menu._.itemOverFn, ',', index, ');"' +
-					' onmouseout="CKEDITOR.tools.callFunction(', menu._.itemOutFn, ',', index, ');"' +
-					' onclick="CKEDITOR.tools.callFunction(', menu._.itemClickFn, ',', index, '); return false;"' +
+					' onmouseout="CKEDITOR.tools.callFunction(', menu._.itemOutFn, ',', index, ');" ' +
+					( CKEDITOR.env.ie ? 'onclick="return false;" onmouseup' : 'onclick' ) +		// #188
+						'="CKEDITOR.tools.callFunction(', menu._.itemClickFn, ',', index, '); return false;"' +
 					'>' +
 						'<span class="cke_icon_wrapper"><span class="cke_icon"' +
 							( this.icon ? ' style="background-image:url(' + CKEDITOR.getUrl( this.icon ) + ');background-position:0 ' + offset + 'px;"'
@@ -335,7 +489,7 @@ CKEDITOR.menuItem = CKEDITOR.tools.createClass(
 							'></span></span>' +
 						'<span class="cke_label">' );
 
-			if ( this.getItems )
+			if ( hasSubMenu )
 			{
 				output.push(
 							'<span class="cke_menuarrow">',
@@ -347,18 +501,21 @@ CKEDITOR.menuItem = CKEDITOR.tools.createClass(
 							'</span>' );
 			}
 
-			output.push(
-							htmlLabel,
-						'</span>' +
-				'</a>' +
-				'</span>' );
+				output.push(
+								htmlLabel,
+							'</span>' +
+					'</a>' +
+					'</span>' );
 		}
-	}
-});
+		}
+	});
+
+})();
+
 
 /**
- * The amount of time, in milliseconds, the editor waits before showing submenu
- * options when moving the mouse over options that contains submenus, like the
+ * The amount of time, in milliseconds, the editor waits before displaying submenu
+ * options when moving the mouse over options that contain submenus, like the
  * "Cell Properties" entry for tables.
  * @type Number
  * @default 400
@@ -366,12 +523,11 @@ CKEDITOR.menuItem = CKEDITOR.tools.createClass(
  * // Remove the submenu delay.
  * config.menu_subMenuDelay = 0;
  */
-CKEDITOR.config.menu_subMenuDelay = 400;
 
 /**
  * A comma separated list of items group names to be displayed in the context
- * menu. The items order will reflect the order in this list if no priority
- * has been definted in the groups.
+ * menu. The order of items will reflect the order specified in this list if
+ * no priority was defined in the groups.
  * @type String
  * @default 'clipboard,form,tablecell,tablecellproperties,tablerow,tablecolumn,table,anchor,link,image,flash,checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea'
  * @example