]>
Commit | Line | Data |
---|---|---|
3332bebe | 1 | /** |
317f8f8f | 2 | * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. |
3332bebe IB |
3 | * For licensing, see LICENSE.md or http://ckeditor.com/license |
4 | */ | |
5 | ||
6 | /** | |
7 | * @fileOverview Defines the "virtual" {@link CKEDITOR.eventInfo} class, which | |
8 | * contains the defintions of the event object passed to event listeners. | |
9 | * This file is for documentation purposes only. | |
10 | */ | |
11 | ||
12 | /** | |
13 | * Virtual class that illustrates the features of the event object to be | |
14 | * passed to event listeners by a {@link CKEDITOR.event} based object. | |
15 | * | |
16 | * This class is not really part of the API. | |
17 | * | |
18 | * @class CKEDITOR.eventInfo | |
19 | * @abstract | |
20 | */ | |
21 | ||
22 | /** | |
23 | * The event name. | |
24 | * | |
25 | * someObject.on( 'someEvent', function( event ) { | |
26 | * alert( event.name ); // 'someEvent' | |
27 | * } ); | |
28 | * someObject.fire( 'someEvent' ); | |
29 | * | |
30 | * @property {String} name | |
31 | */ | |
32 | ||
33 | /** | |
34 | * The object that publishes (sends) the event. | |
35 | * | |
36 | * someObject.on( 'someEvent', function( event ) { | |
37 | * alert( event.sender == someObject ); // true | |
38 | * } ); | |
39 | * someObject.fire( 'someEvent' ); | |
40 | * | |
41 | * @property sender | |
42 | */ | |
43 | ||
44 | /** | |
45 | * The editor instance that holds the sender. May be the same as sender. May be | |
46 | * null if the sender is not part of an editor instance, like a component | |
47 | * running in standalone mode. | |
48 | * | |
49 | * myButton.on( 'someEvent', function( event ) { | |
50 | * alert( event.editor == myEditor ); // true | |
51 | * } ); | |
52 | * myButton.fire( 'someEvent', null, myEditor ); | |
53 | * | |
54 | * @property {CKEDITOR.editor} editor | |
55 | */ | |
56 | ||
57 | /** | |
58 | * Any kind of additional data. Its format and usage is event dependent. | |
59 | * | |
60 | * someObject.on( 'someEvent', function( event ) { | |
61 | * alert( event.data ); // 'Example' | |
62 | * } ); | |
63 | * someObject.fire( 'someEvent', 'Example' ); | |
64 | * | |
65 | * @property data | |
66 | */ | |
67 | ||
68 | /** | |
69 | * Any extra data appended during the listener registration. | |
70 | * | |
71 | * someObject.on( 'someEvent', function( event ) { | |
72 | * alert( event.listenerData ); // 'Example' | |
73 | * }, null, 'Example' ); | |
74 | * | |
75 | * @property listenerData | |
76 | */ | |
77 | ||
78 | /** | |
79 | * Indicates that no further listeners are to be called. | |
80 | * | |
81 | * someObject.on( 'someEvent', function( event ) { | |
82 | * event.stop(); | |
83 | * } ); | |
84 | * someObject.on( 'someEvent', function( event ) { | |
85 | * // This one will not be called. | |
86 | * } ); | |
87 | * alert( someObject.fire( 'someEvent' ) ); // true | |
88 | * | |
89 | * @method stop | |
90 | */ | |
91 | ||
92 | /** | |
93 | * Indicates that the event is to be cancelled (if cancelable). | |
94 | * | |
95 | * someObject.on( 'someEvent', function( event ) { | |
96 | * event.cancel(); | |
97 | * } ); | |
98 | * someObject.on( 'someEvent', function( event ) { | |
99 | * // This one will not be called. | |
100 | * } ); | |
101 | * alert( someObject.fire( 'someEvent' ) ); // false | |
102 | * | |
103 | * @method cancel | |
104 | */ | |
105 | ||
106 | /** | |
107 | * Removes the current listener. | |
108 | * | |
109 | * someObject.on( 'someEvent', function( event ) { | |
110 | * event.removeListener(); | |
111 | * // Now this function won't be called again by 'someEvent'. | |
112 | * } ); | |
113 | * | |
114 | * @method removeListener | |
115 | */ |