CKEDITOR.plugins

Properties

• inherited

  basePath : StringCKEDITOR.plugins#basePath

  See source

  The base directory containing all resources.

• inherited

  externals : ObjectCKEDITOR.plugins#externals

  See source

  Contains references to all resources that have already been registered with addExternal.

  Defaults to {}

• inherited

  fileName : StringCKEDITOR.plugins#fileName

  See source

  The name used for resource files.

• inherited

  loaded : ObjectCKEDITOR.plugins#loaded

  See source

  Contains references to all resources that have already been loaded with load.

  Defaults to {}

• since 4.12.0

  pagebreak : ObjectCKEDITOR.plugins#pagebreak

  See source

  The namespace containing a set of Page Break plugin helpers.

• inherited

  registered : ObjectCKEDITOR.plugins#registered

  See source

  Contains references to all resources that have already been registered with add.

  Defaults to {}

• since 4.6.1

  widgetselection : ObjectCKEDITOR.plugins#widgetselection

  See source

  A set of helper methods for the Widget Selection plugin.

• private inherited

  _ : ObjectCKEDITOR.plugins#_

  See source

  Defaults to {waitingList: {}}

• since 4.6.0 deprecated 4.13.0 private

  pastefromword : ObjectCKEDITOR.plugins#pastefromword

  See source

  Set of Paste from Word plugin helpers.

  See CKEDITOR.plugins.pastetools.filters.word.

Methods

• constructor( basePath, fileName ) → resourceManagerCKEDITOR.plugins#constructor

  See source

  Creates a resourceManager class instance.

  Parameters

  basePath : String

  The path for the resources folder.

  fileName : String

  The name used for resource files.

  Returns

  resourceManager

  inherited

  add( name, [ definition ] )CKEDITOR.plugins#add

  See source

  Registers a resource.

  CKEDITOR.plugins.add( 'sample', { ... plugin definition ... } );
  

  Parameters

  name : String

  The resource name.

  [ definition ] : Object

  The resource definition. CKEDITOR.pluginDefinition

  inherited

  addExternal( names, path, [ fileName ] )CKEDITOR.plugins#addExternal

  See source

  Registers one or more resources to be loaded from an external path instead of the core base path.

  // Loads a plugin from '/myplugins/sample/plugin.js'.
  CKEDITOR.plugins.addExternal( 'sample', '/myplugins/sample/' );
  
  // Loads a plugin from '/myplugins/sample/my_plugin.js'.
  CKEDITOR.plugins.addExternal( 'sample', '/myplugins/sample/', 'my_plugin.js' );
  
  // Loads a plugin from '/myplugins/sample/my_plugin.js'.
  CKEDITOR.plugins.addExternal( 'sample', '/myplugins/sample/my_plugin.js', '' );
  
  // Loads a plugin from '/myplugins/sample/my_plugin.js'.
  CKEDITOR.plugins.addExternal( 'sample', '/myplugins/sample/my_plugin.js' );
  

  Parameters

  names : String

  Comma-separated resource names.

  path : String

  The path of the folder containing the resource.

  [ fileName ] : String

  The resource file name. If not provided and the path argument ends with a slash (/), the default plugin.js filename is used. Otherwise, if not provided and the path argument does not end with a slash (/) or if an empty string is provided, the function assumes that the path argument contains the full path.

  inherited

  get( name ) → ObjectCKEDITOR.plugins#get

  See source

  Gets the definition of a specific resource.

  var definition = CKEDITOR.plugins.get( 'sample' );
  

  Parameters

  name : String

  The resource name.

  Returns

  Object

  The registered object.

  inherited

  getFilePath( name ) → StringCKEDITOR.plugins#getFilePath

  See source

  Get the file path for a specific loaded resource.

  alert( CKEDITOR.plugins.getFilePath( 'sample' ) ); // '<editor path>/plugins/sample/plugin.js'
  

  Parameters

  name : String

  The resource name.

  Returns

  String

  inherited

  getPath( name ) → StringCKEDITOR.plugins#getPath

  See source

  Get the folder path for a specific loaded resource.

  alert( CKEDITOR.plugins.getPath( 'sample' ) ); // '<editor path>/plugins/sample/'
  

  Parameters

  name : String

  The resource name.

  Returns

  String

  inherited

  load( name, callback, [ scope ] )CKEDITOR.plugins#load

  See source

  Loads one or more resources.

  CKEDITOR.plugins.load( 'myplugin', function( plugins ) {
      alert( plugins[ 'myplugin' ] ); // object
  } );
  

  Parameters

  name : String | Array

  The name of the resource to load. It may be a string with a single resource name, or an array with several names.

  callback : Function

  A function to be called when all resources are loaded. The callback will receive an array containing all loaded names.

  [ scope ] : Object

  The scope object to be used for the callback call.

  setLang( pluginName, languageCode, languageEntries )CKEDITOR.plugins#setLang

  See source

  Loads a specific language file, or auto detect it. A callback is then called when the file gets loaded.

  CKEDITOR.plugins.setLang( 'myPlugin', 'en', {
      title: 'My plugin',
      selectOption: 'Please select an option'
  } );
  

  Parameters

  pluginName : String

  The name of the plugin to which the provided translation should be attached.

  languageCode : String

  The code of the language translation provided.

  languageEntries : Object

  An object that contains pairs of label and the respective translation.