Class CKEDITOR.eventInfo
Defined in: core/eventInfo.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
This class is not really part of the API.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Any kind of additional data.
|
|
|
The editor instance that holds the sender.
|
|
|
Any extra data appended during the listener registration.
|
|
|
The event name.
|
|
|
The object that publishes (sends) the event.
|
| Method Attributes | Method Name and Description |
|---|---|
|
cancel()
Indicates that the event is to be cancelled (if cancelable).
|
|
|
stop()
Indicates that no further listeners are to be called.
|
Class Detail
CKEDITOR.eventInfo()
Since:
3.0
This class is not really part of the API. It just illustrates the features
of the event object passed to event listeners by a CKEDITOR.event
based object.
// Do not do this. var myEvent = new CKEDITOR.eventInfo(); // Error: CKEDITOR.eventInfo is undefined
Field Detail
{Object}
data
Since:
3.0
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' );
{CKEDITOR.editor}
editor
Since:
3.0
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 );
{Object}
listenerData
Since:
3.0
Any extra data appended during the listener registration.
someObject.on( 'someevent', function( event )
{
alert( event.listenerData ); // "Example"
}
, null, 'Example' );
{String}
name
Since:
3.0
The event name.
someObject.on( 'someevent', function( event )
{
alert( event.name ); // "someevent"
});
someObject.fire( 'someevent' );
{Object}
sender
Since:
3.0
The object that publishes (sends) the event.
someObject.on( 'someevent', function( event )
{
alert( event.sender == someObject ); // "true"
});
someObject.fire( 'someevent' );
Method Detail
cancel()
Since:
3.0
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"
stop()
Since:
3.0
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"