1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
|
/**
* @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @fileOverview Defines the {@link CKEDITOR_Adapters.jQuery jQuery Adapter}.
*/
/**
* @class CKEDITOR_Adapters.jQuery
* @singleton
*
* The jQuery Adapter allows for easy use of basic CKEditor functions and access to the internal API.
* To find more information about the jQuery Adapter, go to the {@glink guide/dev_jquery jQuery Adapter section}
* of the Developer's Guide or see the "Create Editors with jQuery" sample.
*
* @aside guide dev_jquery
*/
( function( $ ) {
if ( typeof $ == 'undefined' ) {
throw new Error( 'jQuery should be loaded before CKEditor jQuery adapter.' );
}
if ( typeof CKEDITOR == 'undefined' ) {
throw new Error( 'CKEditor should be loaded before CKEditor jQuery adapter.' );
}
/**
* Allows CKEditor to override `jQuery.fn.val()`. When set to `true`, the `val()` function
* used on textarea elements replaced with CKEditor uses the CKEditor API.
*
* This configuration option is global and is executed during the loading of the jQuery Adapter.
* It cannot be customized across editor instances.
*
* Read more in the {@glink guide/dev_jquery documentation}.
*
* <script>
* CKEDITOR.config.jqueryOverrideVal = true;
* </script>
*
* <!-- Important: The jQuery Adapter is loaded *after* setting jqueryOverrideVal. -->
* <script src="/ckeditor/adapters/jquery.js"></script>
*
* <script>
* $( 'textarea' ).ckeditor();
* // ...
* $( 'textarea' ).val( 'New content' );
* </script>
*
* @cfg {Boolean} [jqueryOverrideVal=true]
* @member CKEDITOR.config
*/
CKEDITOR.config.jqueryOverrideVal =
typeof CKEDITOR.config.jqueryOverrideVal == 'undefined' ? true : CKEDITOR.config.jqueryOverrideVal;
// jQuery object methods.
$.extend( $.fn, {
/**
* Returns an existing CKEditor instance for the first matched element.
* Allows to easily use the internal API. Does not return a jQuery object.
*
* Raises an exception if the editor does not exist or is not ready yet.
*
* @returns CKEDITOR.editor
* @deprecated Use {@link #editor editor property} instead.
*/
ckeditorGet: function() {
var instance = this.eq( 0 ).data( 'ckeditorInstance' );
if ( !instance )
throw 'CKEditor is not initialized yet, use ckeditor() with a callback.';
return instance;
},
/**
* A jQuery function which triggers the creation of CKEditor with `<textarea>` and
* {@link CKEDITOR.dtd#$editable editable} elements.
* Every `<textarea>` element will be converted to a classic (`iframe`-based) editor,
* while any other supported element will be converted to an inline editor.
* This method binds the callback to the `instanceReady` event of all instances.
* If the editor has already been created, the callback is fired straightaway.
* You can also create multiple editors at once by using `$( '.className' ).ckeditor();`.
*
* **Note**: jQuery chaining and mixed parameter order is allowed.
*
* @param {Function} callback
* Function to be run on the editor instance. Callback takes the source element as a parameter.
*
* $( 'textarea' ).ckeditor( function( textarea ) {
* // Callback function code.
* } );
*
* @param {Object} config
* Configuration options for new instance(s) if not already created.
*
* $( 'textarea' ).ckeditor( {
* uiColor: '#9AB8F3'
* } );
*
* @returns jQuery.fn
*/
ckeditor: function( callback, config ) {
if ( !CKEDITOR.env.isCompatible )
throw new Error( 'The environment is incompatible.' );
// Reverse the order of arguments if the first one isn't a function.
if ( !$.isFunction( callback ) ) {
var tmp = config;
config = callback;
callback = tmp;
}
// An array of instanceReady callback promises.
var promises = [];
config = config || {};
// Iterate over the collection.
this.each( function() {
var $element = $( this ),
editor = $element.data( 'ckeditorInstance' ),
instanceLock = $element.data( '_ckeditorInstanceLock' ),
element = this,
dfd = new $.Deferred();
promises.push( dfd.promise() );
if ( editor && !instanceLock ) {
if ( callback )
callback.apply( editor, [ this ] );
dfd.resolve();
} else if ( !instanceLock ) {
// CREATE NEW INSTANCE
// Handle config.autoUpdateElement inside this plugin if desired.
if ( config.autoUpdateElement || ( typeof config.autoUpdateElement == 'undefined' && CKEDITOR.config.autoUpdateElement ) ) {
config.autoUpdateElementJquery = true;
}
// Always disable config.autoUpdateElement.
config.autoUpdateElement = false;
$element.data( '_ckeditorInstanceLock', true );
// Set instance reference in element's data.
if ( $( this ).is( 'textarea' ) )
editor = CKEDITOR.replace( element, config );
else
editor = CKEDITOR.inline( element, config );
$element.data( 'ckeditorInstance', editor );
// Register callback.
editor.on( 'instanceReady', function( evt ) {
var editor = evt.editor;
setTimeout( function waitForEditor() {
// Delay bit more if editor is still not ready.
if ( !editor.element ) {
setTimeout( waitForEditor, 100 );
return;
}
// Remove this listener. Triggered when new instance is ready.
evt.removeListener();
/**
* Forwards the CKEditor {@link CKEDITOR.editor#event-dataReady dataReady event} as a jQuery event.
*
* @event dataReady
* @param {CKEDITOR.editor} editor Editor instance.
*/
editor.on( 'dataReady', function() {
$element.trigger( 'dataReady.ckeditor', [ editor ] );
} );
/**
* Forwards the CKEditor {@link CKEDITOR.editor#event-setData setData event} as a jQuery event.
*
* @event setData
* @param {CKEDITOR.editor} editor Editor instance.
* @param data
* @param {String} data.dataValue The data that will be used.
*/
editor.on( 'setData', function( evt ) {
$element.trigger( 'setData.ckeditor', [ editor, evt.data ] );
} );
/**
* Forwards the CKEditor {@link CKEDITOR.editor#event-getData getData event} as a jQuery event.
*
* @event getData
* @param {CKEDITOR.editor} editor Editor instance.
* @param data
* @param {String} data.dataValue The data that will be returned.
*/
editor.on( 'getData', function( evt ) {
$element.trigger( 'getData.ckeditor', [ editor, evt.data ] );
}, 999 );
/**
* Forwards the CKEditor {@link CKEDITOR.editor#event-destroy destroy event} as a jQuery event.
*
* @event destroy
* @param {CKEDITOR.editor} editor Editor instance.
*/
editor.on( 'destroy', function() {
$element.trigger( 'destroy.ckeditor', [ editor ] );
} );
// Overwrite save button to call jQuery submit instead of javascript submit.
// Otherwise jQuery.forms does not work properly
editor.on( 'save', function() {
$( element.form ).submit();
return false;
}, null, null, 20 );
// Integrate with form submit.
if ( editor.config.autoUpdateElementJquery && $element.is( 'textarea' ) && $( element.form ).length ) {
var onSubmit = function() {
$element.ckeditor( function() {
editor.updateElement();
} );
};
// Bind to submit event.
$( element.form ).submit( onSubmit );
// Bind to form-pre-serialize from jQuery Forms plugin.
$( element.form ).bind( 'form-pre-serialize', onSubmit );
// Unbind when editor destroyed.
$element.bind( 'destroy.ckeditor', function() {
$( element.form ).unbind( 'submit', onSubmit );
$( element.form ).unbind( 'form-pre-serialize', onSubmit );
} );
}
// Garbage collect on destroy.
editor.on( 'destroy', function() {
$element.removeData( 'ckeditorInstance' );
} );
// Remove lock.
$element.removeData( '_ckeditorInstanceLock' );
/**
* Forwards the CKEditor {@link CKEDITOR.editor#event-instanceReady instanceReady event} as a jQuery event.
*
* @event instanceReady
* @param {CKEDITOR.editor} editor Editor instance.
*/
$element.trigger( 'instanceReady.ckeditor', [ editor ] );
// Run given (first) code.
if ( callback )
callback.apply( editor, [ element ] );
dfd.resolve();
}, 0 );
}, null, null, 9999 );
} else {
// Editor is already during creation process, bind our code to the event.
editor.once( 'instanceReady', function() {
setTimeout( function waitForEditor() {
// Delay bit more if editor is still not ready.
if ( !editor.element ) {
setTimeout( waitForEditor, 100 );
return;
}
// Run given code.
if ( editor.element.$ == element && callback )
callback.apply( editor, [ element ] );
dfd.resolve();
}, 0 );
}, null, null, 9999 );
}
} );
/**
* The [jQuery Promise object](http://api.jquery.com/promise/) that handles the asynchronous constructor.
* This promise will be resolved after **all** of the constructors.
*
* @property {Function} promise
*/
var dfd = new $.Deferred();
this.promise = dfd.promise();
$.when.apply( this, promises ).then( function() {
dfd.resolve();
} );
/**
* Existing CKEditor instance. Allows to easily use the internal API.
*
* **Note**: This is not a jQuery object.
*
* var editor = $( 'textarea' ).ckeditor().editor;
*
* @property {CKEDITOR.editor} editor
*/
this.editor = this.eq( 0 ).data( 'ckeditorInstance' );
return this;
}
} );
/**
* Overwritten jQuery `val()` method for `<textarea>` elements that have bound CKEditor instances.
* This method gets or sets editor content by using the {@link CKEDITOR.editor#method-getData editor.getData()}
* or {@link CKEDITOR.editor#method-setData editor.setData()} methods. To handle
* the {@link CKEDITOR.editor#method-setData editor.setData()} callback (as `setData` is asynchronous),
* `val( 'some data' )` will return a [jQuery Promise object](http://api.jquery.com/promise/).
*
* @method val
* @returns String|Number|Array|jQuery.fn|function(jQuery Promise)
*/
if ( CKEDITOR.config.jqueryOverrideVal ) {
$.fn.val = CKEDITOR.tools.override( $.fn.val, function( oldValMethod ) {
return function( value ) {
// Setter, i.e. .val( "some data" );
if ( arguments.length ) {
var _this = this,
promises = [], //use promise to handle setData callback
result = this.each( function() {
var $elem = $( this ),
editor = $elem.data( 'ckeditorInstance' );
// Handle .val for CKEditor.
if ( $elem.is( 'textarea' ) && editor ) {
var dfd = new $.Deferred();
editor.setData( value, function() {
dfd.resolve();
} );
promises.push( dfd.promise() );
return true;
// Call default .val function for rest of elements
} else {
return oldValMethod.call( $elem, value );
}
} );
// If there is no promise return default result (jQuery object of chaining).
if ( !promises.length )
return result;
// Create one promise which will be resolved when all of promises will be done.
else {
var dfd = new $.Deferred();
$.when.apply( this, promises ).done( function() {
dfd.resolveWith( _this );
} );
return dfd.promise();
}
}
// Getter .val();
else {
var $elem = $( this ).eq( 0 ),
editor = $elem.data( 'ckeditorInstance' );
if ( $elem.is( 'textarea' ) && editor )
return editor.getData();
else
return oldValMethod.call( $elem );
}
};
} );
}
} )( window.jQuery );
|