-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
selection.js
2574 lines (2138 loc) · 85.7 KB
/
selection.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-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
( function() {
var isMSSelection = typeof window.getSelection != 'function',
nextRev = 1,
// https://dev.ckeditor.com/ticket/13816
fillingCharSequence = CKEDITOR.tools.repeat( '\u200b', 7 ),
fillingCharSequenceRegExp = new RegExp( fillingCharSequence + '( )?', 'g' ),
isSelectingTable;
function isWidget( element ) {
return CKEDITOR.plugins.widget && CKEDITOR.plugins.widget.isDomWidget( element );
}
// #### table selection : START
// @param {CKEDITOR.dom.range[]} ranges
// @param {Boolean} allowPartially Whether a collapsed selection within a table is recognized to be a valid selection.
// This happens for WebKit browsers on MacOS when you right-click inside the table.
function isTableSelection( ranges, allowPartially ) {
if ( ranges.length === 0 ) {
return false;
}
// It's not table selection when selected node is a widget (#1027).
if ( isWidget( ranges[ 0 ].getEnclosedNode() ) ) {
return false;
}
var node,
i;
function isPartiallySelected( range ) {
var startCell = range.startContainer.getAscendant( { td: 1, th: 1 }, true ),
endCell = range.endContainer.getAscendant( { td: 1, th: 1 }, true ),
trim = CKEDITOR.tools.trim,
selected;
// Check if the selection is inside one cell and we don't have any nested table contents selected.
if ( !startCell || !startCell.equals( endCell ) || startCell.findOne( 'td, th, tr, tbody, table' ) ) {
return false;
}
selected = range.cloneContents();
// Empty selection is still partially selected.
if ( !selected.getFirst() ) {
return true;
}
return trim( selected.getFirst().getText() ) !== trim( startCell.getText() );
}
// Edge case: partially selected text node inside one table cell or cursor inside cell.
if ( !allowPartially && ranges.length === 1 &&
( ranges[ 0 ].collapsed || isPartiallySelected( ranges[ 0 ] ) ) ) {
return false;
}
for ( i = 0; i < ranges.length; i++ ) {
node = ranges[ i ]._getTableElement();
if ( !node ) {
return false;
}
}
return true;
}
// After performing fake table selection, the real selection is limited
// to the first selected cell. Therefore to check if the real selection
// matches the fake selection, we check if the table cell from fake selection's
// first range and real selection's range are the same.
// Also if the selection is collapsed, we should check if it's placed inside the table
// in which the fake selection is or inside nested table. Such selection occurs after right mouse click.
function isRealTableSelection( selection, fakeSelection ) {
var ranges = selection.getRanges(),
fakeRanges = fakeSelection.getRanges(),
table = ranges.length && ranges[ 0 ]._getTableElement() &&
ranges[ 0 ]._getTableElement().getAscendant( 'table', true ),
fakeTable = fakeRanges.length && fakeRanges[ 0 ]._getTableElement() &&
fakeRanges[ 0 ]._getTableElement().getAscendant( 'table', true ),
isTableRange = ranges.length === 1 && ranges[ 0 ]._getTableElement() &&
ranges[ 0 ]._getTableElement().is( 'table' ),
isFakeTableRange = fakeRanges.length === 1 && fakeRanges[ 0 ]._getTableElement() &&
fakeRanges[ 0 ]._getTableElement().is( 'table' );
function isValidTableSelection( table, fakeTable, ranges, fakeRanges ) {
var isMenuOpen = ranges.length === 1 && ranges[ 0 ].collapsed,
// In case of WebKit on MacOS, when checking real selection, we must allow selection to be partial.
// Otherwise the check will fail for table selection with opened context menu.
isInTable = isTableSelection( ranges, !!CKEDITOR.env.webkit ) && isTableSelection( fakeRanges );
return isSameTable( table, fakeTable ) && ( isMenuOpen || isInTable );
}
function isSameTable( table, fakeTable ) {
if ( !table || !fakeTable ) {
return false;
}
return table.equals( fakeTable ) || fakeTable.contains( table );
}
// When widget is selected, then definitely it's not a table (#1027).
if ( isWidget( fakeSelection.getSelectedElement() ) ) {
return false;
}
if ( isValidTableSelection( table, fakeTable, ranges, fakeRanges ) ) {
// Edge case: when editor contains only table and that table is selected using selectAll command,
// then the selection is not properly refreshed and it must be done manually.
if ( isTableRange && !isFakeTableRange ) {
fakeSelection.selectRanges( ranges );
}
return true;
}
return false;
}
function getSelectedCells( ranges ) {
var cells = [],
node,
i;
function getCellsFromElement( element ) {
var cells = element.find( 'td, th' ),
cellsArray = [],
i;
for ( i = 0; i < cells.count(); i++ ) {
cellsArray.push( cells.getItem( i ) );
}
return cellsArray;
}
for ( i = 0; i < ranges.length; i++ ) {
node = ranges[ i ]._getTableElement();
if ( node.is && node.is( { td: 1, th: 1 } ) ) {
cells.push( node );
} else {
cells = cells.concat( getCellsFromElement( node ) );
}
}
return cells;
}
// Cells in the same row are separated by tab and the rows are separated by new line, e.g.
// Cell 1.1 Cell 1.2
// Cell 2.1 Cell 2.2
function getTextFromSelectedCells( ranges ) {
var cells = getSelectedCells( ranges ),
txt = '',
currentRow = [],
lastRow,
i;
for ( i = 0; i < cells.length; i++ ) {
if ( lastRow && !lastRow.equals( cells[ i ].getAscendant( 'tr' ) ) ) {
txt += currentRow.join( '\t' ) + '\n';
lastRow = cells[ i ].getAscendant( 'tr' );
currentRow = [];
} else if ( i === 0 ) {
lastRow = cells[ i ].getAscendant( 'tr' );
}
currentRow.push( cells[ i ].getText() );
}
txt += currentRow.join( '\t' );
return txt;
}
function performFakeTableSelection( ranges ) {
var editor = this.root.editor,
realSelection = editor.getSelection( 1 ),
cache;
// Cleanup after previous selection - e.g. remove hidden sel container.
this.reset();
// Indicate that the table is being fake-selected to prevent infinite loop
// inside `selectRanges`.
isSelectingTable = true;
// Cancel selectionchange for the real selection.
realSelection.root.once( 'selectionchange', function( evt ) {
evt.cancel();
}, null, null, 0 );
// Move real selection to the first selected range.
realSelection.selectRanges( [ ranges[ 0 ] ] );
cache = this._.cache;
// Caches given ranges.
cache.ranges = new CKEDITOR.dom.rangeList( ranges );
cache.type = CKEDITOR.SELECTION_TEXT;
cache.selectedElement = ranges[ 0 ]._getTableElement();
// `selectedText` should contain text from all selected data ("plain text table")
// to be compatible with Firefox's implementation.
cache.selectedText = getTextFromSelectedCells( ranges );
// Properties that will not be available when isFake.
cache.nativeSel = null;
this.isFake = 1;
this.rev = nextRev++;
// Save this selection, so it can be returned by editor.getSelection().
editor._.fakeSelection = this;
isSelectingTable = false;
// Fire selectionchange, just like a normal selection.
this.root.fire( 'selectionchange' );
}
// #### table selection : END
// #### checkSelectionChange : START
// The selection change check basically saves the element parent tree of
// the current node and check it on successive requests. If there is any
// change on the tree, then the selectionChange event gets fired.
function checkSelectionChange() {
// A possibly available fake-selection.
var sel = this._.fakeSelection,
realSel;
if ( sel ) {
realSel = this.getSelection( 1 );
// If real (not locked/stored) selection was moved from hidden container
// or is not a table one, then the fake-selection must be invalidated.
if ( !realSel || ( !realSel.isHidden() && !isRealTableSelection( realSel, sel ) ) ) {
// Remove the cache from fake-selection references in use elsewhere.
sel.reset();
// Have the code using the native selection.
sel = 0;
}
}
// If not fake-selection is available then get the native selection.
if ( !sel ) {
sel = realSel || this.getSelection( 1 );
// Editor may have no selection at all.
if ( !sel || sel.getType() == CKEDITOR.SELECTION_NONE )
return;
}
this.fire( 'selectionCheck', sel );
var currentPath = this.elementPath();
if ( !currentPath.compare( this._.selectionPreviousPath ) ) {
// Handle case when dialog inserts new element but parent block and path (so also focus context) does not change. (https://dev.ckeditor.com/ticket/13362)
var sameBlockParent = this._.selectionPreviousPath && this._.selectionPreviousPath.blockLimit.equals( currentPath.blockLimit );
// Cache the active element, which we'll eventually lose on Webkit and Gecko (#1113).
if ( ( CKEDITOR.env.webkit || CKEDITOR.env.gecko ) && !sameBlockParent ) {
this._.previousActive = this.document.getActive();
}
this._.selectionPreviousPath = currentPath;
this.fire( 'selectionChange', { selection: sel, path: currentPath } );
}
}
var checkSelectionChangeTimer, checkSelectionChangeTimeoutPending;
function checkSelectionChangeTimeout() {
// Firing the "OnSelectionChange" event on every key press started to
// be too slow. This function guarantees that there will be at least
// 200ms delay between selection checks.
checkSelectionChangeTimeoutPending = true;
if ( checkSelectionChangeTimer )
return;
checkSelectionChangeTimeoutExec.call( this );
checkSelectionChangeTimer = CKEDITOR.tools.setTimeout( checkSelectionChangeTimeoutExec, 200, this );
}
function checkSelectionChangeTimeoutExec() {
checkSelectionChangeTimer = null;
if ( checkSelectionChangeTimeoutPending ) {
// Call this with a timeout so the browser properly moves the
// selection after the mouseup. It happened that the selection was
// being moved after the mouseup when clicking inside selected text
// with Firefox.
CKEDITOR.tools.setTimeout( checkSelectionChange, 0, this );
checkSelectionChangeTimeoutPending = false;
}
}
// #### checkSelectionChange : END
var isVisible = CKEDITOR.dom.walker.invisible( 1 );
// May absorb the caret if:
// * is a visible node,
// * is a non-empty element (this rule will accept elements like <strong></strong> because they
// they were not accepted by the isVisible() check, not not <br> which cannot absorb the caret).
// See https://dev.ckeditor.com/ticket/12621.
function mayAbsorbCaret( node ) {
if ( isVisible( node ) )
return true;
if ( node.type == CKEDITOR.NODE_ELEMENT && !node.is( CKEDITOR.dtd.$empty ) )
return true;
return false;
}
function rangeRequiresFix( range ) {
// Whether we must prevent from absorbing caret by this context node.
// Also checks whether there's an editable position next to that node.
function ctxRequiresFix( node, isAtEnd ) {
// It's ok for us if a text node absorbs the caret, because
// the caret container element isn't changed then.
if ( !node || node.type == CKEDITOR.NODE_TEXT )
return false;
var testRng = range.clone();
return testRng[ 'moveToElementEdit' + ( isAtEnd ? 'End' : 'Start' ) ]( node );
}
// Range root must be the editable element, it's to avoid creating filler char
// on any temporary internal selection.
if ( !( range.root instanceof CKEDITOR.editable ) )
return false;
var ct = range.startContainer;
var previous = range.getPreviousNode( mayAbsorbCaret, null, ct ),
next = range.getNextNode( mayAbsorbCaret, null, ct );
// Any adjacent text container may absorb the caret, e.g.
// <p><strong>text</strong>^foo</p>
// <p>foo^<strong>text</strong></p>
// <div>^<p>foo</p></div>
if ( ctxRequiresFix( previous ) || ctxRequiresFix( next, 1 ) )
return true;
// Empty block/inline element is also affected. <span>^</span>, <p>^</p> (https://dev.ckeditor.com/ticket/7222)
// If you found this line confusing check https://dev.ckeditor.com/ticket/12655.
if ( !( previous || next ) && !( ct.type == CKEDITOR.NODE_ELEMENT && ct.isBlockBoundary() && ct.getBogus() ) )
return true;
return false;
}
function createFillingCharSequenceNode( editable ) {
removeFillingCharSequenceNode( editable, false );
var fillingChar = editable.getDocument().createText( fillingCharSequence );
editable.setCustomData( 'cke-fillingChar', fillingChar );
return fillingChar;
}
// Checks if a filling char has been used, eventually removing it (https://dev.ckeditor.com/ticket/1272).
function checkFillingCharSequenceNodeReady( editable ) {
var fillingChar = editable.getCustomData( 'cke-fillingChar' );
if ( fillingChar ) {
// Use this flag to avoid removing the filling char right after
// creating it.
if ( fillingChar.getCustomData( 'ready' ) ) {
removeFillingCharSequenceNode( editable );
editable.editor.fire( 'selectionCheck' );
} else {
fillingChar.setCustomData( 'ready', 1 );
}
}
}
function removeFillingCharSequenceNode( editable, keepSelection ) {
var fillingChar = editable && editable.removeCustomData( 'cke-fillingChar' );
if ( fillingChar ) {
// Text selection position might get mangled by
// subsequent dom modification, save it now for restoring. (https://dev.ckeditor.com/ticket/8617)
if ( keepSelection !== false ) {
var sel = editable.getDocument().getSelection().getNative(),
// Be error proof.
range = sel && sel.type != 'None' && sel.getRangeAt( 0 ),
fillingCharSeqLength = fillingCharSequence.length;
// If there's some text other than the sequence in the FC text node and the range
// intersects with that node...
if ( fillingChar.getLength() > fillingCharSeqLength && range && range.intersectsNode( fillingChar.$ ) ) {
var bm = createNativeSelectionBookmark( sel );
// Correct start offset anticipating the removal of FC.
if ( sel.anchorNode == fillingChar.$ && sel.anchorOffset > fillingCharSeqLength ) {
bm[ 0 ].offset -= fillingCharSeqLength;
}
// Correct end offset anticipating the removal of FC.
if ( sel.focusNode == fillingChar.$ && sel.focusOffset > fillingCharSeqLength ) {
bm[ 1 ].offset -= fillingCharSeqLength;
}
}
}
// We can't simply remove the filling node because the user
// will actually enlarge it when typing, so we just remove the
// invisible char from it.
fillingChar.setText( removeFillingCharSequenceString( fillingChar.getText(), 1 ) );
// Restore the bookmark preserving selection's direction.
if ( bm ) {
moveNativeSelectionToBookmark( editable.getDocument().$, bm );
}
}
}
// https://dev.ckeditor.com/ticket/13816
function removeFillingCharSequenceString( str, nbspAware ) {
if ( nbspAware ) {
return str.replace( fillingCharSequenceRegExp, function( m, p ) {
// https://dev.ckeditor.com/ticket/10291 if filling char is followed by a space replace it with NBSP.
return p ? '\xa0' : '';
} );
} else {
return str.replace( fillingCharSequence, '' );
}
}
function createNativeSelectionBookmark( sel ) {
return [
{ node: sel.anchorNode, offset: sel.anchorOffset },
{ node: sel.focusNode, offset: sel.focusOffset }
];
}
function moveNativeSelectionToBookmark( document, bm ) {
var sel = document.getSelection(),
range = document.createRange();
range.setStart( bm[ 0 ].node, bm[ 0 ].offset );
range.collapse( true );
sel.removeAllRanges();
sel.addRange( range );
sel.extend( bm[ 1 ].node, bm[ 1 ].offset );
}
// Creates cke_hidden_sel container and puts real selection there.
function hideSelection( editor, ariaLabel ) {
var content = ariaLabel && CKEDITOR.tools.htmlEncode( ariaLabel ) || ' ',
style = CKEDITOR.env.ie && CKEDITOR.env.version < 14 ? 'display:none' : 'position:fixed;top:0;left:-1000px;width:0;height:0;overflow:hidden;',
hiddenEl = CKEDITOR.dom.element.createFromHtml(
'<div data-cke-hidden-sel="1" data-cke-temp="1" style="' + style + '">' + content + '</div>',
editor.document );
editor.fire( 'lockSnapshot' );
editor.editable().append( hiddenEl );
// Always use real selection to avoid overriding locked one (https://dev.ckeditor.com/ticket/11104#comment:13).
var sel = editor.getSelection( 1 ),
range = editor.createRange(),
// Cancel selectionchange fired by selectRanges - prevent from firing selectionChange.
listener = sel.root.on( 'selectionchange', function( evt ) {
evt.cancel();
}, null, null, 0 );
range.setStartAt( hiddenEl, CKEDITOR.POSITION_AFTER_START );
range.setEndAt( hiddenEl, CKEDITOR.POSITION_BEFORE_END );
sel.selectRanges( [ range ] );
listener.removeListener();
editor.fire( 'unlockSnapshot' );
// Set this value at the end, so reset() executed by selectRanges()
// will clean up old hidden selection container.
editor._.hiddenSelectionContainer = hiddenEl;
}
function removeHiddenSelectionContainer( editor ) {
var hiddenEl = editor._.hiddenSelectionContainer;
if ( hiddenEl ) {
var isDirty = editor.checkDirty();
editor.fire( 'lockSnapshot' );
hiddenEl.remove();
editor.fire( 'unlockSnapshot' );
!isDirty && editor.resetDirty();
}
delete editor._.hiddenSelectionContainer;
}
// Object containing keystroke handlers for fake selection.
var fakeSelectionDefaultKeystrokeHandlers = ( function() {
function leave( right ) {
return function( evt ) {
var range = evt.editor.createRange();
// Move selection only if there's a editable place for it.
// It no, then do nothing (keystroke will be blocked, widget selection kept).
if ( range.moveToClosestEditablePosition( evt.selected, right ) )
evt.editor.getSelection().selectRanges( [ range ] );
// Prevent default.
return false;
};
}
function del( right ) {
return function( evt ) {
var editor = evt.editor,
range = editor.createRange(),
found;
// We have to skip deletion for read only editor (#1516).
if ( editor.readOnly ) {
return;
}
// If haven't found place for caret on the default side,
// try to find it on the other side.
if ( !( found = range.moveToClosestEditablePosition( evt.selected, right ) ) )
found = range.moveToClosestEditablePosition( evt.selected, !right );
if ( found )
editor.getSelection().selectRanges( [ range ] );
// Save the state before removing selected element.
editor.fire( 'saveSnapshot' );
evt.selected.remove();
// Haven't found any editable space before removing element,
// try to place the caret anywhere (most likely, in empty editable).
if ( !found ) {
range.moveToElementEditablePosition( editor.editable() );
editor.getSelection().selectRanges( [ range ] );
}
editor.fire( 'saveSnapshot' );
// Prevent default.
return false;
};
}
var leaveLeft = leave(),
leaveRight = leave( 1 );
return {
37: leaveLeft, // LEFT
38: leaveLeft, // UP
39: leaveRight, // RIGHT
40: leaveRight, // DOWN
8: del(), // BACKSPACE
46: del( 1 ) // DELETE
};
} )();
// Handle left, right, delete and backspace keystrokes next to non-editable elements
// by faking selection on them.
function getOnKeyDownListener( editor ) {
var keystrokes = { 37: 1, 39: 1, 8: 1, 46: 1 };
return function( evt ) {
var keystroke = evt.data.getKeystroke();
// Handle only left/right/del/bspace keys.
if ( !keystrokes[ keystroke ] )
return;
var sel = editor.getSelection(),
ranges = sel.getRanges(),
range = ranges[ 0 ];
// Handle only single range and it has to be collapsed.
if ( ranges.length != 1 || !range.collapsed )
return;
var next = range[ keystroke < 38 ? 'getPreviousEditableNode' : 'getNextEditableNode' ]();
if ( next && next.type == CKEDITOR.NODE_ELEMENT && next.getAttribute( 'contenteditable' ) == 'false' ) {
editor.getSelection().fake( next );
evt.data.preventDefault();
evt.cancel();
}
};
}
// If fake selection should be applied this function will return instance of
// CKEDITOR.dom.element which should gain fake selection.
function getNonEditableFakeSelectionReceiver( ranges ) {
var enclosedNode, shrinkedNode, clone, range;
if ( ranges.length == 1 && !( range = ranges[ 0 ] ).collapsed &&
( enclosedNode = range.getEnclosedNode() ) && enclosedNode.type == CKEDITOR.NODE_ELEMENT ) {
// So far we can't say that enclosed element is non-editable. Before checking,
// we'll shrink range (clone). Shrinking will stop on non-editable range, or
// innermost element (https://dev.ckeditor.com/ticket/11114).
clone = range.clone();
clone.shrink( CKEDITOR.SHRINK_ELEMENT, true );
// If shrinked range still encloses an element, check this one (shrink stops only on non-editable elements).
if ( ( shrinkedNode = clone.getEnclosedNode() ) && shrinkedNode.type == CKEDITOR.NODE_ELEMENT )
enclosedNode = shrinkedNode;
if ( enclosedNode.getAttribute( 'contenteditable' ) == 'false' )
return enclosedNode;
}
}
// Fix ranges which may end after hidden selection container.
// Note: this function may only be used if hidden selection container
// is not in DOM any more.
function fixRangesAfterHiddenSelectionContainer( ranges, root ) {
var range;
for ( var i = 0; i < ranges.length; ++i ) {
range = ranges[ i ];
if ( range.endContainer.equals( root ) ) {
// We can use getChildCount() because hidden selection container is not in DOM.
range.endOffset = Math.min( range.endOffset, root.getChildCount() );
}
}
}
// Extract only editable part or ranges.
// Note: this function modifies ranges list!
// @param {CKEDITOR.dom.rangeList} ranges
function extractEditableRanges( ranges ) {
for ( var i = 0; i < ranges.length; i++ ) {
var range = ranges[ i ];
// Drop range spans inside one ready-only node.
var parent = range.getCommonAncestor();
if ( parent.isReadOnly() )
ranges.splice( i, 1 );
if ( range.collapsed )
continue;
// Range may start inside a non-editable element,
// replace the range start after it.
if ( range.startContainer.isReadOnly() ) {
var current = range.startContainer,
isElement;
while ( current ) {
isElement = current.type == CKEDITOR.NODE_ELEMENT;
if ( ( isElement && current.is( 'body' ) ) || !current.isReadOnly() )
break;
if ( isElement && current.getAttribute( 'contentEditable' ) == 'false' )
range.setStartAfter( current );
current = current.getParent();
}
}
var startContainer = range.startContainer,
endContainer = range.endContainer,
startOffset = range.startOffset,
endOffset = range.endOffset,
walkerRange = range.clone();
// Enlarge range start/end with text node to avoid walker
// being DOM destructive, it doesn't interfere our checking
// of elements below as well.
if ( startContainer && startContainer.type == CKEDITOR.NODE_TEXT ) {
if ( startOffset >= startContainer.getLength() )
walkerRange.setStartAfter( startContainer );
else
walkerRange.setStartBefore( startContainer );
}
if ( endContainer && endContainer.type == CKEDITOR.NODE_TEXT ) {
if ( !endOffset )
walkerRange.setEndBefore( endContainer );
else
walkerRange.setEndAfter( endContainer );
}
// Looking for non-editable element inside the range.
var walker = new CKEDITOR.dom.walker( walkerRange );
walker.evaluator = function( node ) {
if ( node.type == CKEDITOR.NODE_ELEMENT && node.isReadOnly() ) {
var newRange = range.clone();
range.setEndBefore( node );
// Drop collapsed range around read-only elements,
// it make sure the range list empty when selecting
// only non-editable elements.
if ( range.collapsed )
ranges.splice( i--, 1 );
// Avoid creating invalid range.
if ( !( node.getPosition( walkerRange.endContainer ) & CKEDITOR.POSITION_CONTAINS ) ) {
newRange.setStartAfter( node );
if ( !newRange.collapsed )
ranges.splice( i + 1, 0, newRange );
}
return true;
}
return false;
};
walker.next();
}
return ranges;
}
// Setup all editor instances for the necessary selection hooks.
CKEDITOR.on( 'instanceCreated', function( ev ) {
var editor = ev.editor;
editor.on( 'contentDom', function() {
var doc = editor.document,
outerDoc = CKEDITOR.document,
editable = editor.editable(),
body = doc.getBody(),
html = doc.getDocumentElement();
var isInline = editable.isInline();
var restoreSel,
lastSel;
// Give the editable an initial selection on first focus,
// put selection at a consistent position at the start
// of the contents. (https://dev.ckeditor.com/ticket/9507)
if ( CKEDITOR.env.gecko ) {
editable.attachListener( editable, 'focus', function( evt ) {
evt.removeListener();
if ( restoreSel !== 0 ) {
var nativ = editor.getSelection().getNative();
// Do it only if the native selection is at an unwanted
// place (at the very start of the editable). https://dev.ckeditor.com/ticket/10119
if ( nativ && nativ.isCollapsed && nativ.anchorNode == editable.$ ) {
var rng = editor.createRange();
rng.moveToElementEditStart( editable );
rng.select();
}
}
}, null, null, -2 );
}
// Plays the magic here to restore/save dom selection on editable focus/blur.
editable.attachListener( editable, CKEDITOR.env.webkit || CKEDITOR.env.gecko ? 'focusin' : 'focus' , function() {
// On Webkit&Gecko (#1113) we use focusin which is fired more often than focus - e.g. when moving from main editable
// to nested editable (or the opposite). Unlock selection all, but restore only when it was locked
// for the same active element, what will e.g. mean restoring after displaying dialog.
if ( restoreSel && ( CKEDITOR.env.webkit || CKEDITOR.env.gecko ) ) {
restoreSel = editor._.previousActive && editor._.previousActive.equals( doc.getActive() );
// On Webkit when editor uses divarea, native focus causes editable viewport to scroll
// to the top (when there is no active selection inside while focusing) so the scroll
// position should be restored after focusing back editable area. (https://dev.ckeditor.com/ticket/14659)
var requiresScrollFix = editor._.previousScrollTop != null && editor._.previousScrollTop != editable.$.scrollTop;
if ( CKEDITOR.env.webkit && restoreSel && requiresScrollFix ) {
editable.$.scrollTop = editor._.previousScrollTop;
}
}
editor.unlockSelection( restoreSel );
restoreSel = 0;
}, null, null, -1 );
// Disable selection restoring when clicking in.
editable.attachListener( editable, 'mousedown', function() {
restoreSel = 0;
} );
// Save a cloned version of current selection.
function saveSel() {
lastSel = new CKEDITOR.dom.selection( editor.getSelection() );
lastSel.lock();
}
// Browsers could loose the selection once the editable lost focus,
// in such case we need to reproduce it by saving a locked selection
// and restoring it upon focus gain.
// Firefox native selection is lost editor.focus is triggered by click (#3136).
if ( CKEDITOR.env.ie || CKEDITOR.env.gecko || isInline ) {
// For old IEs, we can retrieve the last correct DOM selection upon the "beforedeactivate" event.
// For the rest, a more frequent check is required for each selection change made.
if ( isMSSelection ) {
editable.attachListener( editable, 'beforedeactivate', saveSel, null, null, -1 );
} else {
editable.attachListener( editor, 'selectionCheck', saveSel, null, null, -1 );
}
// Lock the selection and mark it to be restored.
// On Webkit&Gecko (#1113) we use focusout which is fired more often than blur. I.e. it will also be
// fired when nested editable is blurred.
editable.attachListener( editable, CKEDITOR.env.webkit || CKEDITOR.env.gecko ? 'focusout' : 'blur', function() {
var isFakeOrSingleSelection = lastSel && ( lastSel.isFake || lastSel.getRanges().length < 2 );
// Ignore cases that doesn't produce issue in Firefox (#3136).
if ( CKEDITOR.env.gecko && !isInline && isFakeOrSingleSelection ) {
return;
}
editor.lockSelection( lastSel );
restoreSel = 1;
}, null, null, -1 );
// Disable selection restoring when clicking in.
editable.attachListener( editable, 'mousedown', function() {
restoreSel = 0;
} );
}
// The following selection-related fixes only apply to classic (`iframe`-based) editable.
if ( CKEDITOR.env.ie && !isInline ) {
var scroll;
editable.attachListener( editable, 'mousedown', function( evt ) {
// IE scrolls document to top on right mousedown
// when editor has no focus, remember this scroll
// position and revert it before context menu opens. (https://dev.ckeditor.com/ticket/5778)
if ( evt.data.$.button == 2 ) {
var sel = editor.document.getSelection();
if ( !sel || sel.getType() == CKEDITOR.SELECTION_NONE )
scroll = editor.window.getScrollPosition();
}
} );
editable.attachListener( editable, 'mouseup', function( evt ) {
// Restore recorded scroll position when needed on right mouseup.
if ( evt.data.$.button == 2 && scroll ) {
editor.document.$.documentElement.scrollLeft = scroll.x;
editor.document.$.documentElement.scrollTop = scroll.y;
}
scroll = null;
} );
// When content doc is in standards mode, IE doesn't focus the editor when
// clicking at the region below body (on html element) content, we emulate
// the normal behavior on old IEs. (https://dev.ckeditor.com/ticket/1659, https://dev.ckeditor.com/ticket/7932)
if ( doc.$.compatMode != 'BackCompat' ) {
if ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) {
var textRng,
startRng;
html.on( 'mousedown', function( evt ) {
evt = evt.data;
// Expand the text range along with mouse move.
function onHover( evt ) {
evt = evt.data.$;
if ( textRng ) {
// Read the current cursor.
var rngEnd = body.$.createTextRange();
moveRangeToPoint( rngEnd, evt.clientX, evt.clientY );
// Handle drag directions.
textRng.setEndPoint(
startRng.compareEndPoints( 'StartToStart', rngEnd ) < 0 ?
'EndToEnd' : 'StartToStart', rngEnd );
// Update selection with new range.
textRng.select();
}
}
function removeListeners() {
outerDoc.removeListener( 'mouseup', onSelectEnd );
html.removeListener( 'mouseup', onSelectEnd );
}
function onSelectEnd() {
html.removeListener( 'mousemove', onHover );
removeListeners();
// Make it in effect on mouse up. (https://dev.ckeditor.com/ticket/9022)
textRng.select();
}
// We're sure that the click happens at the region
// below body, but not on scrollbar.
if ( evt.getTarget().is( 'html' ) &&
evt.$.y < html.$.clientHeight &&
evt.$.x < html.$.clientWidth ) {
// Start to build the text range.
textRng = body.$.createTextRange();
moveRangeToPoint( textRng, evt.$.clientX, evt.$.clientY );
// Records the dragging start of the above text range.
startRng = textRng.duplicate();
html.on( 'mousemove', onHover );
outerDoc.on( 'mouseup', onSelectEnd );
html.on( 'mouseup', onSelectEnd );
}
} );
}
// It's much simpler for IE8+, we just need to reselect the reported range.
// This hack does not work on IE>=11 because there's no old selection&range APIs.
if ( CKEDITOR.env.version > 7 && CKEDITOR.env.version < 11 ) {
html.on( 'mousedown', function( evt ) {
if ( evt.data.getTarget().is( 'html' ) ) {
// Limit the text selection mouse move inside of editable. (https://dev.ckeditor.com/ticket/9715)
outerDoc.on( 'mouseup', onSelectEnd );
html.on( 'mouseup', onSelectEnd );
}
} );
}
}
}
// We check the selection change:
// 1. Upon "selectionchange" event from the editable element. (which might be faked event fired by our code)
// 2. After the accomplish of keyboard, mouse and touch (#2276) events.
editable.attachListener( editable, 'selectionchange', checkSelectionChange, editor );
editable.attachListener( editable, 'keyup', checkSelectionChangeTimeout, editor );
editable.attachListener( editable, 'touchstart', checkSelectionChangeTimeout, editor );
editable.attachListener( editable, 'touchend', checkSelectionChangeTimeout, editor );
if ( CKEDITOR.env.ie ) {
// https://dev.ckeditor.com/ticket/14407 - Don't even let anything happen if the selection is in a non-editable element.
editable.attachListener( editable, 'keydown', disableSelectionChangeForNonEditables, editor );
}
// Always fire the selection change on focus gain.
// On Webkit&Gecko (#1113) do this on focusin, because the selection is unlocked on it too and
// we need synchronization between those listeners to not lost cached editor._.previousActive property
// (which is updated on selectionCheck).
editable.attachListener( editable, CKEDITOR.env.webkit || CKEDITOR.env.gecko ? 'focusin' : 'focus', function() {
editor.forceNextSelectionCheck();
editor.selectionChange( 1 );
} );
// https://dev.ckeditor.com/ticket/9699: On Webkit&Gecko in inline editor we have to check selection when it was changed
// by dragging and releasing mouse button outside editable. Dragging (mousedown)
// has to be initialized in editable, but for mouseup we listen on document element.
if ( isInline && ( CKEDITOR.env.webkit || CKEDITOR.env.gecko ) ) {
var mouseDown;
editable.attachListener( editable, 'mousedown', function() {
mouseDown = 1;
} );
editable.attachListener( doc.getDocumentElement(), 'mouseup', function() {
if ( mouseDown )
checkSelectionChangeTimeout.call( editor );
mouseDown = 0;
} );
}
// In all other cases listen on simple mouseup over editable, as we did before https://dev.ckeditor.com/ticket/9699.
//
// Use document instead of editable in non-IEs for observing mouseup
// since editable won't fire the event if selection process started within iframe and ended out
// of the editor (https://dev.ckeditor.com/ticket/9851).
else {
editable.attachListener( CKEDITOR.env.ie ? editable : doc.getDocumentElement(), 'mouseup', checkSelectionChangeTimeout, editor );
}
if ( CKEDITOR.env.webkit ) {
// Before keystroke is handled by editor, check to remove the filling char.
editable.attachListener( doc, 'keydown', function( evt ) {
var key = evt.data.getKey();
// Remove the filling char before some keys get
// executed, so they'll not get blocked by it.
switch ( key ) {
case 13: // ENTER
case 33: // PAGEUP
case 34: // PAGEDOWN
case 35: // HOME
case 36: // END
case 37: // LEFT-ARROW
case 39: // RIGHT-ARROW
case 8: // BACKSPACE
case 45: // INS
case 46: // DEl
if ( editable.hasFocus ) {
removeFillingCharSequenceNode( editable );
}
}