CKEDITOR.ui

Properties

• private

  _ : ObjectCKEDITOR.ui#_

  See source

  Object used to store private stuff.

  Defaults to {handlers: {}}

Static properties

• mixed static

  useCapture : BooleanCKEDITOR.ui#useCapture

  See source

Methods

• constructor( editor ) → uiCKEDITOR.ui#constructor

  See source

  Creates a ui class instance.

  Parameters

  editor : editor

  The editor instance.

  Returns

  ui

  add( name, type, definition )CKEDITOR.ui#add

  See source

  Adds a UI item to the items collection. These items can be later used in the interface.

  // Add a new button named 'MyBold'.
  editorInstance.ui.add( 'MyBold', CKEDITOR.UI_BUTTON, {
      label: 'My Bold',
      command: 'bold'
  } );
  

  Parameters

  name : String

  The UI item name.

  type : Object

  The item type.

  definition : Object

  The item definition. The properties of this object depend on the item type.

  addButton( name, definition )CKEDITOR.ui#addButton

  See source

  Adds a button definition to the UI elements list.

  editorInstance.ui.addButton( 'MyBold', {
      label: 'My Bold',
      command: 'bold',
      toolbar: 'basicstyles,1'
  } );
  

  Parameters

  name : String

  The button name.

  definition : Object

  The button definition.

  addHandler( type, handler )CKEDITOR.ui#addHandler

  See source

  Adds a handler for a UI item type. The handler is responsible for transforming UI item definitions into UI objects.

  Parameters

  type : Object

  The item type.

  handler : Object

  The handler definition.

  addRichCombo( name, definition )CKEDITOR.ui#addRichCombo

  See source

  Parameters

  name : String

  definition : Object

  addToolbarGroup( name, previous, [ subgroupOf ] )CKEDITOR.ui#addToolbarGroup

  See source

  Adds a toolbar group. See CKEDITOR.config.toolbarGroups for more details.

  Note: This method will not modify toolbar groups set explicitly by CKEDITOR.config.toolbarGroups. It will only extend the default setting.

  Parameters

  name : String

  Toolbar group name.

  previous : Number | String

  The name of the toolbar group after which this one should be added or 0 if this group should be the first one.

  [ subgroupOf ] : String

  The name of the parent group.

  capture()CKEDITOR.ui#capture

  See source

  Register event handler under the capturing stage on supported target.

  create( name ) → ObjectCKEDITOR.ui#create

  See source

  Gets a UI object.

  Parameters

  name : String

  The UI item name.

  Returns

  Object

  The UI element.

  define( name, meta )CKEDITOR.ui#define

  See source

  Predefine some intrinsic properties on a specific event name.

  Parameters

  name : String

  The event name

  meta : Object

  fire( eventName, [ data ], [ editor ] ) → Boolean | ObjectCKEDITOR.ui#fire

  See source

  Fires an specific event in the object. All registered listeners are called at this point.

  someObject.on( 'someEvent', function() { ... } );
  someObject.on( 'someEvent', function() { ... } );
  someObject.fire( 'someEvent' );             // Both listeners are called.
  
  someObject.on( 'someEvent', function( event ) {
      alert( event.data );                    // 'Example'
  } );
  someObject.fire( 'someEvent', 'Example' );
  

  Parameters

  eventName : String

  The event name to fire.

  [ data ] : Object

  Data to be sent as the CKEDITOR.eventInfo.data when calling the listeners.

  [ editor ] : editor

  The editor instance to send as the CKEDITOR.eventInfo.editor when calling the listener.

  Returns

  Boolean | Object

  A boolean indicating that the event is to be canceled, or data returned by one of the listeners.

  fireOnce( eventName, [ data ], [ editor ] ) → Boolean | ObjectCKEDITOR.ui#fireOnce

  See source

  Fires an specific event in the object, releasing all listeners registered to that event. The same listeners are not called again on successive calls of it or of fire.

  someObject.on( 'someEvent', function() { ... } );
  someObject.fire( 'someEvent' );         // Above listener called.
  someObject.fireOnce( 'someEvent' );     // Above listener called.
  someObject.fire( 'someEvent' );         // No listeners called.
  

  Parameters

  eventName : String

  The event name to fire.

  [ data ] : Object

  Data to be sent as the CKEDITOR.eventInfo.data when calling the listeners.

  [ editor ] : editor

  The editor instance to send as the CKEDITOR.eventInfo.editor when calling the listener.

  Returns

  Boolean | Object

  A booloan indicating that the event is to be canceled, or data returned by one of the listeners.

  get( name ) → ObjectCKEDITOR.ui#get

  See source

  Retrieves the created UI objects by name.

  Parameters

  name : String

  The name of the UI definition.

  Returns

  Object

  The UI object.

  hasListeners( eventName ) → BooleanCKEDITOR.ui#hasListeners

  See source

  Checks if there is any listener registered to a given event.

  var myListener = function() { ... };
  someObject.on( 'someEvent', myListener );
  alert( someObject.hasListeners( 'someEvent' ) );    // true
  alert( someObject.hasListeners( 'noEvent' ) );      // false
  

  Parameters

  eventName : String

  The event name.

  Returns

  Boolean

  on( eventName, listenerFunction, [ scopeObj ], [ listenerData ], [ priority ] ) → ObjectCKEDITOR.ui#on

  See source

  Registers a listener to a specific event in the current object.

  someObject.on( 'someEvent', function() {
      alert( this == someObject );        // true
  } );
  
  someObject.on( 'someEvent', function() {
      alert( this == anotherObject );     // true
  }, anotherObject );
  
  someObject.on( 'someEvent', function( event ) {
      alert( event.listenerData );        // 'Example'
  }, null, 'Example' );
  
  someObject.on( 'someEvent', function() { ... } );                       // 2nd called
  someObject.on( 'someEvent', function() { ... }, null, null, 100 );      // 3rd called
  someObject.on( 'someEvent', function() { ... }, null, null, 1 );        // 1st called
  

  Note: CKEditor's event system has a limitation that one function cannot be used as a listener for the same event more than once. Hence, to reuse it with multiple listeners, it should be wrapped into additional wrapper function:

  function listener( evt ) { ... };
  
  someObject.on( 'someEvent', function() {
      listener();
  } );
  
  someObject.on( 'someEvent', function( evt ) {
      listener( evt );
  } );
  

  Parameters

  eventName : String

  The event name to which listen.

  listenerFunction : Function

  The function listening to the event. A single CKEDITOR.eventInfo object instanced is passed to this function containing all the event data.

  [ scopeObj ] : Object

  The object used to scope the listener call (the this object). If omitted, the current object is used.

  [ listenerData ] : Object

  Data to be sent as the CKEDITOR.eventInfo.listenerData when calling the listener.

  [ priority ] : Number

  The listener priority. Lower priority listeners are called first. Listeners with the same priority value are called in registration order.

  Defaults to 10

  Returns

  Object

  An object containing the removeListener function, which can be used to remove the listener at any time.

  once()CKEDITOR.ui#once

  See source

  Similiar with on but the listener will be called only once upon the next event firing.

  CKEDITOR.event.on

  removeAllListeners()CKEDITOR.ui#removeAllListeners

  See source

  Remove all existing listeners on this object, for cleanup purpose.

  removeListener( eventName, listenerFunction )CKEDITOR.ui#removeListener

  See source

  Unregisters a listener function from being called at the specified event. No errors are thrown if the listener has not been registered previously.

  var myListener = function() { ... };
  someObject.on( 'someEvent', myListener );
  someObject.fire( 'someEvent' );                 // myListener called.
  someObject.removeListener( 'someEvent', myListener );
  someObject.fire( 'someEvent' );                 // myListener not called.
  

  Parameters

  eventName : String

  The event name.

  listenerFunction : Function

  The listener function to unregister.

  space( name ) → elementCKEDITOR.ui#space

  See source

  Returns the unique DOM element that represents one editor's UI part, also known as "space". There are 3 main editor spaces available: top, contents and bottom and their availability depends on editor type.

  // Hide the bottom space in the UI.
  var bottom = editor.ui.space( 'bottom' );
  bottom.setStyle( 'display', 'none' );
  

  Parameters

  name : String

  The name of the space.

  Returns

  element

  The element that represents the space.

  spaceId( name ) → StringCKEDITOR.ui#spaceId

  See source

  Returns the HTML ID for a specific UI space name.

  Parameters

  name : String

  The name of the space.

  Returns

  String

  The ID of an element representing this space in the DOM.

  Static methods

  • mixed static

    implementOn( targetObject )CKEDITOR.ui#implementOn

    See source

    Implements the CKEDITOR.event features in an object.

    var myObject = { message: 'Example' };
    CKEDITOR.event.implementOn( myObject );
    
    myObject.on( 'testEvent', function() {
        alert( this.message );
    } );
    myObject.fire( 'testEvent' ); // 'Example'
    

    Parameters

    targetObject : Object

    The object into which implement the features.

    Events

    • ready( evt )CKEDITOR.ui#ready

      See source

      Internal event fired when a new UI element is ready.

      Parameters

      evt : eventInfo