CKEDITOR.plugins.contextMenu

Methods

• inherited

  constructor() → menuCKEDITOR.plugins.contextMenu#constructor

  See source

  Returns

  menu

• inherited

  add( item )CKEDITOR.plugins.contextMenu#add

  See source

  Adds an item.

  Parameters

  item : Object

• inherited

  addListener( listenerFn )CKEDITOR.plugins.contextMenu#addListener

  See source

  Adds a callback executed on opening the menu. Items returned by that callback are added to the menu.

  Parameters

  listenerFn : Function

• addTarget( element, [ nativeContextMenuOnCtrl ] )CKEDITOR.plugins.contextMenu#addTarget

  See source

  Starts watching on native context menu triggers (Option key, right click) on the given element.

  Parameters

  element : element

  [ nativeContextMenuOnCtrl ] : Boolean

  Whether to open native context menu if the Ctrl key is held on opening the context menu. See CKEDITOR.config.browserContextMenuOnCtrl.

• since 4.9.0 inherited

  findItemByCommandName( commandName ) → Object | nullCKEDITOR.plugins.contextMenu#findItemByCommandName

  See source

  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.

  Parameters

  commandName : String

  Returns

  Object | null

  return An object containing a given item. If the item was not found, null is returned.

  Properties

  item : menuItem

  The item definition.

  element : element

  The rendered element representing the item in the menu.

• inherited

  hide( [ returnFocus ] )CKEDITOR.plugins.contextMenu#hide

  See source

  Hides the menu.

  Parameters

  [ returnFocus ] : Boolean

• open( offsetParent, [ corner ], [ offsetX ], [ offsetY ] )CKEDITOR.plugins.contextMenu#open

  See source

  Opens the context menu in the given location. See the CKEDITOR.menu.show method.

  Parameters

  offsetParent : element

  [ corner ] : Number

  [ offsetX ] : Number

  [ offsetY ] : Number

• inherited

  removeAll()CKEDITOR.plugins.contextMenu#removeAll

  See source

  Removes all items.

• inherited

  show( offsetParent, [ corner ], [ offsetX ], [ offsetY ] )CKEDITOR.plugins.contextMenu#show

  See source

  Shows the menu in given location.

  Parameters

  offsetParent : element

  [ corner ] : Number

  [ offsetX ] : Number

  [ offsetY ] : Number