CKEDITOR.resourceManager

Properties

• basePath : StringCKEDITOR.resourceManager#basePath

  See source

  The base directory containing all resources.

• externals : ObjectCKEDITOR.resourceManager#externals

  See source

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

  Defaults to {}

• fileName : StringCKEDITOR.resourceManager#fileName

  See source

  The name used for resource files.

• loaded : ObjectCKEDITOR.resourceManager#loaded

  See source

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

  Defaults to {}

• registered : ObjectCKEDITOR.resourceManager#registered

  See source

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

  Defaults to {}

• private

  _ : ObjectCKEDITOR.resourceManager#_

  See source

  Defaults to {waitingList: {}}

Methods

• constructor( basePath, fileName ) → resourceManagerCKEDITOR.resourceManager#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

  add( name, [ definition ] )CKEDITOR.resourceManager#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

  addExternal( names, path, [ fileName ] )CKEDITOR.resourceManager#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.

  get( name ) → ObjectCKEDITOR.resourceManager#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.

  getFilePath( name ) → StringCKEDITOR.resourceManager#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

  getPath( name ) → StringCKEDITOR.resourceManager#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

  load( name, callback, [ scope ] )CKEDITOR.resourceManager#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.