CKEDITOR.plugins.balloontoolbar.contextManager

Properties

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

  See source

  The editor that the manager was created for.

• private

  _contexts : context[]CKEDITOR.plugins.balloontoolbar.contextManager#_contexts

  See source

  A list of contexts controlled by this manager.

  Defaults to []

• private

  _listeners : Object[]CKEDITOR.plugins.balloontoolbar.contextManager#_listeners

  See source

  An array of event listener references created by the manager.An array of objects returned by the CKEDITOR.event.on method.

  Defaults to []

Methods

• since 4.8.0

  constructor( editor ) → contextManagerCKEDITOR.plugins.balloontoolbar.contextManager#constructor

  See source

  Parameters

  editor : editor

  The editor instance which the toolbar is created for.

  Returns

  contextManager

  add( context )CKEDITOR.plugins.balloontoolbar.contextManager#add

  See source

  Adds a context to the tracked contexts list.

  Parameters

  context : context

  check( [ selection ] )CKEDITOR.plugins.balloontoolbar.contextManager#check

  See source

  Checks each registered context against selection to find the best match. By default only one toolbar per manager will be shown.

  Parameters

  [ selection ] : selection | null

  The selection to be used for probing the toolbar. If none provided, a shrunk selection of the current editor will be used.

  Defaults to null

  create( options ) → contextCKEDITOR.plugins.balloontoolbar.contextManager#create

  See source

  Creates a toolbar context based on provided options, registers it in the manager and returns.

  // Shows Bold and Underline button for any selection.
  var context = contextManager.create( {
      buttons: 'Bold,Underline',
      refresh: function() {
          return true;
      }
  } );
  

  Parameters

  options : contextDefinition

  A configuration object that determines the conditions used to display the toolbar.

  Returns

  context

  A context object created for this balloon toolbar configuration.

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

  See source

  Destroys every context controlled by the manager and clears the context list.

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

  See source

  Hides every visible context controlled by the manager.

  private

  _attachListeners()CKEDITOR.plugins.balloontoolbar.contextManager#_attachListeners

  See source

  Adds a set of listeners integrating the manager with the editor, like the CKEDITOR.editor.selectionChange listener.

  private

  _clear()CKEDITOR.plugins.balloontoolbar.contextManager#_clear

  See source

  Destroys any context in _contexts and empties the managed contexts list.

  private

  _refresh()CKEDITOR.plugins.balloontoolbar.contextManager#_refresh

  See source

  Refreshes all contexts from _contexts.