]>
git.immae.eu Git - perso/Immae/Projets/packagist/ludivine-ckeditor-component.git/blob - sources/core/eventInfo.js
2 * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
3 * For licensing, see LICENSE.md or http://ckeditor.com/license
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.
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.
16 * This class is not really part of the API.
18 * @class CKEDITOR.eventInfo
25 * someObject.on( 'someEvent', function( event ) {
26 * alert( event.name ); // 'someEvent'
28 * someObject.fire( 'someEvent' );
30 * @property {String} name
34 * The object that publishes (sends) the event.
36 * someObject.on( 'someEvent', function( event ) {
37 * alert( event.sender == someObject ); // true
39 * someObject.fire( 'someEvent' );
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.
49 * myButton.on( 'someEvent', function( event ) {
50 * alert( event.editor == myEditor ); // true
52 * myButton.fire( 'someEvent', null, myEditor );
54 * @property {CKEDITOR.editor} editor
58 * Any kind of additional data. Its format and usage is event dependent.
60 * someObject.on( 'someEvent', function( event ) {
61 * alert( event.data ); // 'Example'
63 * someObject.fire( 'someEvent', 'Example' );
69 * Any extra data appended during the listener registration.
71 * someObject.on( 'someEvent', function( event ) {
72 * alert( event.listenerData ); // 'Example'
73 * }, null, 'Example' );
75 * @property listenerData
79 * Indicates that no further listeners are to be called.
81 * someObject.on( 'someEvent', function( event ) {
84 * someObject.on( 'someEvent', function( event ) {
85 * // This one will not be called.
87 * alert( someObject.fire( 'someEvent' ) ); // true
93 * Indicates that the event is to be cancelled (if cancelable).
95 * someObject.on( 'someEvent', function( event ) {
98 * someObject.on( 'someEvent', function( event ) {
99 * // This one will not be called.
101 * alert( someObject.fire( 'someEvent' ) ); // false
107 * Removes the current listener.
109 * someObject.on( 'someEvent', function( event ) {
110 * event.removeListener();
111 * // Now this function won't be called again by 'someEvent'.
114 * @method removeListener