CKEDITOR.plugins.balloontoolbar.context

Properties

• editor : editorCKEDITOR.plugins.balloontoolbar.context#editor

  See source

  An editor instance.

• options : contextDefinitionCKEDITOR.plugins.balloontoolbar.context#options

  See source

  Options passed to the constructor.

• toolbar : balloonToolbarCKEDITOR.plugins.balloontoolbar.context#toolbar

  See source

  Toolbar instance pointed by context.

Methods

• since 4.8.0

  constructor( editor, options ) → contextCKEDITOR.plugins.balloontoolbar.context#constructor

  See source

  Creates a balloon toolbar context instance.

  Parameters

  editor : editor

  The editor instance for which the toolbar is created.

  options : contextDefinition

  A set of options defining the context behavior.

  Returns

  context

  destroy()CKEDITOR.plugins.balloontoolbar.context#destroy

  See source

  Destroys the toolbar maintained by this context.

  hide()CKEDITOR.plugins.balloontoolbar.context#hide

  See source

  Hides the toolbar controlled by this context.

  refresh()CKEDITOR.plugins.balloontoolbar.context#refresh

  See source

  Refreshes the toolbar state attached to this context.

  show( [ pointedElement ] )CKEDITOR.plugins.balloontoolbar.context#show

  See source

  Shows the toolbar controlled by this context.

  Parameters

  [ pointedElement ] : element

  An element that should be pointed by the balloon toolbar.

  private

  _loadButtons()CKEDITOR.plugins.balloontoolbar.context#_loadButtons

  See source

  Loads a button from options.buttons.

  private

  _matchElement( elem ) → element | nullCKEDITOR.plugins.balloontoolbar.context#_matchElement

  See source

  Checks if a given element matches the options.cssSelector selector.

  Parameters

  elem : element

  An element to be tested.

  Returns

  element | null

  CKEDITOR.dom.element instance if an element was matched, null otherwise.

  private

  _matchRefresh( path, selection ) → element | nullCKEDITOR.plugins.balloontoolbar.context#_matchRefresh

  See source

  Performs matching against options.refresh.

  Parameters

  path : elementPath

  The element path to be checked.

  selection : selection

  The selection object to be passed to the refresh function.

  Returns

  element | null

  Returns a CKEDITOR.dom.element if matched by options.refresh, null otherwise.

  private

  _matchWidget() → element | nullCKEDITOR.plugins.balloontoolbar.context#_matchWidget

  See source

  Checks if any of the options.widgets widgets is currently focused.

  Returns

  element | null

  Returns a CKEDITOR.dom.element instance that the toolbar should point to if any matched widget is focused. Returns false otherwise, which means that no tracked widget was matched.