CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.eventInfo

classabstract
See source

Virtual class that illustrates the features of the event object to be passed to event listeners by a CKEDITOR.event based object.

This class is not really part of the API.

Filtering

Properties

  • data : Object

    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 : 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 : Object

    See source

    Any extra data appended during the listener registration.

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

  • name : String

    See source

    The event name.

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

  • sender : Object

    See source

    The object that publishes (sends) the event.

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

Methods

  • 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()

    See source

    Removes the current listener.

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

  • 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