1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
|
/**
* @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
CKEDITOR.plugins.add( 'menu', {
requires: 'floatpanel',
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.
*
* @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.
* @member CKEDITOR.editor
*/
editor.addMenuGroup = function( name, order ) {
groupsOrder[ name ] = order || 100;
};
/**
* Adds an item from the specified definition to the editor context menu.
*
* @method
* @param {String} name The menu item name.
* @param {Object} definition The menu item definition.
* @member CKEDITOR.editor
*/
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 object to the editor context menu.
*
* @method
* @param {Object} definitions Object where keys are used as itemName and corresponding values as definition for a {@link #addMenuItem} call.
* @member CKEDITOR.editor
*/
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.
*
* @method
* @param {String} name The name of the desired menu item.
* @returns {Object}
* @member CKEDITOR.editor
*/
editor.getMenuItem = function( name ) {
return menuItems[ name ];
};
/**
* Removes a particular menu item added before from the editor context menu.
*
* @since 3.6.1
* @method
* @param {String} name The name of the desired menu item.
* @member CKEDITOR.editor
*/
editor.removeMenuItem = function( name ) {
delete menuItems[ name ];
};
}
} );
( function() {
var menuItemSource = '<span class="cke_menuitem">' +
'<a id="{id}"' +
' class="cke_menubutton cke_menubutton__{name} cke_menubutton_{state} {cls}" href="{href}"' +
' title="{title}"' +
' tabindex="-1"' +
' _cke_focus=1' +
' hidefocus="true"' +
' role="{role}"' +
' aria-label="{attrLabel}"' +
' aria-describedby="{id}_description"' +
' aria-haspopup="{hasPopup}"' +
' aria-disabled="{disabled}"' +
' {ariaChecked}' +
' draggable="false"',
specialClickHandler = '';
// Some browsers don't cancel key events in the keydown but in the
// keypress.
// TODO: Check if really needed.
if ( CKEDITOR.env.gecko && CKEDITOR.env.mac )
menuItemSource += ' onkeypress="return false;"';
// With Firefox, we need to force the button to redraw, otherwise it
// will remain in the focus state. Also we some extra help to prevent dragging (https://dev.ckeditor.com/ticket/10373).
if ( CKEDITOR.env.gecko ) {
menuItemSource += ( ' onblur="this.style.cssText = this.style.cssText;"' +
' ondragstart="return false;"' );
}
// We must block clicking with right mouse button (#2858).
if ( CKEDITOR.env.ie ) {
specialClickHandler = 'return false;" onmouseup="CKEDITOR.tools.getMouseButton(event)===CKEDITOR.MOUSE_BUTTON_LEFT&&';
}
// https://dev.ckeditor.com/ticket/188
menuItemSource += ' onmouseover="CKEDITOR.tools.callFunction({hoverFn},{index});"' +
' onmouseout="CKEDITOR.tools.callFunction({moveOutFn},{index});"' +
' onclick="' + specialClickHandler + 'CKEDITOR.tools.callFunction({clickFn},{index}); return false;"' +
'>';
menuItemSource +=
//'' +
'<span class="cke_menubutton_inner">' +
'<span class="cke_menubutton_icon">' +
'<span class="cke_button_icon cke_button__{iconName}_icon" style="{iconStyle}"></span>' +
'</span>' +
'<span class="cke_menubutton_label">' +
'{label}' +
'</span>' +
'{shortcutHtml}' +
'{arrowHtml}' +
'</span>' +
'</a><span id="{id}_description" class="cke_voice_label" aria-hidden="false">{ariaShortcut}</span></span>';
var menuArrowSource = '<span class="cke_menuarrow">' +
'<span>{label}</span>' +
'</span>';
var menuShortcutSource = '<span class="cke_menubutton_label cke_menubutton_shortcut">' +
'{shortcut}' +
'</span>';
var menuItemTpl = CKEDITOR.addTemplate( 'menuItem', menuItemSource ),
menuArrowTpl = CKEDITOR.addTemplate( 'menuArrow', menuArrowSource ),
menuShortcutTpl = CKEDITOR.addTemplate( 'menuShortcut', menuShortcutSource );
/**
* @class
* @todo
*/
CKEDITOR.menu = CKEDITOR.tools.createClass( {
/**
* @constructor
*/
$: 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: [ CKEDITOR.skin.getPath( 'editor' ) ],
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(),
start = selection && selection.getStartElement(),
path = this.editor.elementPath(),
listeners = this._.listeners;
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 ]( start, selection, path );
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();
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, close it, with focus restored on this.
// 2. In case of a top-menu, close it, with focus returned to page.
if ( parent )
parent._.panel.hideChild( 1 );
else if ( keystroke == 27 )
this.hide( 1 );
return false;
},
onHide: function() {
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 ) {
// Hide sub menu with focus returned.
this._.panel.hideChild( 1 );
return;
}
// 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.
// This timeout is needed to give time for the sub-menu get
// focus when JAWS is running. (https://dev.ckeditor.com/ticket/9844)
setTimeout( function() {
menu.show( element, 2 );
}, 0 );
}
},
proto: {
/**
* Adds an item.
*
* @param item
*/
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. (https://dev.ckeditor.com/ticket/3868)
if ( !item.order )
item.order = this.items.length;
this.items.push( item );
},
/**
* Removes all items.
*/
removeAll: function() {
this.items = [];
},
/**
* Shows the menu in given location.
*
* @param {CKEDITOR.dom.element} offsetParent
* @param {Number} [corner]
* @param {Number} [offsetX]
* @param {Number} [offsetY]
*/
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.onShow = function() {
// Menu need CSS resets, compensate class name.
var holder = panel._.panel.getHolderElement();
holder.getParent().addClass( 'cke' ).addClass( 'cke_reset_all' );
};
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 (https://dev.ckeditor.com/ticket/8041).
element = this._.element = block.element;
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() {
clearTimeout( this._.showSubTimeout );
}, this );
this._.itemClickFn = CKEDITOR.tools.addFunction( function( index ) {
var item = this.items[ index ];
if ( item.state == CKEDITOR.TRISTATE_DISABLED ) {
this.hide( 1 );
return;
}
if ( item.getItems )
this._.showSubMenu( index );
else
this._.onClick( item );
}, this );
}
// Put the items in the right order.
sortItems( items );
// Apply the editor mixed direction status to menu.
var path = editor.elementPath(),
mixedDirCls = ( path && path.direction() != editor.lang.dir ) ? ' cke_mixed_dir_content' : '';
// Build the HTML that composes the menu and its items.
var output = [ '<div class="cke_menu' + mixedDirCls + '" role="presentation">' ];
var length = items.length,
lastGroup = length && items[ 0 ].group;
for ( var i = 0; i < length; i++ ) {
var item = items[ i ];
if ( lastGroup != item.group ) {
output.push( '<div class="cke_menuseparator" role="separator"></div>' );
lastGroup = item.group;
}
item.render( this, i, output );
}
output.push( '</div>' );
// 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 );
}
var data = [ panel ];
editor.fire( 'menuShow', data );
},
/**
* Adds a callback executed on opening the menu. Items
* returned by that callback are added to the menu.
*
* @param {Function} listenerFn
* @param {CKEDITOR.dom.element} listenerFn.startElement The selection start anchor element.
* @param {CKEDITOR.dom.selection} listenerFn.selection The current selection.
* @param {CKEDITOR.dom.elementPath} listenerFn.path The current elements path.
* @param listenerFn.return Object (`commandName` => `state`) of items that should be added to the menu.
*/
addListener: function( listenerFn ) {
this._.listeners.push( listenerFn );
},
/**
* Hides the menu.
*
* @param {Boolean} [returnFocus]
*/
hide: function( returnFocus ) {
this._.onHide && this._.onHide();
this._.panel && this._.panel.hide( returnFocus );
},
/**
* Finds the menu item corresponding to a given command.
*
* **Notice**: Keep in mind that the menu is re-rendered on each opening, so caching items (especially DOM elements)
* may not work. Also executing this method when the menu is not visible may give unexpected results as the
* items may not be rendered.
*
* @since 4.9.0
* @param {String} commandName
* @returns {Object/null} return An object containing a given item. If the item was not found, `null` is returned.
* @returns {CKEDITOR.menuItem} return.item The item definition.
* @returns {CKEDITOR.dom.element} return.element The rendered element representing the item in the menu.
*/
findItemByCommandName: function( commandName ) {
var commands = CKEDITOR.tools.array.filter( this.items, function( item ) {
return commandName === item.command;
} );
if ( commands.length ) {
var commandItem = commands[ 0 ];
return {
item: commandItem,
element: this._.element.findOne( '.' + commandItem.className )
};
}
return null;
}
}
} );
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;
} );
}
/**
* @class
* @todo
*/
CKEDITOR.menuItem = CKEDITOR.tools.createClass( {
$: function( editor, name, definition ) {
CKEDITOR.tools.extend( this, definition,
// Defaults
{
order: 0,
className: 'cke_menubutton__' + 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,
ariaChecked = '',
editor = this.editor,
keystroke,
command,
shortcut;
var stateName = state == CKEDITOR.TRISTATE_ON ? 'on' : state == CKEDITOR.TRISTATE_DISABLED ? 'disabled' : 'off';
if ( this.role in { menuitemcheckbox: 1, menuitemradio: 1 } )
ariaChecked = ' aria-checked="' + ( state == CKEDITOR.TRISTATE_ON ? 'true' : 'false' ) + '"';
var hasSubMenu = this.getItems;
// ltr: BLACK LEFT-POINTING POINTER
// rtl: BLACK RIGHT-POINTING POINTER
var arrowLabel = '&#' + ( this.editor.lang.dir == 'rtl' ? '9668' : '9658' ) + ';';
var iconName = this.name;
if ( this.icon && !( /\./ ).test( this.icon ) )
iconName = this.icon;
if ( this.command ) {
command = editor.getCommand( this.command );
keystroke = editor.getCommandKeystroke( command );
if ( keystroke ) {
shortcut = CKEDITOR.tools.keystrokeToString( editor.lang.common.keyboard, keystroke );
}
}
// We must escape label for use inside attributes to not close them
// too early by using double quotes inside label (#3413).
var attrLabel = CKEDITOR.tools.htmlEncodeAttr( this.label ),
params = {
id: id,
name: this.name,
iconName: iconName,
label: this.label,
attrLabel: attrLabel,
cls: this.className || '',
state: stateName,
hasPopup: hasSubMenu ? 'true' : 'false',
disabled: state == CKEDITOR.TRISTATE_DISABLED,
title: attrLabel + ( shortcut ? ' (' + shortcut.display + ')' : '' ),
ariaShortcut: shortcut ? editor.lang.common.keyboardShortcut + ' ' + shortcut.aria : '',
href: 'javascript:void(\'' + ( attrLabel || '' ).replace( "'" + '' ) + '\')', // jshint ignore:line
hoverFn: menu._.itemOverFn,
moveOutFn: menu._.itemOutFn,
clickFn: menu._.itemClickFn,
index: index,
iconStyle: CKEDITOR.skin.getIconStyle( iconName, ( this.editor.lang.dir == 'rtl' ), iconName == this.icon ? null : this.icon, this.iconOffset ),
shortcutHtml: shortcut ? menuShortcutTpl.output( { shortcut: shortcut.display } ) : '',
arrowHtml: hasSubMenu ? menuArrowTpl.output( { label: arrowLabel } ) : '',
role: this.role ? this.role : 'menuitem',
ariaChecked: ariaChecked
};
menuItemTpl.output( params, output );
}
}
} );
} )();
/**
* 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.
*
* // Remove the submenu delay.
* config.menu_subMenuDelay = 0;
*
* @cfg {Number} [menu_subMenuDelay=400]
* @member CKEDITOR.config
*/
/**
* Fired when a menu is shown.
*
* @event menuShow
* @member CKEDITOR.editor
* @param {CKEDITOR.editor} editor This editor instance.
* @param {CKEDITOR.ui.panel[]} data
*/
/**
* 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.
*
* config.menu_groups = 'clipboard,table,anchor,link,image';
*
* @cfg {String} [menu_groups=see source]
* @member CKEDITOR.config
*/
CKEDITOR.config.menu_groups = 'clipboard,' +
'form,' +
'tablecell,tablecellproperties,tablerow,tablecolumn,table,' +
'anchor,link,image,flash,' +
'checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea,div';
|