Update to 4.7.3

[perso/Immae/Projets/packagist/ludivine-ckeditor-component.git] / sources / plugins / menu / plugin.js

/**\r
 * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.\r
 * For licensing, see LICENSE.md or http://ckeditor.com/license\r
 */\r
\r
CKEDITOR.plugins.add( 'menu', {\r
	requires: 'floatpanel',\r
\r
	beforeInit: function( editor ) {\r
		var groups = editor.config.menu_groups.split( ',' ),\r
			groupsOrder = editor._.menuGroups = {},\r
			menuItems = editor._.menuItems = {};\r
\r
		for ( var i = 0; i < groups.length; i++ )\r
			groupsOrder[ groups[ i ] ] = i + 1;\r
\r
		/**\r
		 * Registers an item group to the editor context menu in order to make it\r
		 * possible to associate it with menu items later.\r
		 *\r
		 * @param {String} name Specify a group name.\r
		 * @param {Number} [order=100] Define the display sequence of this group\r
		 * inside the menu. A smaller value gets displayed first.\r
		 * @member CKEDITOR.editor\r
		 */\r
		editor.addMenuGroup = function( name, order ) {\r
			groupsOrder[ name ] = order || 100;\r
		};\r
\r
		/**\r
		 * Adds an item from the specified definition to the editor context menu.\r
		 *\r
		 * @method\r
		 * @param {String} name The menu item name.\r
		 * @param {Object} definition The menu item definition.\r
		 * @member CKEDITOR.editor\r
		 */\r
		editor.addMenuItem = function( name, definition ) {\r
			if ( groupsOrder[ definition.group ] )\r
				menuItems[ name ] = new CKEDITOR.menuItem( this, name, definition );\r
		};\r
\r
		/**\r
		 * Adds one or more items from the specified definition object to the editor context menu.\r
		 *\r
		 * @method\r
		 * @param {Object} definitions Object where keys are used as itemName and corresponding values as definition for a {@link #addMenuItem} call.\r
		 * @member CKEDITOR.editor\r
		 */\r
		editor.addMenuItems = function( definitions ) {\r
			for ( var itemName in definitions ) {\r
				this.addMenuItem( itemName, definitions[ itemName ] );\r
			}\r
		};\r
\r
		/**\r
		 * Retrieves a particular menu item definition from the editor context menu.\r
		 *\r
		 * @method\r
		 * @param {String} name The name of the desired menu item.\r
		 * @returns {Object}\r
		 * @member CKEDITOR.editor\r
		 */\r
		editor.getMenuItem = function( name ) {\r
			return menuItems[ name ];\r
		};\r
\r
		/**\r
		 * Removes a particular menu item added before from the editor context menu.\r
		 *\r
		 * @since 3.6.1\r
		 * @method\r
		 * @param {String} name The name of the desired menu item.\r
		 * @member CKEDITOR.editor\r
		 */\r
		editor.removeMenuItem = function( name ) {\r
			delete menuItems[ name ];\r
		};\r
	}\r
} );\r
\r
( function() {\r
	var menuItemSource = '<span class="cke_menuitem">' +\r
		'<a id="{id}"' +\r
		' class="cke_menubutton cke_menubutton__{name} cke_menubutton_{state} {cls}" href="{href}"' +\r
		' title="{title}"' +\r
		' tabindex="-1"' +\r
		' _cke_focus=1' +\r
		' hidefocus="true"' +\r
		' role="{role}"' +\r
		' aria-label="{label}"' +\r
		' aria-describedby="{id}_description"' +\r
		' aria-haspopup="{hasPopup}"' +\r
		' aria-disabled="{disabled}"' +\r
		' {ariaChecked}' +\r
		' draggable="false"';\r
\r
	// Some browsers don't cancel key events in the keydown but in the\r
	// keypress.\r
	// TODO: Check if really needed.\r
	if ( CKEDITOR.env.gecko && CKEDITOR.env.mac )\r
		menuItemSource += ' onkeypress="return false;"';\r
\r
	// With Firefox, we need to force the button to redraw, otherwise it\r
	// will remain in the focus state. Also we some extra help to prevent dragging (http://dev.ckeditor.com/ticket/10373).\r
	if ( CKEDITOR.env.gecko ) {\r
		menuItemSource += ( ' onblur="this.style.cssText = this.style.cssText;"' +\r
			' ondragstart="return false;"' );\r
	}\r
\r
	// http://dev.ckeditor.com/ticket/188\r
	menuItemSource += ' onmouseover="CKEDITOR.tools.callFunction({hoverFn},{index});"' +\r
			' onmouseout="CKEDITOR.tools.callFunction({moveOutFn},{index});" ' +\r
			( CKEDITOR.env.ie ? 'onclick="return false;" onmouseup' : 'onclick' ) +\r
				'="CKEDITOR.tools.callFunction({clickFn},{index}); return false;"' +\r
			'>';\r
\r
	menuItemSource +=\r
				//'' +\r
				'<span class="cke_menubutton_inner">' +\r
					'<span class="cke_menubutton_icon">' +\r
						'<span class="cke_button_icon cke_button__{iconName}_icon" style="{iconStyle}"></span>' +\r
					'</span>' +\r
					'<span class="cke_menubutton_label">' +\r
						'{label}' +\r
					'</span>' +\r
					'{shortcutHtml}' +\r
					'{arrowHtml}' +\r
				'</span>' +\r
			'</a><span id="{id}_description" class="cke_voice_label" aria-hidden="false">{ariaShortcut}</span></span>';\r
\r
	var menuArrowSource = '<span class="cke_menuarrow">' +\r
				'<span>{label}</span>' +\r
			'</span>';\r
\r
	var menuShortcutSource = '<span class="cke_menubutton_label cke_menubutton_shortcut">' +\r
				'{shortcut}' +\r
			'</span>';\r
\r
	var menuItemTpl = CKEDITOR.addTemplate( 'menuItem', menuItemSource ),\r
		menuArrowTpl = CKEDITOR.addTemplate( 'menuArrow', menuArrowSource ),\r
		menuShortcutTpl = CKEDITOR.addTemplate( 'menuShortcut', menuShortcutSource );\r
\r
	/**\r
	 * @class\r
	 * @todo\r
	 */\r
	CKEDITOR.menu = CKEDITOR.tools.createClass( {\r
		/**\r
		 * @constructor\r
		 */\r
		$: function( editor, definition ) {\r
			definition = this._.definition = definition || {};\r
			this.id = CKEDITOR.tools.getNextId();\r
\r
			this.editor = editor;\r
			this.items = [];\r
			this._.listeners = [];\r
\r
			this._.level = definition.level || 1;\r
\r
			var panelDefinition = CKEDITOR.tools.extend( {}, definition.panel, {\r
				css: [ CKEDITOR.skin.getPath( 'editor' ) ],\r
				level: this._.level - 1,\r
				block: {}\r
			} );\r
\r
			var attrs = panelDefinition.block.attributes = ( panelDefinition.attributes || {} );\r
			// Provide default role of 'menu'.\r
			!attrs.role && ( attrs.role = 'menu' );\r
			this._.panelDefinition = panelDefinition;\r
		},\r
\r
		_: {\r
			onShow: function() {\r
				var selection = this.editor.getSelection(),\r
					start = selection && selection.getStartElement(),\r
					path = this.editor.elementPath(),\r
					listeners = this._.listeners;\r
\r
				this.removeAll();\r
				// Call all listeners, filling the list of items to be displayed.\r
				for ( var i = 0; i < listeners.length; i++ ) {\r
					var listenerItems = listeners[ i ]( start, selection, path );\r
\r
					if ( listenerItems ) {\r
						for ( var itemName in listenerItems ) {\r
							var item = this.editor.getMenuItem( itemName );\r
\r
							if ( item && ( !item.command || this.editor.getCommand( item.command ).state ) ) {\r
								item.state = listenerItems[ itemName ];\r
								this.add( item );\r
							}\r
						}\r
					}\r
				}\r
			},\r
\r
			onClick: function( item ) {\r
				this.hide();\r
\r
				if ( item.onClick )\r
					item.onClick();\r
				else if ( item.command )\r
					this.editor.execCommand( item.command );\r
			},\r
\r
			onEscape: function( keystroke ) {\r
				var parent = this.parent;\r
				// 1. If it's sub-menu, close it, with focus restored on this.\r
				// 2. In case of a top-menu, close it, with focus returned to page.\r
				if ( parent )\r
					parent._.panel.hideChild( 1 );\r
				else if ( keystroke == 27 )\r
					this.hide( 1 );\r
\r
				return false;\r
			},\r
\r
			onHide: function() {\r
				this.onHide && this.onHide();\r
			},\r
\r
			showSubMenu: function( index ) {\r
				var menu = this._.subMenu,\r
					item = this.items[ index ],\r
					subItemDefs = item.getItems && item.getItems();\r
\r
				// If this item has no subitems, we just hide the submenu, if\r
				// available, and return back.\r
				if ( !subItemDefs ) {\r
					// Hide sub menu with focus returned.\r
					this._.panel.hideChild( 1 );\r
					return;\r
				}\r
\r
				// Create the submenu, if not available, or clean the existing\r
				// one.\r
				if ( menu )\r
					menu.removeAll();\r
				else {\r
					menu = this._.subMenu = new CKEDITOR.menu( this.editor, CKEDITOR.tools.extend( {}, this._.definition, { level: this._.level + 1 }, true ) );\r
					menu.parent = this;\r
					menu._.onClick = CKEDITOR.tools.bind( this._.onClick, this );\r
				}\r
\r
				// Add all submenu items to the menu.\r
				for ( var subItemName in subItemDefs ) {\r
					var subItem = this.editor.getMenuItem( subItemName );\r
					if ( subItem ) {\r
						subItem.state = subItemDefs[ subItemName ];\r
						menu.add( subItem );\r
					}\r
				}\r
\r
				// Get the element representing the current item.\r
				var element = this._.panel.getBlock( this.id ).element.getDocument().getById( this.id + String( index ) );\r
\r
				// Show the submenu.\r
				// This timeout is needed to give time for the sub-menu get\r
				// focus when JAWS is running. (http://dev.ckeditor.com/ticket/9844)\r
				setTimeout( function() {\r
					menu.show( element, 2 );\r
				}, 0 );\r
			}\r
		},\r
\r
		proto: {\r
			/**\r
			 * Adds an item.\r
			 *\r
			 * @param item\r
			 */\r
			add: function( item ) {\r
				// Later we may sort the items, but Array#sort is not stable in\r
				// some browsers, here we're forcing the original sequence with\r
				// 'order' attribute if it hasn't been assigned. (http://dev.ckeditor.com/ticket/3868)\r
				if ( !item.order )\r
					item.order = this.items.length;\r
\r
				this.items.push( item );\r
			},\r
\r
			/**\r
			 * Removes all items.\r
			 */\r
			removeAll: function() {\r
				this.items = [];\r
			},\r
\r
			/**\r
			 * Shows the menu in given location.\r
			 *\r
			 * @param {CKEDITOR.dom.element} offsetParent\r
			 * @param {Number} [corner]\r
			 * @param {Number} [offsetX]\r
			 * @param {Number} [offsetY]\r
			 */\r
			show: function( offsetParent, corner, offsetX, offsetY ) {\r
				// Not for sub menu.\r
				if ( !this.parent ) {\r
					this._.onShow();\r
					// Don't menu with zero items.\r
					if ( !this.items.length )\r
						return;\r
				}\r
\r
				corner = corner || ( this.editor.lang.dir == 'rtl' ? 2 : 1 );\r
\r
				var items = this.items,\r
					editor = this.editor,\r
					panel = this._.panel,\r
					element = this._.element;\r
\r
				// Create the floating panel for this menu.\r
				if ( !panel ) {\r
					panel = this._.panel = new CKEDITOR.ui.floatPanel( this.editor, CKEDITOR.document.getBody(), this._.panelDefinition, this._.level );\r
\r
					panel.onEscape = CKEDITOR.tools.bind( function( keystroke ) {\r
						if ( this._.onEscape( keystroke ) === false )\r
							return false;\r
					}, this );\r
\r
					panel.onShow = function() {\r
						// Menu need CSS resets, compensate class name.\r
						var holder = panel._.panel.getHolderElement();\r
						holder.getParent().addClass( 'cke' ).addClass( 'cke_reset_all' );\r
					};\r
\r
					panel.onHide = CKEDITOR.tools.bind( function() {\r
						this._.onHide && this._.onHide();\r
					}, this );\r
\r
					// Create an autosize block inside the panel.\r
					var block = panel.addBlock( this.id, this._.panelDefinition.block );\r
					block.autoSize = true;\r
\r
					var keys = block.keys;\r
					keys[ 40 ] = 'next'; // ARROW-DOWN\r
					keys[ 9 ] = 'next'; // TAB\r
					keys[ 38 ] = 'prev'; // ARROW-UP\r
					keys[ CKEDITOR.SHIFT + 9 ] = 'prev'; // SHIFT + TAB\r
					keys[ ( editor.lang.dir == 'rtl' ? 37 : 39 ) ] = CKEDITOR.env.ie ? 'mouseup' : 'click'; // ARROW-RIGHT/ARROW-LEFT(rtl)\r
					keys[ 32 ] = CKEDITOR.env.ie ? 'mouseup' : 'click'; // SPACE\r
					CKEDITOR.env.ie && ( keys[ 13 ] = 'mouseup' ); // Manage ENTER, since onclick is blocked in IE (http://dev.ckeditor.com/ticket/8041).\r
\r
					element = this._.element = block.element;\r
\r
					var elementDoc = element.getDocument();\r
					elementDoc.getBody().setStyle( 'overflow', 'hidden' );\r
					elementDoc.getElementsByTag( 'html' ).getItem( 0 ).setStyle( 'overflow', 'hidden' );\r
\r
					this._.itemOverFn = CKEDITOR.tools.addFunction( function( index ) {\r
						clearTimeout( this._.showSubTimeout );\r
						this._.showSubTimeout = CKEDITOR.tools.setTimeout( this._.showSubMenu, editor.config.menu_subMenuDelay || 400, this, [ index ] );\r
					}, this );\r
\r
					this._.itemOutFn = CKEDITOR.tools.addFunction( function() {\r
						clearTimeout( this._.showSubTimeout );\r
					}, this );\r
\r
					this._.itemClickFn = CKEDITOR.tools.addFunction( function( index ) {\r
						var item = this.items[ index ];\r
\r
						if ( item.state == CKEDITOR.TRISTATE_DISABLED ) {\r
							this.hide( 1 );\r
							return;\r
						}\r
\r
						if ( item.getItems )\r
							this._.showSubMenu( index );\r
						else\r
							this._.onClick( item );\r
					}, this );\r
				}\r
\r
				// Put the items in the right order.\r
				sortItems( items );\r
\r
				// Apply the editor mixed direction status to menu.\r
				var path = editor.elementPath(),\r
					mixedDirCls = ( path && path.direction() != editor.lang.dir ) ? ' cke_mixed_dir_content' : '';\r
\r
				// Build the HTML that composes the menu and its items.\r
				var output = [ '<div class="cke_menu' + mixedDirCls + '" role="presentation">' ];\r
\r
				var length = items.length,\r
					lastGroup = length && items[ 0 ].group;\r
\r
				for ( var i = 0; i < length; i++ ) {\r
					var item = items[ i ];\r
					if ( lastGroup != item.group ) {\r
						output.push( '<div class="cke_menuseparator" role="separator"></div>' );\r
						lastGroup = item.group;\r
					}\r
\r
					item.render( this, i, output );\r
				}\r
\r
				output.push( '</div>' );\r
\r
				// Inject the HTML inside the panel.\r
				element.setHtml( output.join( '' ) );\r
\r
				CKEDITOR.ui.fire( 'ready', this );\r
\r
				// Show the panel.\r
				if ( this.parent )\r
					this.parent._.panel.showAsChild( panel, this.id, offsetParent, corner, offsetX, offsetY );\r
				else\r
					panel.showBlock( this.id, offsetParent, corner, offsetX, offsetY );\r
\r
				editor.fire( 'menuShow', [ panel ] );\r
			},\r
\r
			/**\r
			 * Adds a callback executed on opening the menu. Items\r
			 * returned by that callback are added to the menu.\r
			 *\r
			 * @param {Function} listenerFn\r
			 * @param {CKEDITOR.dom.element} listenerFn.startElement The selection start anchor element.\r
			 * @param {CKEDITOR.dom.selection} listenerFn.selection The current selection.\r
			 * @param {CKEDITOR.dom.elementPath} listenerFn.path The current elements path.\r
			 * @param listenerFn.return Object (`commandName` => `state`) of items that should be added to the menu.\r
			 */\r
			addListener: function( listenerFn ) {\r
				this._.listeners.push( listenerFn );\r
			},\r
\r
			/**\r
			 * Hides the menu.\r
			 *\r
			 * @param {Boolean} [returnFocus]\r
			 */\r
			hide: function( returnFocus ) {\r
				this._.onHide && this._.onHide();\r
				this._.panel && this._.panel.hide( returnFocus );\r
			}\r
		}\r
	} );\r
\r
	function sortItems( items ) {\r
		items.sort( function( itemA, itemB ) {\r
			if ( itemA.group < itemB.group )\r
				return -1;\r
			else if ( itemA.group > itemB.group )\r
				return 1;\r
\r
			return itemA.order < itemB.order ? -1 : itemA.order > itemB.order ? 1 : 0;\r
		} );\r
	}\r
\r
	/**\r
	 * @class\r
	 * @todo\r
	 */\r
	CKEDITOR.menuItem = CKEDITOR.tools.createClass( {\r
		$: function( editor, name, definition ) {\r
			CKEDITOR.tools.extend( this, definition,\r
			// Defaults\r
			{\r
				order: 0,\r
				className: 'cke_menubutton__' + name\r
			} );\r
\r
			// Transform the group name into its order number.\r
			this.group = editor._.menuGroups[ this.group ];\r
\r
			this.editor = editor;\r
			this.name = name;\r
		},\r
\r
		proto: {\r
			render: function( menu, index, output ) {\r
				var id = menu.id + String( index ),\r
					state = ( typeof this.state == 'undefined' ) ? CKEDITOR.TRISTATE_OFF : this.state,\r
					ariaChecked = '',\r
					editor = this.editor,\r
					keystroke,\r
					command,\r
					shortcut;\r
\r
				var stateName = state == CKEDITOR.TRISTATE_ON ? 'on' : state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' : 'off';\r
\r
				if ( this.role in { menuitemcheckbox: 1, menuitemradio: 1 } )\r
					ariaChecked = ' aria-checked="' + ( state == CKEDITOR.TRISTATE_ON ? 'true' : 'false' ) + '"';\r
\r
				var hasSubMenu = this.getItems;\r
				// ltr: BLACK LEFT-POINTING POINTER\r
				// rtl: BLACK RIGHT-POINTING POINTER\r
				var arrowLabel = '&#' + ( this.editor.lang.dir == 'rtl' ? '9668' : '9658' ) + ';';\r
\r
				var iconName = this.name;\r
				if ( this.icon && !( /\./ ).test( this.icon ) )\r
					iconName = this.icon;\r
\r
				if ( this.command ) {\r
					command = editor.getCommand( this.command );\r
					keystroke = editor.getCommandKeystroke( command );\r
\r
					if ( keystroke ) {\r
						shortcut = CKEDITOR.tools.keystrokeToString( editor.lang.common.keyboard, keystroke );\r
					}\r
				}\r
\r
				var params = {\r
					id: id,\r
					name: this.name,\r
					iconName: iconName,\r
					label: this.label,\r
					cls: this.className || '',\r
					state: stateName,\r
					hasPopup: hasSubMenu ? 'true' : 'false',\r
					disabled: state == CKEDITOR.TRISTATE_DISABLED,\r
					title: this.label + ( shortcut ? ' (' + shortcut.display + ')' : '' ),\r
					ariaShortcut: shortcut ? editor.lang.common.keyboardShortcut + ' ' + shortcut.aria : '',\r
					href: 'javascript:void(\'' + ( this.label || '' ).replace( "'" + '' ) + '\')', // jshint ignore:line\r
					hoverFn: menu._.itemOverFn,\r
					moveOutFn: menu._.itemOutFn,\r
					clickFn: menu._.itemClickFn,\r
					index: index,\r
					iconStyle: CKEDITOR.skin.getIconStyle( iconName, ( this.editor.lang.dir == 'rtl' ), iconName == this.icon ? null : this.icon, this.iconOffset ),\r
					shortcutHtml: shortcut ? menuShortcutTpl.output( { shortcut: shortcut.display } ) : '',\r
					arrowHtml: hasSubMenu ? menuArrowTpl.output( { label: arrowLabel } ) : '',\r
					role: this.role ? this.role : 'menuitem',\r
					ariaChecked: ariaChecked\r
				};\r
\r
				menuItemTpl.output( params, output );\r
			}\r
		}\r
	} );\r
\r
} )();\r
\r
\r
/**\r
 * The amount of time, in milliseconds, the editor waits before displaying submenu\r
 * options when moving the mouse over options that contain submenus, like the\r
 * "Cell Properties" entry for tables.\r
 *\r
 *		// Remove the submenu delay.\r
 *		config.menu_subMenuDelay = 0;\r
 *\r
 * @cfg {Number} [menu_subMenuDelay=400]\r
 * @member CKEDITOR.config\r
 */\r
\r
/**\r
 * Fired when a menu is shown.\r
 *\r
 * @event menuShow\r
 * @member CKEDITOR.editor\r
 * @param {CKEDITOR.editor} editor This editor instance.\r
 * @param {CKEDITOR.ui.panel[]} data\r
 */\r
\r
/**\r
 * A comma separated list of items group names to be displayed in the context\r
 * menu. The order of items will reflect the order specified in this list if\r
 * no priority was defined in the groups.\r
 *\r
 *		config.menu_groups = 'clipboard,table,anchor,link,image';\r
 *\r
 * @cfg {String} [menu_groups=see source]\r
 * @member CKEDITOR.config\r
 */\r
CKEDITOR.config.menu_groups = 'clipboard,' +\r
	'form,' +\r
	'tablecell,tablecellproperties,tablerow,tablecolumn,table,' +\r
	'anchor,link,image,flash,' +\r
	'checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea,div';\r