_source/plugins/menu/plugin.js

   1 /*\r
   2 Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.\r
   3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
   4 */\r
   5 \r
   6 CKEDITOR.plugins.add( 'menu',\r
   7 {\r
   8         beforeInit : function( editor )\r
   9         {\r
  10                 var groups = editor.config.menu_groups.split( ',' ),\r
  11                         groupsOrder = editor._.menuGroups = {},\r
  12                         menuItems = editor._.menuItems = {};\r
  13 \r
  14                 for ( var i = 0 ; i < groups.length ; i++ )\r
  15                         groupsOrder[ groups[ i ] ] = i + 1;\r
  16 \r
  17                 /**\r
  18                  * Registers an item group to the editor context menu in order to make it\r
  19                  * possible to associate it with menu items later.\r
  20                  * @name CKEDITOR.editor.prototype.addMenuGroup\r
  21                  * @param {String} name Specify a group name.\r
  22                  * @param {Number} [order=100] Define the display sequence of this group\r
  23                  *      inside the menu. A smaller value gets displayed first.\r
  24                  */\r
  25                 editor.addMenuGroup = function( name, order )\r
  26                         {\r
  27                                 groupsOrder[ name ] = order || 100;\r
  28                         };\r
  29 \r
  30                 /**\r
  31                  * Adds an item from the specified definition to the editor context menu.\r
  32                  * @name CKEDITOR.editor.prototype.addMenuItem\r
  33                  * @param {String} name The menu item name.\r
  34                  * @param {CKEDITOR.menu.definition} definition The menu item definition.\r
  35                  */\r
  36                 editor.addMenuItem = function( name, definition )\r
  37                         {\r
  38                                 if ( groupsOrder[ definition.group ] )\r
  39                                         menuItems[ name ] = new CKEDITOR.menuItem( this, name, definition );\r
  40                         };\r
  41 \r
  42                 /**\r
  43                  * Adds one or more items from the specified definition array to the editor context menu.\r
  44                  * @name CKEDITOR.editor.prototype.addMenuItems\r
  45                  * @param {Array} definitions List of definitions for each menu item as if {@link CKEDITOR.editor.addMenuItem} is called.\r
  46                  */\r
  47                 editor.addMenuItems = function( definitions )\r
  48                         {\r
  49                                 for ( var itemName in definitions )\r
  50                                 {\r
  51                                         this.addMenuItem( itemName, definitions[ itemName ] );\r
  52                                 }\r
  53                         };\r
  54 \r
  55                 /**\r
  56                  * Retrieves a particular menu item definition from the editor context menu.\r
  57                  * @name CKEDITOR.editor.prototype.getMenuItem\r
  58                  * @param {String} name The name of the desired menu item.\r
  59                  * @return {CKEDITOR.menu.definition}\r
  60                  */\r
  61                 editor.getMenuItem = function( name )\r
  62                         {\r
  63                                 return menuItems[ name ];\r
  64                         };\r
  65 \r
  66                 /**\r
  67                  * Removes a particular menu item added before from the editor context menu.\r
  68                  * @name CKEDITOR.editor.prototype.removeMenuItem\r
  69                  * @param {String} name The name of the desired menu item.\r
  70                  * @since 3.6.1\r
  71                  */\r
  72                 editor.removeMenuItem = function( name )\r
  73                         {\r
  74                                 delete menuItems[ name ];\r
  75                         };\r
  76         },\r
  77 \r
  78         requires : [ 'floatpanel' ]\r
  79 });\r
  80 \r
  81 (function()\r
  82 {\r
  83         CKEDITOR.menu = CKEDITOR.tools.createClass(\r
  84         {\r
  85                 $ : function( editor, definition )\r
  86                 {\r
  87                         definition = this._.definition = definition || {};\r
  88                         this.id = CKEDITOR.tools.getNextId();\r
  89 \r
  90                         this.editor = editor;\r
  91                         this.items = [];\r
  92                         this._.listeners = [];\r
  93 \r
  94                         this._.level = definition.level || 1;\r
  95 \r
  96                         var panelDefinition = CKEDITOR.tools.extend( {}, definition.panel,\r
  97                         {\r
  98                                 css : editor.skin.editor.css,\r
  99                                 level : this._.level - 1,\r
 100                                 block : {}\r
 101                         } );\r
 102 \r
 103                         var attrs = panelDefinition.block.attributes = ( panelDefinition.attributes || {} );\r
 104                         // Provide default role of 'menu'.\r
 105                         !attrs.role && ( attrs.role = 'menu' );\r
 106                         this._.panelDefinition = panelDefinition;\r
 107                 },\r
 108 \r
 109                 _ :\r
 110                 {\r
 111                         onShow : function()\r
 112                         {\r
 113                                 var selection = this.editor.getSelection();\r
 114 \r
 115                                 // Selection will be unavailable after menu shows up\r
 116                                 // in IE, lock it now.\r
 117                                 if ( CKEDITOR.env.ie )\r
 118                                         selection && selection.lock();\r
 119 \r
 120                                 var element = selection && selection.getStartElement(),\r
 121                                         listeners = this._.listeners,\r
 122                                         includedItems = [];\r
 123 \r
 124                                 this.removeAll();\r
 125                                 // Call all listeners, filling the list of items to be displayed.\r
 126                                 for ( var i = 0 ; i < listeners.length ; i++ )\r
 127                                 {\r
 128                                         var listenerItems = listeners[ i ]( element, selection );\r
 129 \r
 130                                         if ( listenerItems )\r
 131                                         {\r
 132                                                 for ( var itemName in listenerItems )\r
 133                                                 {\r
 134                                                         var item = this.editor.getMenuItem( itemName );\r
 135 \r
 136                                                         if ( item && ( !item.command || this.editor.getCommand( item.command ).state ) )\r
 137                                                         {\r
 138                                                                 item.state = listenerItems[ itemName ];\r
 139                                                                 this.add( item );\r
 140                                                         }\r
 141                                                 }\r
 142                                         }\r
 143                                 }\r
 144                         },\r
 145 \r
 146                         onClick : function( item )\r
 147                         {\r
 148                                 this.hide( false );\r
 149 \r
 150                                 if ( item.onClick )\r
 151                                         item.onClick();\r
 152                                 else if ( item.command )\r
 153                                         this.editor.execCommand( item.command );\r
 154                         },\r
 155 \r
 156                         onEscape : function( keystroke )\r
 157                         {\r
 158                                 var parent = this.parent;\r
 159                                 // 1. If it's sub-menu, restore the last focused item\r
 160                                 // of upper level menu.\r
 161                                 // 2. In case of a top-menu, close it.\r
 162                                 if ( parent )\r
 163                                 {\r
 164                                         parent._.panel.hideChild();\r
 165                                         // Restore parent block item focus.\r
 166                                         var parentBlock = parent._.panel._.panel._.currentBlock,\r
 167                                                 parentFocusIndex =  parentBlock._.focusIndex;\r
 168                                         parentBlock._.markItem( parentFocusIndex );\r
 169                                 }\r
 170                                 else if ( keystroke == 27 )\r
 171                                         this.hide();\r
 172 \r
 173                                 return false;\r
 174                         },\r
 175 \r
 176                         onHide : function()\r
 177                         {\r
 178                                 // Unlock the selection upon first panel closing.\r
 179                                 if ( CKEDITOR.env.ie && !this.parent )\r
 180                                 {\r
 181                                         var selection = this.editor.getSelection();\r
 182                                         selection && selection.unlock( true );\r
 183                                 }\r
 184 \r
 185                                 this.onHide && this.onHide();\r
 186                         },\r
 187 \r
 188                         showSubMenu : function( index )\r
 189                         {\r
 190                                 var menu = this._.subMenu,\r
 191                                         item = this.items[ index ],\r
 192                                         subItemDefs = item.getItems && item.getItems();\r
 193 \r
 194                                 // If this item has no subitems, we just hide the submenu, if\r
 195                                 // available, and return back.\r
 196                                 if ( !subItemDefs )\r
 197                                 {\r
 198                                         this._.panel.hideChild();\r
 199                                         return;\r
 200                                 }\r
 201 \r
 202                                 // Record parent menu focused item first (#3389).\r
 203                                 var block = this._.panel.getBlock( this.id );\r
 204                                 block._.focusIndex = index;\r
 205 \r
 206                                 // Create the submenu, if not available, or clean the existing\r
 207                                 // one.\r
 208                                 if ( menu )\r
 209                                         menu.removeAll();\r
 210                                 else\r
 211                                 {\r
 212                                         menu = this._.subMenu = new CKEDITOR.menu( this.editor,\r
 213                                                                    CKEDITOR.tools.extend( {}, this._.definition, { level : this._.level + 1 }, true ) );\r
 214                                         menu.parent = this;\r
 215                                         menu._.onClick = CKEDITOR.tools.bind( this._.onClick, this );\r
 216                                 }\r
 217 \r
 218                                 // Add all submenu items to the menu.\r
 219                                 for ( var subItemName in subItemDefs )\r
 220                                 {\r
 221                                         var subItem = this.editor.getMenuItem( subItemName );\r
 222                                         if ( subItem )\r
 223                                         {\r
 224                                                 subItem.state = subItemDefs[ subItemName ];\r
 225                                                 menu.add( subItem );\r
 226                                         }\r
 227                                 }\r
 228 \r
 229                                 // Get the element representing the current item.\r
 230                                 var element = this._.panel.getBlock( this.id ).element.getDocument().getById( this.id + String( index ) );\r
 231 \r
 232                                 // Show the submenu.\r
 233                                 menu.show( element, 2 );\r
 234                         }\r
 235                 },\r
 236 \r
 237                 proto :\r
 238                 {\r
 239                         add : function( item )\r
 240                         {\r
 241                                 // Later we may sort the items, but Array#sort is not stable in\r
 242                                 // some browsers, here we're forcing the original sequence with\r
 243                                 // 'order' attribute if it hasn't been assigned. (#3868)\r
 244                                 if ( !item.order )\r
 245                                         item.order = this.items.length;\r
 246 \r
 247                                 this.items.push( item );\r
 248                         },\r
 249 \r
 250                         removeAll : function()\r
 251                         {\r
 252                                 this.items = [];\r
 253                         },\r
 254 \r
 255                         show : function( offsetParent, corner, offsetX, offsetY )\r
 256                         {\r
 257                                 // Not for sub menu.\r
 258                                 if ( !this.parent )\r
 259                                 {\r
 260                                         this._.onShow();\r
 261                                         // Don't menu with zero items.\r
 262                                         if ( ! this.items.length )\r
 263                                                 return;\r
 264                                 }\r
 265 \r
 266                                 corner = corner || ( this.editor.lang.dir == 'rtl' ? 2 : 1 );\r
 267 \r
 268                                 var items = this.items,\r
 269                                         editor = this.editor,\r
 270                                         panel = this._.panel,\r
 271                                         element = this._.element;\r
 272 \r
 273                                 // Create the floating panel for this menu.\r
 274                                 if ( !panel )\r
 275                                 {\r
 276                                         panel = this._.panel = new CKEDITOR.ui.floatPanel( this.editor,\r
 277                                                 CKEDITOR.document.getBody(),\r
 278                                                 this._.panelDefinition,\r
 279                                                 this._.level );\r
 280 \r
 281                                         panel.onEscape = CKEDITOR.tools.bind( function( keystroke )\r
 282                                         {\r
 283                                                 if ( this._.onEscape( keystroke ) === false )\r
 284                                                         return false;\r
 285                                         },\r
 286                                         this );\r
 287 \r
 288                                         panel.onHide = CKEDITOR.tools.bind( function()\r
 289                                         {\r
 290                                                 this._.onHide && this._.onHide();\r
 291                                         },\r
 292                                         this );\r
 293 \r
 294                                         // Create an autosize block inside the panel.\r
 295                                         var block = panel.addBlock( this.id, this._.panelDefinition.block );\r
 296                                         block.autoSize = true;\r
 297 \r
 298                                         var keys = block.keys;\r
 299                                         keys[ 40 ]      = 'next';                                       // ARROW-DOWN\r
 300                                         keys[ 9 ]       = 'next';                                       // TAB\r
 301                                         keys[ 38 ]      = 'prev';                                       // ARROW-UP\r
 302                                         keys[ CKEDITOR.SHIFT + 9 ]      = 'prev';       // SHIFT + TAB\r
 303                                         keys[ ( editor.lang.dir == 'rtl' ? 37 : 39 ) ]= CKEDITOR.env.ie ? 'mouseup' : 'click';  // ARROW-RIGHT/ARROW-LEFT(rtl)\r
 304                                         keys[ 32 ]      = CKEDITOR.env.ie ? 'mouseup' : 'click';                                        // SPACE\r
 305                                         CKEDITOR.env.ie && ( keys[ 13 ] = 'mouseup' );          // Manage ENTER, since onclick is blocked in IE (#8041).\r
 306 \r
 307                                         element = this._.element = block.element;\r
 308                                         element.addClass( editor.skinClass );\r
 309 \r
 310                                         var elementDoc = element.getDocument();\r
 311                                         elementDoc.getBody().setStyle( 'overflow', 'hidden' );\r
 312                                         elementDoc.getElementsByTag( 'html' ).getItem( 0 ).setStyle( 'overflow', 'hidden' );\r
 313 \r
 314                                         this._.itemOverFn = CKEDITOR.tools.addFunction( function( index )\r
 315                                                 {\r
 316                                                         clearTimeout( this._.showSubTimeout );\r
 317                                                         this._.showSubTimeout = CKEDITOR.tools.setTimeout( this._.showSubMenu, editor.config.menu_subMenuDelay || 400, this, [ index ] );\r
 318                                                 },\r
 319                                                 this );\r
 320 \r
 321                                         this._.itemOutFn = CKEDITOR.tools.addFunction( function( index )\r
 322                                                 {\r
 323                                                         clearTimeout( this._.showSubTimeout );\r
 324                                                 },\r
 325                                                 this );\r
 326 \r
 327                                         this._.itemClickFn = CKEDITOR.tools.addFunction( function( index )\r
 328                                                 {\r
 329                                                         var item = this.items[ index ];\r
 330 \r
 331                                                         if ( item.state == CKEDITOR.TRISTATE_DISABLED )\r
 332                                                         {\r
 333                                                                 this.hide();\r
 334                                                                 return;\r
 335                                                         }\r
 336 \r
 337                                                         if ( item.getItems )\r
 338                                                                 this._.showSubMenu( index );\r
 339                                                         else\r
 340                                                                 this._.onClick( item );\r
 341                                                 },\r
 342                                                 this );\r
 343                                 }\r
 344 \r
 345                                 // Put the items in the right order.\r
 346                                 sortItems( items );\r
 347 \r
 348                                 var chromeRoot = editor.container.getChild( 1 ),\r
 349                                         mixedContentClass = chromeRoot.hasClass( 'cke_mixed_dir_content' ) ? ' cke_mixed_dir_content' : '';\r
 350 \r
 351                                 // Build the HTML that composes the menu and its items.\r
 352                                 var output = [ '<div class="cke_menu' + mixedContentClass + '" role="presentation">' ];\r
 353 \r
 354                                 var length = items.length,\r
 355                                         lastGroup = length && items[ 0 ].group;\r
 356 \r
 357                                 for ( var i = 0 ; i < length ; i++ )\r
 358                                 {\r
 359                                         var item = items[ i ];\r
 360                                         if ( lastGroup != item.group )\r
 361                                         {\r
 362                                                 output.push( '<div class="cke_menuseparator" role="separator"></div>' );\r
 363                                                 lastGroup = item.group;\r
 364                                         }\r
 365 \r
 366                                         item.render( this, i, output );\r
 367                                 }\r
 368 \r
 369                                 output.push( '</div>' );\r
 370 \r
 371                                 // Inject the HTML inside the panel.\r
 372                                 element.setHtml( output.join( '' ) );\r
 373 \r
 374                                 CKEDITOR.ui.fire( 'ready', this );\r
 375 \r
 376                                 // Show the panel.\r
 377                                 if ( this.parent )\r
 378                                         this.parent._.panel.showAsChild( panel, this.id, offsetParent, corner, offsetX, offsetY );\r
 379                                 else\r
 380                                         panel.showBlock( this.id, offsetParent, corner, offsetX, offsetY );\r
 381 \r
 382                                 editor.fire( 'menuShow', [ panel ] );\r
 383                         },\r
 384 \r
 385                         addListener : function( listenerFn )\r
 386                         {\r
 387                                 this._.listeners.push( listenerFn );\r
 388                         },\r
 389 \r
 390                         hide : function( returnFocus )\r
 391                         {\r
 392                                 this._.onHide && this._.onHide();\r
 393                                 this._.panel && this._.panel.hide( returnFocus );\r
 394                         }\r
 395                 }\r
 396         });\r
 397 \r
 398         function sortItems( items )\r
 399         {\r
 400                 items.sort( function( itemA, itemB )\r
 401                         {\r
 402                                 if ( itemA.group < itemB.group )\r
 403                                         return -1;\r
 404                                 else if ( itemA.group > itemB.group )\r
 405                                         return 1;\r
 406 \r
 407                                 return itemA.order < itemB.order ? -1 :\r
 408                                         itemA.order > itemB.order ? 1 :\r
 409                                         0;\r
 410                         });\r
 411         }\r
 412         CKEDITOR.menuItem = CKEDITOR.tools.createClass(\r
 413         {\r
 414                 $ : function( editor, name, definition )\r
 415                 {\r
 416                         CKEDITOR.tools.extend( this, definition,\r
 417                                 // Defaults\r
 418                                 {\r
 419                                         order : 0,\r
 420                                         className : 'cke_button_' + name\r
 421                                 });\r
 422 \r
 423                         // Transform the group name into its order number.\r
 424                         this.group = editor._.menuGroups[ this.group ];\r
 425 \r
 426                         this.editor = editor;\r
 427                         this.name = name;\r
 428                 },\r
 429 \r
 430                 proto :\r
 431                 {\r
 432                         render : function( menu, index, output )\r
 433                         {\r
 434                                 var id = menu.id + String( index ),\r
 435                                         state = ( typeof this.state == 'undefined' ) ? CKEDITOR.TRISTATE_OFF : this.state;\r
 436 \r
 437                                 var classes = ' cke_' + (\r
 438                                         state == CKEDITOR.TRISTATE_ON ? 'on' :\r
 439                                         state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' :\r
 440                                         'off' );\r
 441 \r
 442                                 var htmlLabel = this.label;\r
 443 \r
 444                                 if ( this.className )\r
 445                                         classes += ' ' + this.className;\r
 446 \r
 447                         var hasSubMenu = this.getItems;\r
 448 \r
 449                         output.push(\r
 450                                 '<span class="cke_menuitem' + ( this.icon && this.icon.indexOf( '.png' ) == -1 ? ' cke_noalphafix' : '' ) + '">' +\r
 451                                 '<a id="', id, '"' +\r
 452                                         ' class="', classes, '" href="javascript:void(\'', ( this.label || '' ).replace( "'", '' ), '\')"' +\r
 453                                         ' title="', this.label, '"' +\r
 454                                         ' tabindex="-1"' +\r
 455                                         '_cke_focus=1' +\r
 456                                         ' hidefocus="true"' +\r
 457                                         ' role="menuitem"' +\r
 458                                         ( hasSubMenu ? 'aria-haspopup="true"' : '' ) +\r
 459                                         ( state == CKEDITOR.TRISTATE_DISABLED ? 'aria-disabled="true"' : '' ) +\r
 460                                         ( state == CKEDITOR.TRISTATE_ON ? 'aria-pressed="true"' : '' ) );\r
 461 \r
 462                                 // Some browsers don't cancel key events in the keydown but in the\r
 463                                 // keypress.\r
 464                                 // TODO: Check if really needed for Gecko+Mac.\r
 465                                 if ( CKEDITOR.env.opera || ( CKEDITOR.env.gecko && CKEDITOR.env.mac ) )\r
 466                                 {\r
 467                                         output.push(\r
 468                                                 ' onkeypress="return false;"' );\r
 469                                 }\r
 470 \r
 471                                 // With Firefox, we need to force the button to redraw, otherwise it\r
 472                                 // will remain in the focus state.\r
 473                                 if ( CKEDITOR.env.gecko )\r
 474                                 {\r
 475                                         output.push(\r
 476                                                 ' onblur="this.style.cssText = this.style.cssText;"' );\r
 477                                 }\r
 478 \r
 479                                 var offset = ( this.iconOffset || 0 ) * -16;\r
 480                                 output.push(\r
 481 //                                      ' onkeydown="return CKEDITOR.ui.button._.keydown(', index, ', event);"' +\r
 482                                         ' onmouseover="CKEDITOR.tools.callFunction(', menu._.itemOverFn, ',', index, ');"' +\r
 483                                         ' onmouseout="CKEDITOR.tools.callFunction(', menu._.itemOutFn, ',', index, ');" ' +\r
 484                                         ( CKEDITOR.env.ie ? 'onclick="return false;" onmouseup' : 'onclick' ) +         // #188\r
 485                                                 '="CKEDITOR.tools.callFunction(', menu._.itemClickFn, ',', index, '); return false;"' +\r
 486                                         '>' +\r
 487                                                 '<span class="cke_icon_wrapper"><span class="cke_icon"' +\r
 488                                                         ( this.icon ? ' style="background-image:url(' + CKEDITOR.getUrl( this.icon ) + ');background-position:0 ' + offset + 'px;"'\r
 489                                                         : '' ) +\r
 490                                                         '></span></span>' +\r
 491                                                 '<span class="cke_label">' );\r
 492 \r
 493                         if ( hasSubMenu )\r
 494                         {\r
 495                                 output.push(\r
 496                                                         '<span class="cke_menuarrow">',\r
 497                                                                 '<span>&#',\r
 498                                                                         ( this.editor.lang.dir == 'rtl' ?\r
 499                                                                                 '9668' :        // BLACK LEFT-POINTING POINTER\r
 500                                                                                 '9658' ),       // BLACK RIGHT-POINTING POINTER\r
 501                                                                 ';</span>',\r
 502                                                         '</span>' );\r
 503                         }\r
 504 \r
 505                                 output.push(\r
 506                                                                 htmlLabel,\r
 507                                                         '</span>' +\r
 508                                         '</a>' +\r
 509                                         '</span>' );\r
 510                 }\r
 511                 }\r
 512         });\r
 513 \r
 514 })();\r
 515 \r
 516 \r
 517 /**\r
 518  * The amount of time, in milliseconds, the editor waits before displaying submenu\r
 519  * options when moving the mouse over options that contain submenus, like the\r
 520  * "Cell Properties" entry for tables.\r
 521  * @type Number\r
 522  * @default 400\r
 523  * @example\r
 524  * // Remove the submenu delay.\r
 525  * config.menu_subMenuDelay = 0;\r
 526  */\r
 527 \r
 528 /**\r
 529  * A comma separated list of items group names to be displayed in the context\r
 530  * menu. The order of items will reflect the order specified in this list if\r
 531  * no priority was defined in the groups.\r
 532  * @type String\r
 533  * @default 'clipboard,form,tablecell,tablecellproperties,tablerow,tablecolumn,table,anchor,link,image,flash,checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea'\r
 534  * @example\r
 535  * config.menu_groups = 'clipboard,table,anchor,link,image';\r
 536  */\r
 537 CKEDITOR.config.menu_groups =\r
 538         'clipboard,' +\r
 539         'form,' +\r
 540         'tablecell,tablecellproperties,tablerow,tablecolumn,table,'+\r
 541         'anchor,link,image,flash,' +\r
 542         'checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea,div';\r