X-Git-Url: https://scm.cri.ensmp.fr/git/ckeditor.git/blobdiff_plain/256592bf803e851aa7fc953e08a6e9e58d970f8c..871bad8291b6dbc29d489d95d185458caab25158:/skins/ckeditor/_source/plugins/menu/plugin.js diff --git a/skins/ckeditor/_source/plugins/menu/plugin.js b/skins/ckeditor/_source/plugins/menu/plugin.js new file mode 100644 index 0000000..0165d31 --- /dev/null +++ b/skins/ckeditor/_source/plugins/menu/plugin.js @@ -0,0 +1,541 @@ +/* +Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved. +For licensing, see LICENSE.html or http://ckeditor.com/license +*/ + +CKEDITOR.plugins.add( 'menu', +{ + beforeInit : function( editor ) + { + var groups = editor.config.menu_groups.split( ',' ), + groupsOrder = editor._.menuGroups = {}, + menuItems = editor._.menuItems = {}; + + 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 ) + { + this.addMenuItem( itemName, definitions[ itemName ] ); + } + }; + + /** + * 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' ] +}); + +(function() +{ + CKEDITOR.menu = CKEDITOR.tools.createClass( + { + $ : function( editor, definition ) + { + definition = this._.definition = definition || {}; + this.id = CKEDITOR.tools.getNextId(); + + this.editor = editor; + this.items = []; + this._.listeners = []; + + 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, + item = this.items[ index ], + subItemDefs = item.getItems && item.getItems(); + + // If this item has no subitems, we just hide the submenu, if + // available, and return back. + if ( !subItemDefs ) + { + this._.panel.hideChild(); + 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, + CKEDITOR.tools.extend( {}, this._.definition, { level : this._.level + 1 }, true ) ); + menu.parent = this; + menu._.onClick = CKEDITOR.tools.bind( this._.onClick, this ); + } + + // Add all submenu items to the menu. + for ( var subItemName in subItemDefs ) + { + var subItem = this.editor.getMenuItem( subItemName ); + if ( subItem ) + { + subItem.state = subItemDefs[ subItemName ]; + menu.add( subItem ); + } + } + + // Get the element representing the current item. + var element = this._.panel.getBlock( this.id ).element.getDocument().getById( this.id + String( index ) ); + + // Show the submenu. + menu.show( element, 2 ); + } + }, + + proto : + { + add : function( item ) + { + // Later we may sort the items, but Array#sort is not stable in + // some browsers, here we're forcing the original sequence with + // 'order' attribute if it hasn't been assigned. (#3868) + if ( !item.order ) + item.order = this.items.length; + + this.items.push( item ); + }, + + removeAll : function() + { + this.items = []; + }, + + 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, + element = this._.element; + + // Create the floating panel for this menu. + if ( !panel ) + { + panel = this._.panel = new CKEDITOR.ui.floatPanel( this.editor, + CKEDITOR.document.getBody(), + this._.panelDefinition, + this._.level ); + + panel.onEscape = CKEDITOR.tools.bind( function( keystroke ) + { + if ( this._.onEscape( keystroke ) === false ) + return false; + }, + this ); + + panel.onHide = CKEDITOR.tools.bind( function() + { + this._.onHide && this._.onHide(); + }, + this ); + + // Create an autosize block inside the panel. + var block = panel.addBlock( this.id, this._.panelDefinition.block ); + block.autoSize = true; + + var keys = block.keys; + keys[ 40 ] = 'next'; // ARROW-DOWN + keys[ 9 ] = 'next'; // TAB + keys[ 38 ] = 'prev'; // ARROW-UP + keys[ CKEDITOR.SHIFT + 9 ] = 'prev'; // SHIFT + TAB + 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 ); + + var elementDoc = element.getDocument(); + elementDoc.getBody().setStyle( 'overflow', 'hidden' ); + elementDoc.getElementsByTag( 'html' ).getItem( 0 ).setStyle( 'overflow', 'hidden' ); + + this._.itemOverFn = CKEDITOR.tools.addFunction( function( index ) + { + clearTimeout( this._.showSubTimeout ); + this._.showSubTimeout = CKEDITOR.tools.setTimeout( this._.showSubMenu, editor.config.menu_subMenuDelay || 400, this, [ index ] ); + }, + this ); + + this._.itemOutFn = CKEDITOR.tools.addFunction( function( index ) + { + clearTimeout( this._.showSubTimeout ); + }, + this ); + + this._.itemClickFn = CKEDITOR.tools.addFunction( function( index ) + { + var item = this.items[ index ]; + + if ( item.state == CKEDITOR.TRISTATE_DISABLED ) + { + this.hide(); + return; + } + + if ( item.getItems ) + this._.showSubMenu( index ); + else + this._.onClick( item ); + }, + 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 = [ '' ); + + // 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 ); + else + panel.showBlock( this.id, offsetParent, corner, offsetX, offsetY ); + + editor.fire( 'menuShow', [ panel ] ); + }, + + addListener : function( listenerFn ) + { + this._.listeners.push( listenerFn ); + }, + + hide : function( returnFocus ) + { + this._.onHide && this._.onHide(); + this._.panel && this._.panel.hide( returnFocus ); + } + } + }); + + function sortItems( items ) + { + items.sort( function( itemA, itemB ) + { + if ( itemA.group < itemB.group ) + return -1; + else if ( itemA.group > itemB.group ) + return 1; + + return itemA.order < itemB.order ? -1 : + itemA.order > itemB.order ? 1 : + 0; + }); + } + CKEDITOR.menuItem = CKEDITOR.tools.createClass( + { + $ : 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 ]; + + this.editor = editor; + this.name = name; + }, + + proto : + { + 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 htmlLabel = this.label; + + if ( this.className ) + classes += ' ' + this.className; + + var hasSubMenu = this.getItems; + + output.push( + '' + + '' + + '' + + '' ); + + if ( hasSubMenu ) + { + output.push( + '', + '&#', + ( this.editor.lang.dir == 'rtl' ? + '9668' : // BLACK LEFT-POINTING POINTER + '9658' ), // BLACK RIGHT-POINTING POINTER + ';', + '' ); + } + + output.push( + htmlLabel, + '' + + '' + + '' ); + } + } + }); + +})(); + + +/** + * 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 + * @example + * // Remove the submenu delay. + * config.menu_subMenuDelay = 0; + */ + +/** + * A comma separated list of items group names to be displayed in the context + * 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 + * config.menu_groups = 'clipboard,table,anchor,link,image'; + */ +CKEDITOR.config.menu_groups = + 'clipboard,' + + 'form,' + + 'tablecell,tablecellproperties,tablerow,tablecolumn,table,'+ + 'anchor,link,image,flash,' + + 'checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea,div';