-
-
Notifications
You must be signed in to change notification settings - Fork 14
/
dataTables.autoFill.js
executable file
·1228 lines (1012 loc) · 30.6 KB
/
dataTables.autoFill.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
/*! AutoFill 2.6.0
* ©2008-2023 SpryMedia Ltd - datatables.net/license
*/
/**
* @summary AutoFill
* @description Add Excel like click and drag auto-fill options to DataTables
* @version 2.6.0
* @author SpryMedia Ltd (www.sprymedia.co.uk)
* @copyright SpryMedia Ltd.
*
* This source file is free software, available under the following license:
* MIT license - http://datatables.net/license/mit
*
* This source file is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details.
*
* For details please refer to: http://www.datatables.net
*/
var _instance = 0;
/**
* AutoFill provides Excel like auto-fill features for a DataTable
*
* @class AutoFill
* @constructor
* @param {object} oTD DataTables settings object
* @param {object} oConfig Configuration object for AutoFill
*/
var AutoFill = function( dt, opts )
{
if ( ! DataTable.versionCheck || ! DataTable.versionCheck( '1.10.8' ) ) {
throw( "Warning: AutoFill requires DataTables 1.10.8 or greater");
}
// User and defaults configuration object
this.c = $.extend( true, {},
DataTable.defaults.autoFill,
AutoFill.defaults,
opts
);
/**
* @namespace Settings object which contains customisable information for AutoFill instance
*/
this.s = {
/** @type {DataTable.Api} DataTables' API instance */
dt: new DataTable.Api( dt ),
/** @type {String} Unique namespace for events attached to the document */
namespace: '.autoFill'+(_instance++),
/** @type {Object} Cached dimension information for use in the mouse move event handler */
scroll: {},
/** @type {integer} Interval object used for smooth scrolling */
scrollInterval: null,
handle: {
height: 0,
width: 0
},
/**
* Enabled setting
* @type {Boolean}
*/
enabled: false
};
/**
* @namespace Common and useful DOM elements for the class instance
*/
this.dom = {
closeButton: $('<div class="dtaf-popover-close">×</div>'),
/** @type {jQuery} AutoFill handle */
handle: $('<div class="dt-autofill-handle"/>'),
/**
* @type {Object} Selected cells outline - Need to use 4 elements,
* otherwise the mouse over if you back into the selected rectangle
* will be over that element, rather than the cells!
*/
select: {
top: $('<div class="dt-autofill-select top"/>'),
right: $('<div class="dt-autofill-select right"/>'),
bottom: $('<div class="dt-autofill-select bottom"/>'),
left: $('<div class="dt-autofill-select left"/>')
},
/** @type {jQuery} Fill type chooser background */
background: $('<div class="dt-autofill-background"/>'),
/** @type {jQuery} Fill type chooser */
list: $('<div class="dt-autofill-list">'+this.s.dt.i18n('autoFill.info', '')+'</div>')
.attr('aria-modal', true)
.attr('role', 'dialog')
.append('<div class="dt-autofill-list-items"></div>'),
/** @type {jQuery} DataTables scrolling container */
dtScroll: null,
/** @type {jQuery} Offset parent element */
offsetParent: null
};
/* Constructor logic */
this._constructor();
};
$.extend( AutoFill.prototype, {
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Public methods (exposed via the DataTables API below)
*/
enabled: function ()
{
return this.s.enabled;
},
enable: function ( flag )
{
var that = this;
if ( flag === false ) {
return this.disable();
}
this.s.enabled = true;
this._focusListener();
this.dom.handle.on( 'mousedown touchstart', function (e) {
that._mousedown( e );
return false;
} );
$(window).on('resize', function() {
var handle = $('div.dt-autofill-handle');
if(handle.length > 0 && that.dom.attachedTo !== undefined) {
that._attach(that.dom.attachedTo)
}
})
let orientationReset = function() {
that.s.handle = {
height: false,
width: false
};
$(that.dom.handle).css({
'height': '',
'width': ''
})
if(that.dom.attachedTo !== undefined) {
that._attach(that.dom.attachedTo)
}
}
$(window)
.on('orientationchange', function() {
setTimeout(function() {
orientationReset();
setTimeout(orientationReset, 150);
}, 50);
});
return this;
},
disable: function ()
{
this.s.enabled = false;
this._focusListenerRemove();
return this;
},
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Constructor
*/
/**
* Initialise the RowReorder instance
*
* @private
*/
_constructor: function ()
{
var that = this;
var dt = this.s.dt;
var dtScroll = $('div.dataTables_scrollBody', this.s.dt.table().container());
// Make the instance accessible to the API
dt.settings()[0].autoFill = this;
if ( dtScroll.length ) {
this.dom.dtScroll = dtScroll;
// Need to scroll container to be the offset parent
if ( dtScroll.css('position') === 'static' ) {
dtScroll.css( 'position', 'relative' );
}
}
if ( this.c.enable !== false ) {
this.enable();
}
dt.on( 'destroy.autoFill', function () {
that._focusListenerRemove();
} );
},
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Private methods
*/
/**
* Display the AutoFill drag handle by appending it to a table cell. This
* is the opposite of the _detach method.
*
* @param {node} node TD/TH cell to insert the handle into
* @private
*/
_attach: function ( node )
{
var dt = this.s.dt;
var idx = dt.cell( node ).index();
var handle = this.dom.handle;
var handleDim = this.s.handle;
if ( ! idx || dt.columns( this.c.columns ).indexes().indexOf( idx.column ) === -1 ) {
this._detach();
return;
}
if ( ! this.dom.offsetParent ) {
// We attach to the table's offset parent
this.dom.offsetParent = $( dt.table().node() ).offsetParent();
}
if ( ! handleDim.height || ! handleDim.width ) {
// Append to document so we can get its size. Not expecting it to
// change during the life time of the page
handle.appendTo( 'body' );
handleDim.height = handle.outerHeight();
handleDim.width = handle.outerWidth();
}
// Might need to go through multiple offset parents
var offset = this._getPosition( node, this.dom.offsetParent );
this.dom.attachedTo = node;
handle
.css( {
top: offset.top + node.offsetHeight - handleDim.height,
left: offset.left + node.offsetWidth - handleDim.width
} )
.appendTo( this.dom.offsetParent );
},
/**
* Determine can the fill type should be. This can be automatic, or ask the
* end user.
*
* @param {array} cells Information about the selected cells from the key
* up function
* @private
*/
_actionSelector: function ( cells )
{
var that = this;
var dt = this.s.dt;
var actions = AutoFill.actions;
var available = [];
// "Ask" each plug-in if it wants to handle this data
$.each( actions, function ( key, action ) {
if ( action.available( dt, cells ) ) {
available.push( key );
}
} );
if ( available.length === 1 && this.c.alwaysAsk === false ) {
// Only one action available - enact it immediately
var result = actions[ available[0] ].execute( dt, cells );
this._update( result, cells );
}
else if ( available.length > 1 || this.c.alwaysAsk ) {
// Multiple actions available - ask the end user what they want to do
var list = this.dom.list.children('div.dt-autofill-list-items').empty();
// Add a cancel option
available.push( 'cancel' );
$.each( available, function ( i, name ) {
list.append( $('<button/>')
.html(actions[ name ].option( dt, cells ))
.append( $('<span class="dt-autofill-button"/>').html(dt.i18n('autoFill.button', '>')))
.on( 'click', function () {
var result = actions[ name ].execute(
dt, cells, $(this).closest('li')
);
that._update( result, cells );
that.dom.background.remove();
that.dom.list.remove();
} )
);
} );
this.dom.background.appendTo( 'body' );
this.dom.background.one('click', function() {
that.dom.background.remove();
that.dom.list.remove();
})
this.dom.list.appendTo( 'body' );
if (this.c.closeButton) {
this.dom.list.prepend(this.dom.closeButton).addClass(AutoFill.classes.closeable)
this.dom.closeButton.on('click', function() {
return that.dom.background.click()
});
}
this.dom.list.css( 'margin-top', this.dom.list.outerHeight()/2 * -1 );
}
},
/**
* Remove the AutoFill handle from the document
*
* @private
*/
_detach: function ()
{
this.dom.attachedTo = null;
this.dom.handle.detach();
},
/**
* Draw the selection outline by calculating the range between the start
* and end cells, then placing the highlighting elements to draw a rectangle
*
* @param {node} target End cell
* @param {object} e Originating event
* @private
*/
_drawSelection: function ( target, e )
{
// Calculate boundary for start cell to this one
var dt = this.s.dt;
var start = this.s.start;
var startCell = $(this.dom.start);
var end = {
row: this.c.vertical ?
dt.rows( { page: 'current' } ).nodes().indexOf( target.parentNode ) :
start.row,
column: this.c.horizontal ?
$(target).index() :
start.column
};
var colIndx = dt.column.index( 'toData', end.column );
var endRow = dt.row( ':eq('+end.row+')', { page: 'current' } ); // Workaround for M581
var endCell = $( dt.cell( endRow.index(), colIndx ).node() );
// Be sure that is a DataTables controlled cell
if ( ! dt.cell( endCell ).any() ) {
return;
}
// if target is not in the columns available - do nothing
if ( dt.columns( this.c.columns ).indexes().indexOf( colIndx ) === -1 || end.row === -1) {
return;
}
this.s.end = end;
var top, bottom, left, right, height, width;
top = start.row < end.row ? startCell : endCell;
bottom = start.row < end.row ? endCell : startCell;
left = start.column < end.column ? startCell : endCell;
right = start.column < end.column ? endCell : startCell;
top = this._getPosition( top.get(0) ).top;
left = this._getPosition( left.get(0) ).left;
height = this._getPosition( bottom.get(0) ).top + bottom.outerHeight() - top;
width = this._getPosition( right.get(0) ).left + right.outerWidth() - left;
var select = this.dom.select;
select.top.css( {
top: top,
left: left,
width: width
} );
select.left.css( {
top: top,
left: left,
height: height
} );
select.bottom.css( {
top: top + height,
left: left,
width: width
} );
select.right.css( {
top: top,
left: left + width,
height: height
} );
},
/**
* Use the Editor API to perform an update based on the new data for the
* cells
*
* @param {array} cells Information about the selected cells from the key
* up function
* @private
*/
_editor: function ( cells )
{
var dt = this.s.dt;
var editor = this.c.editor;
if ( ! editor ) {
return;
}
// Build the object structure for Editor's multi-row editing
var idValues = {};
var nodes = [];
var fields = editor.fields();
for ( var i=0, ien=cells.length ; i<ien ; i++ ) {
for ( var j=0, jen=cells[i].length ; j<jen ; j++ ) {
var cell = cells[i][j];
// Determine the field name for the cell being edited
var col = dt.settings()[0].aoColumns[ cell.index.column ];
var fieldName = col.editField;
if ( fieldName === undefined ) {
var dataSrc = col.mData;
// dataSrc is the `field.data` property, but we need to set
// using the field name, so we need to translate from the
// data to the name
for ( var k=0, ken=fields.length ; k<ken ; k++ ) {
var field = editor.field( fields[k] );
if ( field.dataSrc() === dataSrc ) {
fieldName = field.name();
break;
}
}
}
if ( ! fieldName ) {
throw 'Could not automatically determine field data. '+
'Please see https://datatables.net/tn/11';
}
if ( ! idValues[ fieldName ] ) {
idValues[ fieldName ] = {};
}
var id = dt.row( cell.index.row ).id();
idValues[ fieldName ][ id ] = cell.set;
// Keep a list of cells so we can activate the bubble editing
// with them
nodes.push( cell.index );
}
}
// Perform the edit using bubble editing as it allows us to specify
// the cells to be edited, rather than using full rows
editor
.bubble( nodes, false )
.multiSet( idValues )
.submit();
},
/**
* Emit an event on the DataTable for listeners
*
* @param {string} name Event name
* @param {array} args Event arguments
* @private
*/
_emitEvent: function ( name, args )
{
this.s.dt.iterator( 'table', function ( ctx, i ) {
$(ctx.nTable).triggerHandler( name+'.dt', args );
} );
},
/**
* Attach suitable listeners (based on the configuration) that will attach
* and detach the AutoFill handle in the document.
*
* @private
*/
_focusListener: function ()
{
var that = this;
var dt = this.s.dt;
var namespace = this.s.namespace;
var focus = this.c.focus !== null ?
this.c.focus :
dt.init().keys || dt.settings()[0].keytable ?
'focus' :
'hover';
// All event listeners attached here are removed in the `destroy`
// callback in the constructor
if ( focus === 'focus' ) {
dt
.on( 'key-focus.autoFill', function ( e, dt, cell ) {
that._attach( cell.node() );
} )
.on( 'key-blur.autoFill', function ( e, dt, cell ) {
that._detach();
} );
}
else if ( focus === 'click' ) {
$(dt.table().body()).on( 'click'+namespace, 'td, th', function (e) {
that._attach( this );
} );
$(document.body).on( 'click'+namespace, function (e) {
if ( ! $(e.target).parents().filter( dt.table().body() ).length ) {
that._detach();
}
} );
}
else {
$(dt.table().body())
.on( 'mouseenter'+namespace+' touchstart'+namespace, 'td, th', function (e) {
that._attach( this );
} )
.on( 'mouseleave'+namespace+'touchend'+namespace, function (e) {
if ( $(e.relatedTarget).hasClass('dt-autofill-handle') ) {
return;
}
that._detach();
} );
}
},
_focusListenerRemove: function ()
{
var dt = this.s.dt;
dt.off( '.autoFill' );
$(dt.table().body()).off( this.s.namespace );
$(document.body).off( this.s.namespace );
},
/**
* Get the position of a node, relative to another, including any scrolling
* offsets.
* @param {Node} node Node to get the position of
* @param {jQuery} targetParent Node to use as the parent
* @return {object} Offset calculation
* @private
*/
_getPosition: function ( node, targetParent )
{
var
currNode = node,
currOffsetParent,
top = 0,
left = 0;
if ( ! targetParent ) {
targetParent = $( $( this.s.dt.table().node() )[0].offsetParent );
}
do {
// Don't use jQuery().position() the behaviour changes between 1.x and 3.x for
// tables
var positionTop = currNode.offsetTop;
var positionLeft = currNode.offsetLeft;
// jQuery doesn't give a `table` as the offset parent oddly, so use DOM directly
currOffsetParent = $( currNode.offsetParent );
top += positionTop + parseInt( currOffsetParent.css('border-top-width') || 0 ) * 1;
left += positionLeft + parseInt( currOffsetParent.css('border-left-width') || 0 ) * 1;
// Emergency fall back. Shouldn't happen, but just in case!
if ( currNode.nodeName.toLowerCase() === 'body' ) {
break;
}
currNode = currOffsetParent.get(0); // for next loop
}
while ( currOffsetParent.get(0) !== targetParent.get(0) )
return {
top: top,
left: left
};
},
/**
* Start mouse drag - selects the start cell
*
* @param {object} e Mouse down event
* @private
*/
_mousedown: function ( e )
{
var that = this;
var dt = this.s.dt;
this.dom.start = this.dom.attachedTo;
this.s.start = {
row: dt.rows( { page: 'current' } ).nodes().indexOf( $(this.dom.start).parent()[0] ),
column: $(this.dom.start).index()
};
$(document.body)
.on( 'mousemove.autoFill touchmove.autoFill', function (e) {
that._mousemove( e );
// If it is a touch event then when the touch ends we need to remove the handle
if(e.type === 'touchmove') {
$(document.body).one('touchend.autoFill', function() {
that._detach();
})
}
} )
.on( 'mouseup.autoFill touchend.autoFill', function (e) {
that._mouseup( e );
} );
var select = this.dom.select;
var offsetParent = $( dt.table().node() ).offsetParent();
select.top.appendTo( offsetParent );
select.left.appendTo( offsetParent );
select.right.appendTo( offsetParent );
select.bottom.appendTo( offsetParent );
this._drawSelection( this.dom.start, e );
this.dom.handle.css( 'display', 'none' );
// Cache scrolling information so mouse move doesn't need to read.
// This assumes that the window and DT scroller will not change size
// during an AutoFill drag, which I think is a fair assumption
var scrollWrapper = this.dom.dtScroll;
this.s.scroll = {
windowHeight: $(window).height(),
windowWidth: $(window).width(),
dtTop: scrollWrapper ? scrollWrapper.offset().top : null,
dtLeft: scrollWrapper ? scrollWrapper.offset().left : null,
dtHeight: scrollWrapper ? scrollWrapper.outerHeight() : null,
dtWidth: scrollWrapper ? scrollWrapper.outerWidth() : null
};
},
/**
* Mouse drag - selects the end cell and update the selection display for
* the end user
*
* @param {object} e Mouse move event
* @private
*/
_mousemove: function ( e )
{
var target = e.touches && e.touches.length
? document.elementFromPoint(e.touches[0].clientX, e.touches[0].clientY)
: e.target;
var name = target.nodeName.toLowerCase();
if ( name !== 'td' && name !== 'th' ) {
return;
}
this._drawSelection( target, e );
this._shiftScroll( e );
},
/**
* End mouse drag - perform the update actions
*
* @param {object} e Mouse up event
* @private
*/
_mouseup: function ( e )
{
$(document.body).off( '.autoFill' );
var that = this;
var dt = this.s.dt;
var select = this.dom.select;
select.top.remove();
select.left.remove();
select.right.remove();
select.bottom.remove();
this.dom.handle.css( 'display', 'block' );
// Display complete - now do something useful with the selection!
var start = this.s.start;
var end = this.s.end;
// Haven't selected multiple cells, so nothing to do
if ( start.row === end.row && start.column === end.column ) {
return;
}
var startDt = dt.cell( ':eq('+start.row+')', start.column+':visible', {page:'current'} );
// If Editor is active inside this cell (inline editing) we need to wait for Editor to
// submit and then we can loop back and trigger the fill.
if ( $('div.DTE', startDt.node()).length ) {
var editor = dt.editor();
editor
.on( 'submitSuccess.dtaf close.dtaf', function () {
editor.off( '.dtaf');
setTimeout( function () {
that._mouseup( e );
}, 100 );
} )
.on( 'submitComplete.dtaf preSubmitCancelled.dtaf close.dtaf', function () {
editor.off( '.dtaf');
} );
// Make the current input submit
editor.submit();
return;
}
// Build a matrix representation of the selected rows
var rows = this._range( start.row, end.row );
var columns = this._range( start.column, end.column );
var selected = [];
var dtSettings = dt.settings()[0];
var dtColumns = dtSettings.aoColumns;
var enabledColumns = dt.columns( this.c.columns ).indexes();
// Can't use Array.prototype.map as IE8 doesn't support it
// Can't use $.map as jQuery flattens 2D arrays
// Need to use a good old fashioned for loop
for ( var rowIdx=0 ; rowIdx<rows.length ; rowIdx++ ) {
selected.push(
$.map( columns, function (column) {
var row = dt.row( ':eq('+rows[rowIdx]+')', {page:'current'} ); // Workaround for M581
var cell = dt.cell( row.index(), column+':visible' );
var data = cell.data();
var cellIndex = cell.index();
var editField = dtColumns[ cellIndex.column ].editField;
if ( editField !== undefined ) {
data = dtSettings.oApi._fnGetObjectDataFn( editField )( dt.row( cellIndex.row ).data() );
}
if ( enabledColumns.indexOf(cellIndex.column) === -1 ) {
return;
}
return {
cell: cell,
data: data,
label: cell.data(),
index: cellIndex
};
} )
);
}
this._actionSelector( selected );
// Stop shiftScroll
clearInterval( this.s.scrollInterval );
this.s.scrollInterval = null;
},
/**
* Create an array with a range of numbers defined by the start and end
* parameters passed in (inclusive!).
*
* @param {integer} start Start
* @param {integer} end End
* @private
*/
_range: function ( start, end )
{
var out = [];
var i;
if ( start <= end ) {
for ( i=start ; i<=end ; i++ ) {
out.push( i );
}
}
else {
for ( i=start ; i>=end ; i-- ) {
out.push( i );
}
}
return out;
},
/**
* Move the window and DataTables scrolling during a drag to scroll new
* content into view. This is done by proximity to the edge of the scrolling
* container of the mouse - for example near the top edge of the window
* should scroll up. This is a little complicated as there are two elements
* that can be scrolled - the window and the DataTables scrolling view port
* (if scrollX and / or scrollY is enabled).
*
* @param {object} e Mouse move event object
* @private
*/
_shiftScroll: function ( e )
{
var that = this;
var dt = this.s.dt;
var scroll = this.s.scroll;
var runInterval = false;
var scrollSpeed = 5;
var buffer = 65;
// Different values if using a touchscreen
var pageX = !e.type.includes('touch') ? e.pageX - window.scrollX :e.touches[0].clientX;
var pageY = !e.type.includes('touch') ? e.pageY - window.scrollY :e.touches[0].clientY;
var
windowY = pageY,
windowX = pageX,
windowVert, windowHoriz,
dtVert, dtHoriz;
// Window calculations - based on the mouse position in the window,
// regardless of scrolling
if ( windowY < buffer ) {
windowVert = scrollSpeed * -1;
}
else if ( windowY > scroll.windowHeight - buffer ) {
windowVert = scrollSpeed;
}
if ( windowX < buffer ) {
windowHoriz = scrollSpeed * -1;
}
else if ( windowX > scroll.windowWidth - buffer ) {
windowHoriz = scrollSpeed;
}
// DataTables scrolling calculations - based on the table's position in
// the document and the mouse position on the page
if ( scroll.dtTop !== null && pageY < scroll.dtTop + buffer ) {
dtVert = scrollSpeed * -1;
}
else if ( scroll.dtTop !== null && pageY > scroll.dtTop + scroll.dtHeight - buffer ) {
dtVert = scrollSpeed;
}
if ( scroll.dtLeft !== null && pageX < scroll.dtLeft + buffer ) {
dtHoriz = scrollSpeed * -1;
}
else if ( scroll.dtLeft !== null && pageX > scroll.dtLeft + scroll.dtWidth - buffer ) {
dtHoriz = scrollSpeed;
}
// This is where it gets interesting. We want to continue scrolling
// without requiring a mouse move, so we need an interval to be
// triggered. The interval should continue until it is no longer needed,
// but it must also use the latest scroll commands (for example consider
// that the mouse might move from scrolling up to scrolling left, all
// with the same interval running. We use the `scroll` object to "pass"
// this information to the interval. Can't use local variables as they
// wouldn't be the ones that are used by an already existing interval!
if ( windowVert || windowHoriz || dtVert || dtHoriz ) {
scroll.windowVert = windowVert;
scroll.windowHoriz = windowHoriz;
scroll.dtVert = dtVert;
scroll.dtHoriz = dtHoriz;
runInterval = true;
}
else if ( this.s.scrollInterval ) {
// Don't need to scroll - remove any existing timer
clearInterval( this.s.scrollInterval );
this.s.scrollInterval = null;
}
// If we need to run the interval to scroll and there is no existing
// interval (if there is an existing one, it will continue to run)
if ( ! this.s.scrollInterval && runInterval ) {
this.s.scrollInterval = setInterval( function () {
// Don't need to worry about setting scroll <0 or beyond the
// scroll bound as the browser will just reject that.
window.scrollTo(window.scrollX + (scroll.windowHoriz ? scroll.windowHoriz : 0), window.scrollY + (scroll.windowVert ? scroll.windowVert : 0))
// DataTables scrolling
if ( scroll.dtVert || scroll.dtHoriz ) {
var scroller = that.dom.dtScroll[0];
if ( scroll.dtVert ) {
scroller.scrollTop += scroll.dtVert;
}
if ( scroll.dtHoriz ) {
scroller.scrollLeft += scroll.dtHoriz;
}
}
}, 20 );
}
},
/**
* Update the DataTable after the user has selected what they want to do
*
* @param {false|undefined} result Return from the `execute` method - can
* be false internally to do nothing. This is not documented for plug-ins
* and is used only by the cancel option.
* @param {array} cells Information about the selected cells from the key
* up function, argumented with the set values
* @private
*/
_update: function ( result, cells )
{
// Do nothing on `false` return from an execute function
if ( result === false ) {
return;
}
var dt = this.s.dt;
var cell;
var columns = dt.columns( this.c.columns ).indexes();
// Potentially allow modifications to the cells matrix
this._emitEvent( 'preAutoFill', [ dt, cells ] );
this._editor( cells );
// Automatic updates are not performed if `update` is null and the
// `editor` parameter is passed in - the reason being that Editor will
// update the data once submitted
var update = this.c.update !== null ?
this.c.update :
this.c.editor ?
false :
true;
if ( update ) {
for ( var i=0, ien=cells.length ; i<ien ; i++ ) {
for ( var j=0, jen=cells[i].length ; j<jen ; j++ ) {
cell = cells[i][j];
if ( columns.indexOf(cell.index.column) !== -1 ) {
cell.cell.data( cell.set );
}
}
}
dt.draw(false);
}
this._emitEvent( 'autoFill', [ dt, cells ] );
}
} );