CKFinder.Event.EventInfo

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

This class is not really part of the API.

Defined By

Properties

: Object

Removes the current listener. ...

Removes the current listener.

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

CKFinder.Event.EventInfo

data : Object

Any kind of additional data. ...

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' );

CKFinder.Event.EventInfo

finder : CKFinder.Application

The finder instance that holds the sender. ...

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

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

CKFinder.Event.EventInfo

listenerData : Object

Any extra data appended during the listener registration. ...

Any extra data appended during the listener registration.

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

CKFinder.Event.EventInfo

name : Object

The event name. ...

The event name.

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

CKFinder.Event.EventInfo

sender : Object

The object that publishes (sends) the event. ...

The object that publishes (sends) the event.

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

Defined By

Methods

CKFinder.Event.EventInfo

cancel( )

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

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' ) ); // true

CKFinder.Event.EventInfo

stop( )

Indicates that no further listeners are to be called. ...

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' ) ); // false