Properties

• data : ObjectCKEDITOR.eventInfo#data

  See source

  Any kind of additional data. Its format and usage is event dependent.

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

• editor : editorCKEDITOR.eventInfo#editor

  See source

  The editor instance that holds the sender. May be the same as sender. May be null if the sender is not part of an editor instance, like a component running in standalone mode.

  myButton.on( 'someEvent', function( event ) {
      alert( event.editor == myEditor ); // true
  } );
  myButton.fire( 'someEvent', null, myEditor );
  

• listenerData : ObjectCKEDITOR.eventInfo#listenerData

  See source

  Any extra data appended during the listener registration.

  someObject.on( 'someEvent', function( event ) {
      alert( event.listenerData ); // 'Example'
  }, null, 'Example' );
  

• name : StringCKEDITOR.eventInfo#name

  See source

  The event name.

  someObject.on( 'someEvent', function( event ) {
      alert( event.name ); // 'someEvent'
  } );
  someObject.fire( 'someEvent' );
  

• sender : ObjectCKEDITOR.eventInfo#sender

  See source

  The object that publishes (sends) the event.

  someObject.on( 'someEvent', function( event ) {
      alert( event.sender == someObject ); // true
  } );
  someObject.fire( 'someEvent' );
  

Methods

• cancel()CKEDITOR.eventInfo#cancel

  See source

  Indicates that the event is to be cancelled (if cancelable).

  someObject.on( 'someEvent', function( event ) {
      event.cancel();
  } );
  someObject.on( 'someEvent', function( event ) {
      // This one will not be called.
  } );
  alert( someObject.fire( 'someEvent' ) ); // false
  

• removeListener()CKEDITOR.eventInfo#removeListener

  See source

  Removes the current listener.

  someObject.on( 'someEvent', function( event ) {
      event.removeListener();
      // Now this function won't be called again by 'someEvent'.
  } );
  

• stop()CKEDITOR.eventInfo#stop

  See source

  Indicates that no further listeners are to be called.

  someObject.on( 'someEvent', function( event ) {
      event.stop();
  } );
  someObject.on( 'someEvent', function( event ) {
      // This one will not be called.
  } );
  alert( someObject.fire( 'someEvent' ) ); // true