-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
editable.js
3093 lines (2565 loc) · 104 KB
/
editable.js
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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or http://ckeditor.com/license
*/
( function() {
/**
* Editable class which provides all editing related activities by
* the `contenteditable` element, dynamically get attached to editor instance.
*
* @class CKEDITOR.editable
* @extends CKEDITOR.dom.element
*/
CKEDITOR.editable = CKEDITOR.tools.createClass( {
base: CKEDITOR.dom.element,
/**
* The constructor only stores generic editable creation logic that is commonly shared among
* all different editable elements.
*
* @constructor Creates an editable class instance.
* @param {CKEDITOR.editor} editor The editor instance on which the editable operates.
* @param {HTMLElement/CKEDITOR.dom.element} element Any DOM element that was as the editor's
* editing container, e.g. it could be either an HTML element with the `contenteditable` attribute
* set to the `true` that handles WYSIWYG editing or a `<textarea>` element that handles source editing.
*/
$: function( editor, element ) {
// Transform the element into a CKEDITOR.dom.element instance.
this.base( element.$ || element );
this.editor = editor;
/**
* Indicates the initialization status of the editable element. The following statuses are available:
*
* * **unloaded** – the initial state. The editable's instance was created but
* is not fully loaded (in particular it has no data).
* * **ready** – the editable is fully initialized. The `ready` status is set after
* the first {@link CKEDITOR.editor#method-setData} is called.
* * **detached** – the editable was detached.
*
* @since 4.3.3
* @readonly
* @property {String}
*/
this.status = 'unloaded';
/**
* Indicates whether the editable element gained focus.
*
* @property {Boolean} hasFocus
*/
this.hasFocus = false;
// The bootstrapping logic.
this.setup();
},
proto: {
focus: function() {
var active;
// [Webkit] When DOM focus is inside of nested contenteditable elements,
// apply focus on the main editable will compromise it's text selection.
if ( CKEDITOR.env.webkit && !this.hasFocus ) {
// Restore focus on element which we cached (on selectionCheck) as previously active.
active = this.editor._.previousActive || this.getDocument().getActive();
if ( this.contains( active ) ) {
active.focus();
return;
}
}
// [IE] Use instead "setActive" method to focus the editable if it belongs to
// the host page document, to avoid bringing an unexpected scroll.
try {
this.$[ CKEDITOR.env.ie && this.getDocument().equals( CKEDITOR.document ) ? 'setActive' : 'focus' ]();
} catch ( e ) {
// IE throws unspecified error when focusing editable after closing dialog opened on nested editable.
if ( !CKEDITOR.env.ie )
throw e;
}
// Remedy if Safari doens't applies focus properly. (#279)
if ( CKEDITOR.env.safari && !this.isInline() ) {
active = CKEDITOR.document.getActive();
if ( !active.equals( this.getWindow().getFrame() ) )
this.getWindow().focus();
}
},
/**
* Overrides {@link CKEDITOR.dom.element#on} to have special `focus/blur` handling.
* The `focusin/focusout` events are used in IE to replace regular `focus/blur` events
* because we want to avoid the asynchronous nature of later ones.
*/
on: function( name, fn ) {
var args = Array.prototype.slice.call( arguments, 0 );
if ( CKEDITOR.env.ie && ( /^focus|blur$/ ).exec( name ) ) {
name = name == 'focus' ? 'focusin' : 'focusout';
// The "focusin/focusout" events bubbled, e.g. If there are elements with layout
// they fire this event when clicking in to edit them but it must be ignored
// to allow edit their contents. (#4682)
fn = isNotBubbling( fn, this );
args[ 0 ] = name;
args[ 1 ] = fn;
}
return CKEDITOR.dom.element.prototype.on.apply( this, args );
},
/**
* Registers an event listener that needs to be removed when detaching this editable.
* This means that it will be automatically removed when {@link #detach} is executed,
* for example on {@link CKEDITOR.editor#setMode changing editor mode} or destroying editor.
*
* Except for `obj` all other arguments have the same meaning as in {@link CKEDITOR.event#on}.
*
* This method is strongly related to the {@link CKEDITOR.editor#contentDom} and
* {@link CKEDITOR.editor#contentDomUnload} events, because they are fired
* when an editable is being attached and detached. Therefore, this method is usually used
* in the following way:
*
* editor.on( 'contentDom', function() {
* var editable = editor.editable();
* editable.attachListener( editable, 'mousedown', function() {
* // ...
* } );
* } );
*
* This code will attach the `mousedown` listener every time a new editable is attached
* to the editor, which in classic (`iframe`-based) editor happens every time the
* data or the mode is set. This listener will also be removed when that editable is detached.
*
* It is also possible to attach a listener to another object (e.g. to a document).
*
* editor.on( 'contentDom', function() {
* editor.editable().attachListener( editor.document, 'mousedown', function() {
* // ...
* } );
* } );
*
* @param {CKEDITOR.event} obj The element/object to which the listener will be attached. Every object
* which inherits from {@link CKEDITOR.event} may be used including {@link CKEDITOR.dom.element},
* {@link CKEDITOR.dom.document}, and {@link CKEDITOR.editable}.
* @param {String} eventName The name of the event that will be listened to.
* @param {Function} listenerFunction The function listening to the
* event. A single {@link CKEDITOR.eventInfo} object instance
* containing all the event data is passed to this function.
* @param {Object} [scopeObj] The object used to scope the listener
* call (the `this` object). If omitted, the current object is used.
* @param {Object} [listenerData] Data to be sent as the
* {@link CKEDITOR.eventInfo#listenerData} when calling the listener.
* @param {Number} [priority=10] The listener priority. Lower priority
* listeners are called first. Listeners with the same priority
* value are called in the registration order.
* @returns {Object} An object containing the `removeListener`
* function that can be used to remove the listener at any time.
*/
attachListener: function( obj /*, event, fn, scope, listenerData, priority*/ ) {
!this._.listeners && ( this._.listeners = [] );
// Register the listener.
var args = Array.prototype.slice.call( arguments, 1 ),
listener = obj.on.apply( obj, args );
this._.listeners.push( listener );
return listener;
},
/**
* Remove all event listeners registered from {@link #attachListener}.
*/
clearListeners: function() {
var listeners = this._.listeners;
// Don't get broken by this.
try {
while ( listeners.length )
listeners.pop().removeListener();
} catch ( e ) {}
},
/**
* Restore all attribution changes made by {@link #changeAttr }.
*/
restoreAttrs: function() {
var changes = this._.attrChanges, orgVal;
for ( var attr in changes ) {
if ( changes.hasOwnProperty( attr ) ) {
orgVal = changes[ attr ];
// Restore original attribute.
orgVal !== null ? this.setAttribute( attr, orgVal ) : this.removeAttribute( attr );
}
}
},
/**
* Adds a CSS class name to this editable that needs to be removed on detaching.
*
* @param {String} className The class name to be added.
* @see CKEDITOR.dom.element#addClass
*/
attachClass: function( cls ) {
var classes = this.getCustomData( 'classes' );
if ( !this.hasClass( cls ) ) {
!classes && ( classes = [] ), classes.push( cls );
this.setCustomData( 'classes', classes );
this.addClass( cls );
}
},
/**
* Make an attribution change that would be reverted on editable detaching.
* @param {String} attr The attribute name to be changed.
* @param {String} val The value of specified attribute.
*/
changeAttr: function( attr, val ) {
var orgVal = this.getAttribute( attr );
if ( val !== orgVal ) {
!this._.attrChanges && ( this._.attrChanges = {} );
// Saved the original attribute val.
if ( !( attr in this._.attrChanges ) )
this._.attrChanges[ attr ] = orgVal;
this.setAttribute( attr, val );
}
},
/**
* Low-level method for inserting text into the editable.
* See the {@link CKEDITOR.editor#method-insertText} method which is the editor-level API
* for this purpose.
*
* @param {String} text
*/
insertText: function( text ) {
// Focus the editor before calling transformPlainTextToHtml. (#12726)
this.editor.focus();
this.insertHtml( this.transformPlainTextToHtml( text ), 'text' );
},
/**
* Transforms plain text to HTML based on current selection and {@link CKEDITOR.editor#activeEnterMode}.
*
* @since 4.5
* @param {String} text Text to transform.
* @returns {String} HTML generated from the text.
*/
transformPlainTextToHtml: function( text ) {
var enterMode = this.editor.getSelection().getStartElement().hasAscendant( 'pre', true ) ?
CKEDITOR.ENTER_BR :
this.editor.activeEnterMode;
return CKEDITOR.tools.transformPlainTextToHtml( text, enterMode );
},
/**
* Low-level method for inserting HTML into the editable.
* See the {@link CKEDITOR.editor#method-insertHtml} method which is the editor-level API
* for this purpose.
*
* @param {String} data The HTML to be inserted.
* @param {String} [mode='html'] See {@link CKEDITOR.editor#method-insertHtml}'s param.
* @param {CKEDITOR.dom.range} [range] If specified the HTML will be inserted into the range
* instead of into the selection.
*/
insertHtml: function( data, mode, range ) {
if ( !range )
this.insertHtmlIntoSelection( data, mode );
else
this.insertHtmlIntoRange( data, range, mode );
},
/**
* Inserts HTML into the selection. See also the {@link #insertHtml} method.
*
* Fires the {@link CKEDITOR.editor#event-afterInsertHtml} event.
*
* @since 4.5
* @param {String} data The HTML to be inserted.
* @param {String} [mode='html'] See {@link CKEDITOR.editor#method-insertHtml}'s param.
*/
insertHtmlIntoSelection: function( data, mode ) {
var editor = this.editor;
editor.focus();
editor.fire( 'saveSnapshot' );
// HTML insertion only considers the first range.
// Note: getRanges will be overwritten for tests since we want to test
// custom ranges and bypass native selections.
var range = editor.getSelection().getRanges()[ 0 ];
// Default mode is 'html'.
insert( this, mode || 'html', data, range );
// Make the final range selection.
range.select();
afterInsert( this );
this.editor.fire( 'afterInsertHtml', {} );
},
/**
* Inserts HTML into the position in the editor determined by the range.
*
* Fires the {@link CKEDITOR.editor#event-afterInsertHtml} event.
*
* **Note:** This method does not {@link CKEDITOR.editor#saveSnapshot save undo snapshots}.
*
* @since 4.5
* @param {String} data HTML code to be inserted into the editor.
* @param {CKEDITOR.dom.range} range The range as a place of insertion.
* @param {String} [mode='html'] Mode in which HTML will be inserted.
* See {@link CKEDITOR.editor#method-insertHtml}.
*/
insertHtmlIntoRange: function( data, range, mode ) {
// Default mode is 'html'
insert( this, mode || 'html', data, range );
this.editor.fire( 'afterInsertHtml', { intoRange: range } );
},
/**
* Low-level method for inserting an element into the editable.
* See the {@link CKEDITOR.editor#method-insertElement} method which is the editor-level API
* for this purpose.
*
* @param {CKEDITOR.dom.element} element The element to insert.
* @param {CKEDITOR.dom.range} [range] If specified the element will be inserted into the range
* instead of into the selection.
*/
insertElement: function( element, range ) {
if ( !range )
this.insertElementIntoSelection( element );
else
this.insertElementIntoRange( element, range );
},
/**
* Inserts an element into the position in the editor determined by the range.
*
* **Note:** This method does not {@link CKEDITOR.editor#saveSnapshot save undo snapshots}.
*
* @param {CKEDITOR.dom.element} element The element to be inserted.
* @param {CKEDITOR.dom.range} range The range as a place of insertion.
* @returns {Boolean} Informs whether insertion was successful.
*/
insertElementIntoRange: function( element, range ) {
var editor = this.editor,
enterMode = editor.config.enterMode,
elementName = element.getName(),
isBlock = CKEDITOR.dtd.$block[ elementName ];
if ( range.checkReadOnly() )
return false;
// Remove the original contents, merge split nodes.
range.deleteContents( 1 );
// If range is placed in inermediate element (not td or th), we need to do three things:
// * fill emptied <td/th>s with if browser needs them,
// * remove empty text nodes so IE8 won't crash (http://dev.ckeditor.com/ticket/11183#comment:8),
// * fix structure and move range into the <td/th> element.
if ( range.startContainer.type == CKEDITOR.NODE_ELEMENT && range.startContainer.is( { tr: 1, table: 1, tbody: 1, thead: 1, tfoot: 1 } ) )
fixTableAfterContentsDeletion( range );
// If we're inserting a block at dtd-violated position, split
// the parent blocks until we reach blockLimit.
var current, dtd;
if ( isBlock ) {
while ( ( current = range.getCommonAncestor( 0, 1 ) ) &&
( dtd = CKEDITOR.dtd[ current.getName() ] ) &&
!( dtd && dtd[ elementName ] ) ) {
// Split up inline elements.
if ( current.getName() in CKEDITOR.dtd.span )
range.splitElement( current );
// If we're in an empty block which indicate a new paragraph,
// simply replace it with the inserting block.(#3664)
else if ( range.checkStartOfBlock() && range.checkEndOfBlock() ) {
range.setStartBefore( current );
range.collapse( true );
current.remove();
} else {
range.splitBlock( enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'p', editor.editable() );
}
}
}
// Insert the new node.
range.insertNode( element );
// Return true if insertion was successful.
return true;
},
/**
* Inserts an element into the selection.
*
* @param {CKEDITOR.dom.element} element The element to be inserted.
*/
insertElementIntoSelection: function( element ) {
var editor = this.editor;
// Prepare for the insertion. For example - focus editor (#11848).
editor.focus();
editor.fire( 'saveSnapshot' );
var enterMode = editor.activeEnterMode,
selection = editor.getSelection(),
range = selection.getRanges()[ 0 ],
elementName = element.getName(),
isBlock = CKEDITOR.dtd.$block[ elementName ];
// Insert element into first range only and ignore the rest (#11183).
if ( this.insertElementIntoRange( element, range ) ) {
range.moveToPosition( element, CKEDITOR.POSITION_AFTER_END );
// If we're inserting a block element, the new cursor position must be
// optimized. (#3100,#5436,#8950)
if ( isBlock ) {
// Find next, meaningful element.
var next = element.getNext( function( node ) {
return isNotEmpty( node ) && !isBogus( node );
} );
if ( next && next.type == CKEDITOR.NODE_ELEMENT && next.is( CKEDITOR.dtd.$block ) ) {
// If the next one is a text block, move cursor to the start of it's content.
if ( next.getDtd()[ '#' ] )
range.moveToElementEditStart( next );
// Otherwise move cursor to the before end of the last element.
else
range.moveToElementEditEnd( element );
}
// Open a new line if the block is inserted at the end of parent.
else if ( !next && enterMode != CKEDITOR.ENTER_BR ) {
next = range.fixBlock( true, enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'p' );
range.moveToElementEditStart( next );
}
}
}
// Set up the correct selection.
selection.selectRanges( [ range ] );
afterInsert( this );
},
/**
* @see CKEDITOR.editor#setData
*/
setData: function( data, isSnapshot ) {
if ( !isSnapshot )
data = this.editor.dataProcessor.toHtml( data );
this.setHtml( data );
this.fixInitialSelection();
// Editable is ready after first setData.
if ( this.status == 'unloaded' )
this.status = 'ready';
this.editor.fire( 'dataReady' );
},
/**
* @see CKEDITOR.editor#getData
*/
getData: function( isSnapshot ) {
var data = this.getHtml();
if ( !isSnapshot )
data = this.editor.dataProcessor.toDataFormat( data );
return data;
},
/**
* Change the read-only state on this editable.
*
* @param {Boolean} isReadOnly
*/
setReadOnly: function( isReadOnly ) {
this.setAttribute( 'contenteditable', !isReadOnly );
},
/**
* Detach this editable object from the DOM (remove classes, listeners, etc.)
*/
detach: function() {
// Cleanup the element.
this.removeClass( 'cke_editable' );
this.status = 'detached';
// Save the editor reference which will be lost after
// calling detach from super class.
var editor = this.editor;
this._.detach();
delete editor.document;
delete editor.window;
},
/**
* Checks if the editable is one of the host page elements, indicates
* an inline editing environment.
*
* @returns {Boolean}
*/
isInline: function() {
return this.getDocument().equals( CKEDITOR.document );
},
/**
* Fixes the selection and focus which may be in incorrect state after
* editable's inner HTML was overwritten.
*
* If the editable did not have focus, then the selection will be fixed when the editable
* is focused for the first time. If the editable already had focus, then the selection will
* be fixed immediately.
*
* To understand the problem see:
*
* * http://tests.ckeditor.dev:1030/tests/core/selection/manual/focusaftersettingdata
* * http://tests.ckeditor.dev:1030/tests/core/selection/manual/focusafterundoing
* * http://tests.ckeditor.dev:1030/tests/core/selection/manual/selectionafterfocusing
* * http://tests.ckeditor.dev:1030/tests/plugins/newpage/manual/selectionafternewpage
*
* @since 4.4.6
* @private
*/
fixInitialSelection: function() {
var that = this;
// Deal with IE8- IEQM (the old MS selection) first.
if ( CKEDITOR.env.ie && ( CKEDITOR.env.version < 9 || CKEDITOR.env.quirks ) ) {
if ( this.hasFocus ) {
this.focus();
fixMSSelection();
}
return;
}
// If editable did not have focus, fix the selection when it is first focused.
if ( !this.hasFocus ) {
this.once( 'focus', function() {
fixSelection();
}, null, null, -999 );
// If editable had focus, fix the selection immediately.
} else {
this.focus();
fixSelection();
}
function fixSelection() {
var $doc = that.getDocument().$,
$sel = $doc.getSelection();
if ( requiresFix( $sel ) ) {
var range = new CKEDITOR.dom.range( that );
range.moveToElementEditStart( that );
var $range = $doc.createRange();
$range.setStart( range.startContainer.$, range.startOffset );
$range.collapse( true );
$sel.removeAllRanges();
$sel.addRange( $range );
}
}
function requiresFix( $sel ) {
// This condition covers most broken cases after setting data.
if ( $sel.anchorNode && $sel.anchorNode == that.$ ) {
return true;
}
// Fix for:
// http://tests.ckeditor.dev:1030/tests/core/selection/manual/focusaftersettingdata
// (the inline editor TC)
if ( CKEDITOR.env.webkit ) {
var active = that.getDocument().getActive();
if ( active && active.equals( that ) && !$sel.anchorNode ) {
return true;
}
}
}
function fixMSSelection() {
var $doc = that.getDocument().$,
$sel = $doc.selection,
active = that.getDocument().getActive();
if ( $sel.type == 'None' && active.equals( that ) ) {
var range = new CKEDITOR.dom.range( that ),
parentElement,
$range = $doc.body.createTextRange();
range.moveToElementEditStart( that );
parentElement = range.startContainer;
if ( parentElement.type != CKEDITOR.NODE_ELEMENT ) {
parentElement = parentElement.getParent();
}
$range.moveToElementText( parentElement.$ );
$range.collapse( true );
$range.select();
}
}
},
/**
* A base of the {@link CKEDITOR.editor#getSelectedHtml} method.
*
* @since 4.5
* @method getHtmlFromRange
* @param {CKEDITOR.dom.range} range
* @returns {CKEDITOR.dom.documentFragment}
*/
getHtmlFromRange: function( range ) {
// There's nothing to return if range is collapsed.
if ( range.collapsed )
return new CKEDITOR.dom.documentFragment( range.document );
// Info object passed between methods.
var that = {
doc: this.getDocument(),
// Leave original range object untouched.
range: range.clone()
};
getHtmlFromRangeHelpers.eol.detect( that, this );
getHtmlFromRangeHelpers.bogus.exclude( that );
getHtmlFromRangeHelpers.cell.shrink( that );
that.fragment = that.range.cloneContents();
getHtmlFromRangeHelpers.tree.rebuild( that, this );
getHtmlFromRangeHelpers.eol.fix( that, this );
return new CKEDITOR.dom.documentFragment( that.fragment.$ );
},
/**
* A base of the {@link CKEDITOR.editor#extractSelectedHtml} method.
*
* **Note:** The range is modified so it matches desired selection after extraction.
* But the selection is not made.
*
* @since 4.5
* @param {CKEDITOR.dom.range} range
* @returns {CKEDITOR.dom.documentFragment}
*/
extractHtmlFromRange: function( range ) {
var helpers = extractHtmlFromRangeHelpers,
that = {
range: range,
doc: range.document
},
// Since it is quite hard to build a valid documentFragment
// out of extracted contents because DOM changes, let's mimic
// extracted HTML with #getHtmlFromRange. Yep. It's a hack.
extractedFragment = this.getHtmlFromRange( range );
// Collapsed range means that there's nothing to extract.
if ( range.collapsed ) {
range.optimize();
return extractedFragment;
}
// Include inline element if possible.
range.enlarge( CKEDITOR.ENLARGE_INLINE, 1 );
// This got to be done before bookmarks are created because purging
// depends on the position of the range at the boundaries of the table,
// usually distorted by bookmark spans.
helpers.table.detectPurge( that );
// We'll play with DOM, let's hold the position of the range.
that.bookmark = range.createBookmark();
// While bookmarked, make unaccessible, to make sure that none of the methods
// will try to use it (they should use that.bookmark).
// This is done because ranges get desynchronized with the DOM when more bookmarks
// is created (as for instance that.targetBookmark).
delete that.range;
// The range to be restored after extraction should be kept
// outside of the range, so it's not removed by range.extractContents.
var targetRange = this.editor.createRange();
targetRange.moveToPosition( that.bookmark.startNode, CKEDITOR.POSITION_BEFORE_START );
that.targetBookmark = targetRange.createBookmark();
// Execute content-specific detections.
helpers.list.detectMerge( that, this );
helpers.table.detectRanges( that, this );
helpers.block.detectMerge( that, this );
// Simply, do the job.
if ( that.tableContentsRanges ) {
helpers.table.deleteRanges( that );
// Done here only to remove bookmark's spans.
range.moveToBookmark( that.bookmark );
that.range = range;
} else {
// To use the range we need to restore the bookmark and make
// the range accessible again.
range.moveToBookmark( that.bookmark );
that.range = range;
range.extractContents( helpers.detectExtractMerge( that ) );
}
// Move working range to desired, pre-computed position.
range.moveToBookmark( that.targetBookmark );
// Make sure range is always anchored in an element. For consistency.
range.optimize();
// It my happen that the uncollapsed range which referred to a valid selection,
// will be placed in an uneditable location after being collapsed:
// <tr>[<td>x</td>]</tr> -> <tr>[]<td>x</td></tr> -> <tr><td>[]x</td></tr>
helpers.fixUneditableRangePosition( range );
// Execute content-specific post-extract routines.
helpers.list.merge( that, this );
helpers.table.purge( that, this );
helpers.block.merge( that, this );
// Auto paragraph, if needed.
helpers.autoParagraph( this.editor, range );
// Let's have a bogus next to the caret, if needed.
if ( isEmpty( range.startContainer ) )
range.startContainer.appendBogus();
// Merge inline siblings if any around the caret.
range.startContainer.mergeSiblings( 1 );
return extractedFragment;
},
/**
* Editable element bootstrapping.
*
* @private
*/
setup: function() {
var editor = this.editor;
// Handle the load/read of editor data/snapshot.
this.attachListener( editor, 'beforeGetData', function() {
var data = this.getData();
// Post processing html output of wysiwyg editable.
if ( !this.is( 'textarea' ) ) {
// Reset empty if the document contains only one empty paragraph.
if ( editor.config.ignoreEmptyParagraph !== false )
data = data.replace( emptyParagraphRegexp, function( match, lookback ) {
return lookback;
} );
}
editor.setData( data, null, 1 );
}, this );
this.attachListener( editor, 'getSnapshot', function( evt ) {
evt.data = this.getData( 1 );
}, this );
this.attachListener( editor, 'afterSetData', function() {
this.setData( editor.getData( 1 ) );
}, this );
this.attachListener( editor, 'loadSnapshot', function( evt ) {
this.setData( evt.data, 1 );
}, this );
// Delegate editor focus/blur to editable.
this.attachListener( editor, 'beforeFocus', function() {
var sel = editor.getSelection(),
ieSel = sel && sel.getNative();
// IE considers control-type element as separate
// focus host when selected, avoid destroying the
// selection in such case. (#5812) (#8949)
if ( ieSel && ieSel.type == 'Control' )
return;
this.focus();
}, this );
this.attachListener( editor, 'insertHtml', function( evt ) {
this.insertHtml( evt.data.dataValue, evt.data.mode );
}, this );
this.attachListener( editor, 'insertElement', function( evt ) {
this.insertElement( evt.data );
}, this );
this.attachListener( editor, 'insertText', function( evt ) {
this.insertText( evt.data );
}, this );
// Update editable state.
this.setReadOnly( editor.readOnly );
// The editable class.
this.attachClass( 'cke_editable' );
// The element mode css class.
if ( editor.elementMode == CKEDITOR.ELEMENT_MODE_INLINE ) {
this.attachClass( 'cke_editable_inline' );
} else if ( editor.elementMode == CKEDITOR.ELEMENT_MODE_REPLACE ||
editor.elementMode == CKEDITOR.ELEMENT_MODE_APPENDTO ) {
this.attachClass( 'cke_editable_themed' );
}
this.attachClass( 'cke_contents_' + editor.config.contentsLangDirection );
// Setup editor keystroke handlers on this element.
var keystrokeHandler = editor.keystrokeHandler;
// If editor is read-only, then make sure that BACKSPACE key
// is blocked to prevent browser history navigation.
keystrokeHandler.blockedKeystrokes[ 8 ] = +editor.readOnly;
editor.keystrokeHandler.attach( this );
// Update focus states.
this.on( 'blur', function() {
this.hasFocus = false;
}, null, null, -1 );
this.on( 'focus', function() {
this.hasFocus = true;
}, null, null, -1 );
// Register to focus manager.
editor.focusManager.add( this );
// Inherit the initial focus on editable element.
if ( this.equals( CKEDITOR.document.getActive() ) ) {
this.hasFocus = true;
// Pending until this editable has attached.
editor.once( 'contentDom', function() {
editor.focusManager.focus( this );
}, this );
}
// Apply tab index on demand, with original direction saved.
if ( this.isInline() ) {
// tabIndex of the editable is different than editor's one.
// Update the attribute of the editable.
this.changeAttr( 'tabindex', editor.tabIndex );
}
// The above is all we'll be doing for a <textarea> editable.
if ( this.is( 'textarea' ) )
return;
// The DOM document which the editing acts upon.
editor.document = this.getDocument();
editor.window = this.getWindow();
var doc = editor.document;
this.changeAttr( 'spellcheck', !editor.config.disableNativeSpellChecker );
// Apply contents direction on demand, with original direction saved.
var dir = editor.config.contentsLangDirection;
if ( this.getDirection( 1 ) != dir )
this.changeAttr( 'dir', dir );
// Create the content stylesheet for this document.
var styles = CKEDITOR.getCss();
if ( styles ) {
var head = doc.getHead();
if ( !head.getCustomData( 'stylesheet' ) ) {
var sheet = doc.appendStyleText( styles );
sheet = new CKEDITOR.dom.element( sheet.ownerNode || sheet.owningElement );
head.setCustomData( 'stylesheet', sheet );
sheet.data( 'cke-temp', 1 );
}
}
// Update the stylesheet sharing count.
var ref = doc.getCustomData( 'stylesheet_ref' ) || 0;
doc.setCustomData( 'stylesheet_ref', ref + 1 );
// Pass this configuration to styles system.
this.setCustomData( 'cke_includeReadonly', !editor.config.disableReadonlyStyling );
// Prevent the browser opening read-only links. (#6032 & #10912)
this.attachListener( this, 'click', function( evt ) {
evt = evt.data;
var link = new CKEDITOR.dom.elementPath( evt.getTarget(), this ).contains( 'a' );
if ( link && evt.$.button != 2 && link.isReadOnly() )
evt.preventDefault();
} );
var backspaceOrDelete = { 8: 1, 46: 1 };
// Override keystrokes which should have deletion behavior
// on fully selected element . (#4047) (#7645)
this.attachListener( editor, 'key', function( evt ) {
if ( editor.readOnly )
return true;
// Use getKey directly in order to ignore modifiers.
// Justification: http://dev.ckeditor.com/ticket/11861#comment:13
var keyCode = evt.data.domEvent.getKey(),
isHandled;
// Backspace OR Delete.
if ( keyCode in backspaceOrDelete ) {
var sel = editor.getSelection(),
selected,
range = sel.getRanges()[ 0 ],
path = range.startPath(),
block,
parent,
next,
rtl = keyCode == 8;
if (
// [IE<11] Remove selected image/anchor/etc here to avoid going back in history. (#10055)
( CKEDITOR.env.ie && CKEDITOR.env.version < 11 && ( selected = sel.getSelectedElement() ) ) ||
// Remove the entire list/table on fully selected content. (#7645)
( selected = getSelectedTableList( sel ) ) ) {
// Make undo snapshot.
editor.fire( 'saveSnapshot' );
// Delete any element that 'hasLayout' (e.g. hr,table) in IE8 will
// break up the selection, safely manage it here. (#4795)
range.moveToPosition( selected, CKEDITOR.POSITION_BEFORE_START );
// Remove the control manually.
selected.remove();
range.select();
editor.fire( 'saveSnapshot' );
isHandled = 1;
} else if ( range.collapsed ) {
// Handle the following special cases: (#6217)
// 1. Del/Backspace key before/after table;
// 2. Backspace Key after start of table.
if ( ( block = path.block ) &&
( next = block[ rtl ? 'getPrevious' : 'getNext' ]( isNotWhitespace ) ) &&
( next.type == CKEDITOR.NODE_ELEMENT ) &&
next.is( 'table' ) &&
range[ rtl ? 'checkStartOfBlock' : 'checkEndOfBlock' ]() ) {
editor.fire( 'saveSnapshot' );
// Remove the current empty block.
if ( range[ rtl ? 'checkEndOfBlock' : 'checkStartOfBlock' ]() )
block.remove();
// Move cursor to the beginning/end of table cell.
range[ 'moveToElementEdit' + ( rtl ? 'End' : 'Start' ) ]( next );
range.select();
editor.fire( 'saveSnapshot' );
isHandled = 1;
}
else if ( path.blockLimit && path.blockLimit.is( 'td' ) &&
( parent = path.blockLimit.getAscendant( 'table' ) ) &&
range.checkBoundaryOfElement( parent, rtl ? CKEDITOR.START : CKEDITOR.END ) &&
( next = parent[ rtl ? 'getPrevious' : 'getNext' ]( isNotWhitespace ) ) ) {
editor.fire( 'saveSnapshot' );
// Move cursor to the end of previous block.
range[ 'moveToElementEdit' + ( rtl ? 'End' : 'Start' ) ]( next );
// Remove any previous empty block.
if ( range.checkStartOfBlock() && range.checkEndOfBlock() )
next.remove();
else
range.select();
editor.fire( 'saveSnapshot' );
isHandled = 1;
}
// BACKSPACE/DEL pressed at the start/end of table cell.
else if ( ( parent = path.contains( [ 'td', 'th', 'caption' ] ) ) &&
range.checkBoundaryOfElement( parent, rtl ? CKEDITOR.START : CKEDITOR.END ) ) {
isHandled = 1;
}