2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @fileOverview Defines the "virtual" {@link CKEDITOR.eventInfo} class, which
\r
8 * contains the defintions of the event object passed to event listeners.
\r
9 * This file is for documentation purposes only.
\r
13 * (Virtual Class) Do not call this constructor. This class is not really part
\r
15 * @class Virtual class that illustrates the features of the event object to be
\r
16 * passed to event listeners by a {@link CKEDITOR.event} based object.
\r
17 * @name CKEDITOR.eventInfo
\r
19 * // Do not do this.
\r
20 * var myEvent = new CKEDITOR.eventInfo(); // Error: CKEDITOR.eventInfo is undefined
\r
25 * @name CKEDITOR.eventInfo.prototype.name
\r
29 * someObject.on( 'someEvent', function( event )
\r
31 * alert( <b>event.name</b> ); // "someEvent"
\r
33 * someObject.fire( 'someEvent' );
\r
37 * The object that publishes (sends) the event.
\r
38 * @name CKEDITOR.eventInfo.prototype.sender
\r
42 * someObject.on( 'someEvent', function( event )
\r
44 * alert( <b>event.sender</b> == someObject ); // "true"
\r
46 * someObject.fire( 'someEvent' );
\r
50 * The editor instance that holds the sender. May be the same as sender. May be
\r
51 * null if the sender is not part of an editor instance, like a component
\r
52 * running in standalone mode.
\r
53 * @name CKEDITOR.eventInfo.prototype.editor
\r
55 * @type CKEDITOR.editor
\r
57 * myButton.on( 'someEvent', function( event )
\r
59 * alert( <b>event.editor</b> == myEditor ); // "true"
\r
61 * myButton.fire( 'someEvent', null, <b>myEditor</b> );
\r
65 * Any kind of additional data. Its format and usage is event dependent.
\r
66 * @name CKEDITOR.eventInfo.prototype.data
\r
70 * someObject.on( 'someEvent', function( event )
\r
72 * alert( <b>event.data</b> ); // "Example"
\r
74 * someObject.fire( 'someEvent', <b>'Example'</b> );
\r
78 * Any extra data appended during the listener registration.
\r
79 * @name CKEDITOR.eventInfo.prototype.listenerData
\r
83 * someObject.on( 'someEvent', function( event )
\r
85 * alert( <b>event.listenerData</b> ); // "Example"
\r
87 * , null, <b>'Example'</b> );
\r
91 * Indicates that no further listeners are to be called.
\r
92 * @name CKEDITOR.eventInfo.prototype.stop
\r
95 * someObject.on( 'someEvent', function( event )
\r
97 * <b>event.stop()</b>;
\r
99 * someObject.on( 'someEvent', function( event )
\r
101 * // This one will not be called.
\r
103 * alert( someObject.fire( 'someEvent' ) ); // "false"
\r
107 * Indicates that the event is to be cancelled (if cancelable).
\r
108 * @name CKEDITOR.eventInfo.prototype.cancel
\r
111 * someObject.on( 'someEvent', function( event )
\r
113 * <b>event.cancel()</b>;
\r
115 * someObject.on( 'someEvent', function( event )
\r
117 * // This one will not be called.
\r
119 * alert( someObject.fire( 'someEvent' ) ); // "true"
\r