-
Notifications
You must be signed in to change notification settings - Fork 77
/
Copy pathui-grid.selection.js
1196 lines (1098 loc) · 50.5 KB
/
ui-grid.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
/*!
* ui-grid - v4.12.7 - 2024-04-12
* http://ui-grid.info/
* Copyright (c) 2024 ; License: MIT
*/
(function () {
'use strict';
/**
* @ngdoc overview
* @name ui.grid.selection
* @description
*
* # ui.grid.selection
* This module provides row selection
*
* <div class="alert alert-success" role="alert"><strong>Stable</strong> This feature is stable. There should no longer be breaking api changes without a deprecation warning.</div>
*
* <div doc-module-components="ui.grid.selection"></div>
*/
var module = angular.module('ui.grid.selection', ['ui.grid']);
/**
* @ngdoc object
* @name ui.grid.selection.constant:uiGridSelectionConstants
*
* @description constants available in selection module
*/
module.constant('uiGridSelectionConstants', {
featureName: 'selection',
selectionRowHeaderColName: 'selectionRowHeaderCol'
});
// add methods to GridRow
angular.module('ui.grid').config(['$provide', function ($provide) {
$provide.decorator('GridRow', ['$delegate', function ($delegate) {
/**
* @ngdoc object
* @name ui.grid.selection.api:GridRow
*
* @description GridRow prototype functions added for selection
*/
/**
* @ngdoc object
* @name enableSelection
* @propertyOf ui.grid.selection.api:GridRow
* @description Enable row selection for this row, only settable by internal code.
*
* The grouping feature, for example, might set group header rows to not be selectable.
* <br/>Defaults to true
*/
/**
* @ngdoc object
* @name isSelected
* @propertyOf ui.grid.selection.api:GridRow
* @description Selected state of row. Should be readonly. Make any changes to selected state using setSelected().
* <br/>Defaults to false
*/
/**
* @ngdoc object
* @name isFocused
* @propertyOf ui.grid.selection.api:GridRow
* @description Focused state of row. Should be readonly. Make any changes to focused state using setFocused().
* <br/>Defaults to false
*/
/**
* @ngdoc function
* @name setSelected
* @methodOf ui.grid.selection.api:GridRow
* @description Sets the isSelected property and updates the selectedCount
* Changes to isSelected state should only be made via this function
* @param {Boolean} selected value to set
*/
$delegate.prototype.setSelected = function (selected) {
if (selected !== this.isSelected) {
this.isSelected = selected;
this.grid.selection.selectedCount += selected ? 1 : -1;
}
};
/**
* @ngdoc function
* @name setFocused
* @methodOf ui.grid.selection.api:GridRow
* @description Sets the isFocused property
* Changes to isFocused state should only be made via this function
* @param {Boolean} val value to set
*/
$delegate.prototype.setFocused = function(val) {
if (val !== this.isFocused) {
this.grid.selection.focusedRow && (this.grid.selection.focusedRow.isFocused = false);
this.grid.selection.focusedRow = val ? this : null;
this.isFocused = val;
}
};
return $delegate;
}]);
}]);
/**
* @ngdoc service
* @name ui.grid.selection.service:uiGridSelectionService
*
* @description Services for selection features
*/
module.service('uiGridSelectionService',
function () {
var service = {
initializeGrid: function (grid) {
// add feature namespace and any properties to grid for needed
/**
* @ngdoc object
* @name ui.grid.selection.grid:selection
*
* @description Grid properties and functions added for selection
*/
grid.selection = {
lastSelectedRow: null,
/**
* @ngdoc object
* @name focusedRow
* @propertyOf ui.grid.selection.grid:selection
* @description Focused row.
*/
focusedRow: null,
selectAll: false
};
/**
* @ngdoc object
* @name selectedCount
* @propertyOf ui.grid.selection.grid:selection
* @description Current count of selected rows
* @example
* var count = grid.selection.selectedCount
*/
grid.selection.selectedCount = 0;
service.defaultGridOptions(grid.options);
/**
* @ngdoc object
* @name ui.grid.selection.api:PublicApi
*
* @description Public Api for selection feature
*/
var publicApi = {
events: {
selection: {
/**
* @ngdoc event
* @name rowFocusChanged
* @eventOf ui.grid.selection.api:PublicApi
* @description is raised after the row.isFocused state is changed
* @param {object} scope the scope associated with the grid
* @param {GridRow} row the row that was focused/unfocused
* @param {Event} evt object if raised from an event
*/
rowFocusChanged: function (scope, row, evt) {},
/**
* @ngdoc event
* @name rowSelectionChanged
* @eventOf ui.grid.selection.api:PublicApi
* @description is raised after the row.isSelected state is changed
* @param {object} scope the scope associated with the grid
* @param {GridRow} row the row that was selected/deselected
* @param {Event} evt object if raised from an event
*/
rowSelectionChanged: function (scope, row, evt) {
},
/**
* @ngdoc event
* @name rowSelectionChangedBatch
* @eventOf ui.grid.selection.api:PublicApi
* @description is raised after the row.isSelected state is changed
* in bulk, if the `enableSelectionBatchEvent` option is set to true
* (which it is by default). This allows more efficient processing
* of bulk events.
* @param {object} scope the scope associated with the grid
* @param {array} rows the rows that were selected/deselected
* @param {Event} evt object if raised from an event
*/
rowSelectionChangedBatch: function (scope, rows, evt) {
}
}
},
methods: {
selection: {
/**
* @ngdoc function
* @name toggleRowSelection
* @methodOf ui.grid.selection.api:PublicApi
* @description Toggles data row as selected or unselected
* @param {object} rowEntity gridOptions.data[] array instance
* @param {Event} evt object if raised from an event
*/
toggleRowSelection: function (rowEntity, evt) {
var row = grid.getRow(rowEntity);
if (row != void 0 && row !== null) {
service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect, true);
}
},
/**
* @ngdoc function
* @name selectRow
* @methodOf ui.grid.selection.api:PublicApi
* @description Select the data row
* @param {object} rowEntity gridOptions.data[] array instance
* @param {Event} evt object if raised from an event
*/
selectRow: function (rowEntity, evt) {
var row = grid.getRow(rowEntity);
if (row != void 0 && row !== null && !row.isSelected) {
service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect, true);
}
},
/**
* @ngdoc function
* @name selectRowByVisibleIndex
* @methodOf ui.grid.selection.api:PublicApi
* @description Select the specified row by visible index (i.e. if you
* specify row 0 you'll get the first visible row selected). In this context
* visible means of those rows that are theoretically visible (i.e. not filtered),
* rather than rows currently rendered on the screen.
* @param {number} rowNum index within the rowsVisible array
* @param {Event} evt object if raised from an event
*/
selectRowByVisibleIndex: function (rowNum, evt) {
var row = grid.renderContainers.body.visibleRowCache[rowNum];
if (row != void 0 && row !== null && typeof (row) !== 'undefined' && !row.isSelected) {
service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect, false);
}
},
/**
* @ngdoc function
* @name selectRowByKey
* @methodOf ui.grid.selection.api:PublicApi
* @description selects all GridRows who have an key that is equal to comparator
* so for Example if isInEntity == false then it does this check: row[key] === comparator
* if isInEntity == true then it does this check: row.entity[key] === comparator
* @param {boolean} isInEntity if true then key is in entity else it's directly in row
* @param {string | number} key the key to look for
* @param {any} comparator the value that key should have
* @param {Event} evt [optional] object if raised from an event
* @param {array} lookInRows [optional] the rows to look in - if not provided then looks in grid.rows
*/
selectRowByKey: function (isInEntity, key, comparator, evt, lookInRows) {
var row = grid.findRowByKey(isInEntity, key, comparator, lookInRows);
if (row != void 0 && row !== null && typeof (row) !== 'undefined' && !row.isSelected) {
service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect, false);
}
},
/**
* @ngdoc function
* @name unSelectRow
* @methodOf ui.grid.selection.api:PublicApi
* @description UnSelect the data row
* @param {object} rowEntity gridOptions.data[] array instance
* @param {Event} evt object if raised from an event
*/
unSelectRow: function (rowEntity, evt) {
var row = grid.getRow(rowEntity);
if (row != void 0 && row !== null && row.isSelected) {
service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect, true);
}
},
/**
* @ngdoc function
* @name unSelectRowByVisibleIndex
* @methodOf ui.grid.selection.api:PublicApi
* @description Unselect the specified row by visible index (i.e. if you
* specify row 0 you'll get the first visible row unselected). In this context
* visible means of those rows that are theoretically visible (i.e. not filtered),
* rather than rows currently rendered on the screen.
* @param {number} rowNum index within the rowsVisible array
* @param {Event} evt object if raised from an event
*/
unSelectRowByVisibleIndex: function (rowNum, evt) {
var row = grid.renderContainers.body.visibleRowCache[rowNum];
if (row != void 0 && row !== null && typeof (row) !== 'undefined' && row.isSelected) {
service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect, false);
}
},
/**
* @ngdoc function
* @name unSelectRowByKey
* @methodOf ui.grid.selection.api:PublicApi
* @description unselects the GridRows who have an key that is equal to comparator
* so for Example if isInEntity == false then it does this check: row[key] === comparator
* if isInEntity == true then it does this check: row.entity[key] === comparator
* @param {boolean} isInEntity if true then key is in entity else it's directly in row
* @param {string | number} key the key to look for
* @param {any} comparator the value that key should have
* @param {Event} evt [optional] object if raised from an event
* @param {array} lookInRows [optional] the rows to look in - if not provided then looks in grid.rows
*/
unSelectRowByKey: function (isInEntity, key, comparator, evt, lookInRows) {
var row = grid.findRowByKey(isInEntity, key, comparator, lookInRows);
if (row != void 0 && row !== null && typeof (row) !== 'undefined' && row.isSelected) {
service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect, false);
}
},
/**
* @ngdoc function
* @name selectAllRows
* @methodOf ui.grid.selection.api:PublicApi
* @description Selects all rows. Does nothing if multiSelect = false
* @param {Event} evt object if raised from an event
*/
selectAllRows: function (evt) {
if (grid.options.multiSelect !== false) {
var changedRows = [];
grid.rows.forEach(function (row) {
if (!row.isSelected && row.enableSelection !== false && grid.options.isRowSelectable(row) !== false) {
row.setSelected(true);
service.decideRaiseSelectionEvent(grid, row, changedRows, evt);
}
});
grid.selection.selectAll = true;
service.decideRaiseSelectionBatchEvent(grid, changedRows, evt);
}
},
/**
* @ngdoc function
* @name selectAllVisibleRows
* @methodOf ui.grid.selection.api:PublicApi
* @description Selects all visible rows. Does nothing if multiSelect = false
* @param {Event} evt object if raised from an event
*/
selectAllVisibleRows: function (evt) {
if (grid.options.multiSelect !== false) {
var changedRows = [];
grid.rows.forEach(function(row) {
if (row.visible) {
if (!row.isSelected && row.enableSelection !== false && grid.options.isRowSelectable(row) !== false) {
row.setSelected(true);
service.decideRaiseSelectionEvent(grid, row, changedRows, evt);
}
} else if (row.isSelected) {
row.setSelected(false);
service.decideRaiseSelectionEvent(grid, row, changedRows, evt);
}
});
grid.selection.selectAll = true;
service.decideRaiseSelectionBatchEvent(grid, changedRows, evt);
}
},
/**
* @ngdoc function
* @name clearSelectedRows
* @methodOf ui.grid.selection.api:PublicApi
* @description Unselects all rows
* @param {Event} evt object if raised from an event
*/
clearSelectedRows: function (evt) {
service.clearSelectedRows(grid, evt);
},
/**
* @ngdoc function
* @name getSelectedRows
* @methodOf ui.grid.selection.api:PublicApi
* @description returns all selected Row's entity references
*/
getSelectedRows: function () {
return service.mapAndFilterRowsByEntity(service.getSelectedRows(grid));
},
/**
* @ngdoc function
* @name getUnSelectedRows
* @methodOf ui.grid.selection.api:PublicApi
* @description returns all unselected Row's entity references
*/
getUnSelectedRows: function () {
return service.mapAndFilterRowsByEntity(service.getUnSelectedRows(grid));
},
/**
* @ngdoc function
* @name getSelectedGridRows
* @methodOf ui.grid.selection.api:PublicApi
* @description returns all selectedRow's as gridRows
*/
getSelectedGridRows: function () {
return service.getSelectedRows(grid);
},
/**
* @ngdoc function
* @name getSelectedGridRows
* @methodOf ui.grid.selection.api:PublicApi
* @description returns all unselected Row's as gridRows
*/
getUnSelectedGridRows: function () {
return service.getUnSelectedRows(grid);
},
/**
* @ngdoc function
* @name getSelectedCount
* @methodOf ui.grid.selection.api:PublicApi
* @description returns the number of rows selected
*/
getSelectedCount: function () {
return grid.selection.selectedCount;
},
/**
* @ngdoc function
* @name setMultiSelect
* @methodOf ui.grid.selection.api:PublicApi
* @description Sets the current gridOption.multiSelect to true or false
* @param {bool} multiSelect true to allow multiple rows
*/
setMultiSelect: function (multiSelect) {
grid.options.multiSelect = multiSelect;
},
/**
* @ngdoc function
* @name setModifierKeysToMultiSelect
* @methodOf ui.grid.selection.api:PublicApi
* @description Sets the current gridOption.modifierKeysToMultiSelect to true or false
* @param {bool} modifierKeysToMultiSelect true to only allow multiple rows when using ctrlKey or shiftKey is used
*/
setModifierKeysToMultiSelect: function (modifierKeysToMultiSelect) {
grid.options.modifierKeysToMultiSelect = modifierKeysToMultiSelect;
},
/**
* @ngdoc function
* @name getSelectAllState
* @methodOf ui.grid.selection.api:PublicApi
* @description Returns whether or not the selectAll checkbox is currently ticked. The
* grid doesn't automatically select rows when you add extra data - so when you add data
* you need to explicitly check whether the selectAll is set, and then call setVisible rows
* if it is
*/
getSelectAllState: function () {
return grid.selection.selectAll;
}
}
}
};
grid.api.registerEventsFromObject(publicApi.events);
grid.api.registerMethodsFromObject(publicApi.methods);
},
defaultGridOptions: function (gridOptions) {
// default option to true unless it was explicitly set to false
/**
* @ngdoc object
* @name ui.grid.selection.api:GridOptions
*
* @description GridOptions for selection feature, these are available to be
* set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
*/
/**
* @ngdoc object
* @name enableRowSelection
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable row selection for entire grid.
* <br/>Defaults to true
*/
gridOptions.enableRowSelection = gridOptions.enableRowSelection !== false;
/**
* @ngdoc object
* @name multiSelect
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable multiple row selection for entire grid
* <br/>Defaults to true
*/
gridOptions.multiSelect = gridOptions.multiSelect !== false;
/**
* @ngdoc object
* @name noUnselect
* @propertyOf ui.grid.selection.api:GridOptions
* @description Prevent a row from being unselected. Works in conjunction
* with `multiselect = false` and `gridApi.selection.selectRow()` to allow
* you to create a single selection only grid - a row is always selected, you
* can only select different rows, you can't unselect the row.
* <br/>Defaults to false
*/
gridOptions.noUnselect = gridOptions.noUnselect === true;
/**
* @ngdoc object
* @name modifierKeysToMultiSelect
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable multiple row selection only when using the ctrlKey or shiftKey. Requires multiSelect to be true.
* <br/>Defaults to false
*/
gridOptions.modifierKeysToMultiSelect = gridOptions.modifierKeysToMultiSelect === true;
/**
* @ngdoc object
* @name enableRowHeaderSelection
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable a row header to be used for selection
* <br/>Defaults to true
*/
gridOptions.enableRowHeaderSelection = gridOptions.enableRowHeaderSelection !== false;
/**
* @ngdoc object
* @name enableFullRowSelection
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable selection by clicking anywhere on the row. Defaults to
* false if `enableRowHeaderSelection` is true, otherwise defaults to true.
*/
if (typeof (gridOptions.enableFullRowSelection) === 'undefined') {
gridOptions.enableFullRowSelection = !gridOptions.enableRowHeaderSelection;
}
/**
* @ngdoc object
* @name enableFocusRowOnRowHeaderClick
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable focuse row by clicking on the row header. Defaults to
* true if `enableRowHeaderSelection` is true, otherwise defaults to false.
*/
gridOptions.enableFocusRowOnRowHeaderClick = (gridOptions.enableFocusRowOnRowHeaderClick !== false)
|| !gridOptions.enableRowHeaderSelection;
/**
* @ngdoc object
* @name enableSelectRowOnFocus
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable focuse row by clicking on the row anywhere. Defaults true.
*/
gridOptions.enableSelectRowOnFocus = (gridOptions.enableSelectRowOnFocus !== false);
/**
* @ngdoc object
* @name enableSelectAll
* @propertyOf ui.grid.selection.api:GridOptions
* @description Enable the select all checkbox at the top of the selectionRowHeader
* <br/>Defaults to true
*/
gridOptions.enableSelectAll = gridOptions.enableSelectAll !== false;
/**
* @ngdoc object
* @name enableSelectionBatchEvent
* @propertyOf ui.grid.selection.api:GridOptions
* @description If selected rows are changed in bulk, either via the API or
* via the selectAll checkbox, then a separate event is fired. Setting this
* option to false will cause the rowSelectionChanged event to be called multiple times
* instead
* <br/>Defaults to true
*/
gridOptions.enableSelectionBatchEvent = gridOptions.enableSelectionBatchEvent !== false;
/**
* @ngdoc object
* @name selectionRowHeaderWidth
* @propertyOf ui.grid.selection.api:GridOptions
* @description can be used to set a custom width for the row header selection column
* <br/>Defaults to 30px
*/
gridOptions.selectionRowHeaderWidth = angular.isDefined(gridOptions.selectionRowHeaderWidth) ? gridOptions.selectionRowHeaderWidth : 30;
/**
* @ngdoc object
* @name enableFooterTotalSelected
* @propertyOf ui.grid.selection.api:GridOptions
* @description Shows the total number of selected items in footer if true.
* <br/>Defaults to true.
* <br/>GridOptions.showGridFooter must also be set to true.
*/
gridOptions.enableFooterTotalSelected = gridOptions.enableFooterTotalSelected !== false;
/**
* @ngdoc object
* @name isRowSelectable
* @propertyOf ui.grid.selection.api:GridOptions
* @description Makes it possible to specify a method that evaluates for each row and sets its "enableSelection" property.
*/
gridOptions.isRowSelectable = angular.isDefined(gridOptions.isRowSelectable) ? gridOptions.isRowSelectable : angular.noop;
},
/**
* @ngdoc function
* @name toggleRowSelection
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description Toggles row as selected or unselected
* @param {Grid} grid grid object
* @param {GridRow} row row to select or deselect
* @param {Event} evt object if resulting from event
* @param {bool} multiSelect if false, only one row at time can be selected
* @param {bool} noUnselect if true then rows cannot be unselected
* @param {bool} [canBeInvisible=true] if false, row can only be selected when it's (theoretically) visible
*/
toggleRowSelection: function (grid, row, evt, multiSelect, noUnselect, canBeInvisible) {
if ( row.enableSelection === false ) {
return;
}
if (canBeInvisible === void 0) {
canBeInvisible = true;
}
var selected = row.isSelected;
if (!multiSelect) {
if (!selected) {
service.clearSelectedRows(grid, evt);
}
else if (service.getSelectedRows(grid).length > 1) {
selected = false; // Enable reselect of the row
service.clearSelectedRows(grid, evt);
}
}
// only select row in this case
if (!(selected && noUnselect) && (canBeInvisible || row.visible)) {
row.setSelected(!selected);
if (row.isSelected === true) {
grid.selection.lastSelectedRow = row;
}
grid.selection.selectAll = grid.rows.length === service.getSelectedRows(grid).length;
grid.api.selection.raise.rowSelectionChanged(row, evt);
}
},
/**
* @ngdoc function
* @name shiftSelect
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description selects a group of rows from the last selected row using the shift key
* @param {Grid} grid grid object
* @param {GridRow} row clicked row
* @param {Event} evt object if raised from an event
* @param {bool} multiSelect if false, does nothing this is for multiSelect only
*/
shiftSelect: function (grid, row, evt, multiSelect) {
if (!multiSelect) {
return;
}
var selectedRows = service.getSelectedRows(grid);
var fromRow = selectedRows.length > 0 ? grid.renderContainers.body.visibleRowCache.indexOf(grid.selection.lastSelectedRow) : 0;
var toRow = grid.renderContainers.body.visibleRowCache.indexOf(row);
// reverse select direction
if (fromRow > toRow) {
var tmp = fromRow;
fromRow = toRow;
toRow = tmp;
}
var changedRows = [];
for (var i = fromRow; i <= toRow; i++) {
var rowToSelect = grid.renderContainers.body.visibleRowCache[i];
if (rowToSelect) {
if (!rowToSelect.isSelected && rowToSelect.enableSelection !== false) {
rowToSelect.setSelected(true);
grid.selection.lastSelectedRow = rowToSelect;
service.decideRaiseSelectionEvent(grid, rowToSelect, changedRows, evt);
}
}
}
service.decideRaiseSelectionBatchEvent(grid, changedRows, evt);
},
/**
* @ngdoc function
* @name getSelectedRows
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description Returns all the selected rows
* @param {Grid} grid grid object
*/
getSelectedRows: function (grid) {
return grid.rows.filter(function (row) {
return row.isSelected;
});
},
/**
* @ngdoc function
* @name getUnSelectedRows
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description Returns all the unselected rows
* @param {Grid} grid grid object
*/
getUnSelectedRows: function (grid) {
return grid.rows.filter(function (row) {
return !row.isSelected;
});
},
/**
* @ngdoc function
* @name mapAndFilterRowsByEntity
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description Filters all rows by entity and then maps them to Array.
*/
mapAndFilterRowsByEntity: function(gridRows) {
if (typeof gridRows.reduce === 'function') { // If reduce is available it will be taken, due to better performance
return gridRows.reduce(function (previousVal, currentRow) {
if (currentRow.entity.hasOwnProperty('$$hashKey') || !angular.isObject(currentRow.entity)) {
previousVal.push(currentRow.entity);
}
return previousVal;
}, []);
}
return gridRows.filter(function (gridRow) { // stays as polyfill
return gridRow.entity.hasOwnProperty('$$hashKey') || !angular.isObject(gridRow.entity);
}).map(function (gridRow) {
return gridRow.entity;
});
},
/**
* @ngdoc function
* @name clearSelectedRows
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description Clears all selected rows
* @param {Grid} grid grid object
* @param {Event} evt object if raised from an event
*/
clearSelectedRows: function (grid, evt) {
var changedRows = [];
service.getSelectedRows(grid).forEach(function (row) {
if (row.isSelected && row.enableSelection !== false) {
row.setSelected(false);
service.decideRaiseSelectionEvent(grid, row, changedRows, evt);
}
});
grid.selection.selectAll = false;
grid.selection.selectedCount = 0;
service.decideRaiseSelectionBatchEvent(grid, changedRows, evt);
},
/**
* @ngdoc function
* @name decideRaiseSelectionEvent
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description Decides whether to raise a single event or a batch event
* @param {Grid} grid grid object
* @param {GridRow} row row that has changed
* @param {array} changedRows an array to which we can append the changed
* @param {Event} evt object if raised from an event
* row if we're doing batch events
*/
decideRaiseSelectionEvent: function (grid, row, changedRows, evt) {
if (!grid.options.enableSelectionBatchEvent) {
grid.api.selection.raise.rowSelectionChanged(row, evt);
}
else {
changedRows.push(row);
}
},
/**
* @ngdoc function
* @name raiseSelectionEvent
* @methodOf ui.grid.selection.service:uiGridSelectionService
* @description Decides whether we need to raise a batch event, and
* raises it if we do.
* @param {Grid} grid grid object
* @param {array} changedRows an array of changed rows, only populated
* @param {Event} evt object if raised from an event
* if we're doing batch events
*/
decideRaiseSelectionBatchEvent: function (grid, changedRows, evt) {
if (changedRows.length > 0) {
grid.api.selection.raise.rowSelectionChangedBatch(changedRows, evt);
}
}
};
return service;
});
/**
* @ngdoc directive
* @name ui.grid.selection.directive:uiGridSelection
* @element div
* @restrict A
*
* @description Adds selection features to grid
*
* @example
<example module="app">
<file name="app.js">
var app = angular.module('app', ['ui.grid', 'ui.grid.selection']);
app.controller('MainCtrl', ['$scope', function ($scope) {
$scope.data = [
{ name: 'Bob', title: 'CEO' },
{ name: 'Frank', title: 'Lowly Developer' }
];
$scope.columnDefs = [
{name: 'name', enableCellEdit: true},
{name: 'title', enableCellEdit: true}
];
}]);
</file>
<file name="index.html">
<div ng-controller="MainCtrl">
<div ui-grid="{ data: data, columnDefs: columnDefs }" ui-grid-selection></div>
</div>
</file>
</example>
*/
module.directive('uiGridSelection', ['i18nService', 'uiGridSelectionConstants', 'uiGridSelectionService', 'uiGridConstants',
function (i18nService, uiGridSelectionConstants, uiGridSelectionService, uiGridConstants) {
return {
replace: true,
priority: 0,
require: '^uiGrid',
scope: false,
compile: function () {
return {
pre: function ($scope, $elm, $attrs, uiGridCtrl) {
uiGridSelectionService.initializeGrid(uiGridCtrl.grid);
if (uiGridCtrl.grid.options.enableRowHeaderSelection) {
var selectionRowHeaderDef = {
name: uiGridSelectionConstants.selectionRowHeaderColName,
displayName: i18nService.getSafeText('selection.displayName'),
width: uiGridCtrl.grid.options.selectionRowHeaderWidth,
minWidth: 10,
cellTemplate: 'ui-grid/selectionRowHeader',
headerCellTemplate: 'ui-grid/selectionHeaderCell',
enableColumnResizing: false,
enableColumnMenu: false,
exporterSuppressExport: true,
allowCellFocus: true
};
uiGridCtrl.grid.addRowHeaderColumn(selectionRowHeaderDef, 0);
}
var processorSet = false;
var processSelectableRows = function (rows) {
rows.forEach(function (row) {
row.enableSelection = uiGridCtrl.grid.options.isRowSelectable(row);
});
return rows;
};
var updateOptions = function () {
if (uiGridCtrl.grid.options.isRowSelectable !== angular.noop && processorSet !== true) {
uiGridCtrl.grid.registerRowsProcessor(processSelectableRows, 500);
processorSet = true;
}
};
updateOptions();
var dataChangeDereg = uiGridCtrl.grid.registerDataChangeCallback(updateOptions, [uiGridConstants.dataChange.OPTIONS]);
$scope.$on('$destroy', dataChangeDereg);
},
post: function ($scope, $elm, $attrs, uiGridCtrl) {
}
};
}
};
}]);
module.directive('uiGridSelectionRowHeaderButtons', ['$templateCache', 'uiGridSelectionService', 'gridUtil',
function ($templateCache, uiGridSelectionService, gridUtil) {
return {
replace: true,
restrict: 'E',
template: $templateCache.get('ui-grid/selectionRowHeaderButtons'),
scope: true,
require: '^uiGrid',
link: function ($scope, $elm, $attrs, uiGridCtrl) {
var self = uiGridCtrl.grid;
$scope.selectButtonClick = selectButtonClick;
$scope.selectButtonKeyDown = selectButtonKeyDown;
// On IE, prevent mousedowns on the select button from starting a selection.
// If this is not done and you shift+click on another row, the browser will select a big chunk of text
if (gridUtil.detectBrowser() === 'ie') {
$elm.on('mousedown', selectButtonMouseDown);
}
function selectButtonKeyDown(row, evt) {
if (evt.keyCode === 32 || evt.keyCode === 13) {
evt.preventDefault();
selectButtonClick(row, evt);
}
}
function selectButtonClick(row, evt) {
evt.stopPropagation();
if (evt.shiftKey) {
uiGridSelectionService.shiftSelect(self, row, evt, self.options.multiSelect);
}
else if (evt.ctrlKey || evt.metaKey) {
uiGridSelectionService.toggleRowSelection(self, row, evt,
self.options.multiSelect, self.options.noUnselect, false);
}
else if (row.groupHeader) {
uiGridSelectionService.toggleRowSelection(self, row, evt, self.options.multiSelect, self.options.noUnselect, false);
for (var i = 0; i < row.treeNode.children.length; i++) {
uiGridSelectionService.toggleRowSelection(self, row.treeNode.children[i].row, evt, self.options.multiSelect, self.options.noUnselect, false);
}
}
else {
uiGridSelectionService.toggleRowSelection(self, row, evt,
(self.options.multiSelect && !self.options.modifierKeysToMultiSelect), self.options.noUnselect, false);
}
self.options.enableFocusRowOnRowHeaderClick && row.setFocused(!row.isFocused) && self.api.selection.raise.rowFocusChanged(row, evt);
}
function selectButtonMouseDown(evt) {
if (evt.ctrlKey || evt.shiftKey) {
evt.target.onselectstart = function () { return false; };
window.setTimeout(function () { evt.target.onselectstart = null; }, 0);
}
}
$scope.$on('$destroy', function unbindEvents() {
$elm.off();
});
}
};
}]);
module.directive('uiGridSelectionSelectAllButtons', ['$templateCache', 'uiGridSelectionService',
function ($templateCache, uiGridSelectionService) {
return {
replace: true,
restrict: 'E',
template: $templateCache.get('ui-grid/selectionSelectAllButtons'),
scope: false,
link: function ($scope) {
var self = $scope.col.grid;
$scope.headerButtonKeyDown = function (evt) {
if (evt.keyCode === 32 || evt.keyCode === 13) {
evt.preventDefault();
$scope.headerButtonClick(evt);
}
};
$scope.headerButtonClick = function (evt) {
if (self.selection.selectAll) {
uiGridSelectionService.clearSelectedRows(self, evt);
if (self.options.noUnselect) {
self.api.selection.selectRowByVisibleIndex(0, evt);
}
self.selection.selectAll = false;
}
else if (self.options.multiSelect) {
self.api.selection.selectAllVisibleRows(evt);
self.selection.selectAll = true;
}
};
}
};
}]);
/**
* @ngdoc directive
* @name ui.grid.selection.directive:uiGridViewport
* @element div
*
* @description Stacks on top of ui.grid.uiGridViewport to alter the attributes used
* for the grid row
*/
module.directive('uiGridViewport',
function () {
return {
priority: -200, // run after default directive
scope: false,
compile: function ($elm) {
var rowRepeatDiv = angular.element($elm[0].querySelector('.ui-grid-canvas:not(.ui-grid-empty-base-layer-container)').children[0]),
newNgClass = "'ui-grid-row-selected': row.isSelected, 'ui-grid-row-focused': row.isFocused}",
existingNgClass = rowRepeatDiv.attr('ng-class');
if (existingNgClass) {
newNgClass = existingNgClass.slice(0, -1) + ',' + newNgClass;
} else {
newNgClass = '{' + newNgClass;
}
rowRepeatDiv.attr('ng-class', newNgClass);
return {
pre: function ($scope, $elm, $attrs, controllers) {},
post: function ($scope, $elm, $attrs, controllers) {}
};
}
};
});
/**
* @ngdoc directive
* @name ui.grid.selection.directive:uiGridCell
* @element div
* @restrict A
*
* @description Stacks on top of ui.grid.uiGridCell to provide selection feature
*/
module.directive('uiGridCell',