-
Notifications
You must be signed in to change notification settings - Fork 78
/
ui-grid.cellnav.js
1181 lines (1017 loc) · 47.7 KB
/
ui-grid.cellnav.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.cellNav
*
* @description
#ui.grid.cellNav
<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>
This module provides cell navigation functionality to UI-Grid.
*/
var module = angular.module('ui.grid.cellNav', ['ui.grid']);
/**
* @ngdoc object
* @name ui.grid.cellNav.constant:uiGridCellNavConstants
*
* @description constants available in cellNav
*/
module.constant('uiGridCellNavConstants', {
FEATURE_NAME: 'gridCellNav',
CELL_NAV_EVENT: 'cellNav',
direction: {LEFT: 0, RIGHT: 1, UP: 2, DOWN: 3, PG_UP: 4, PG_DOWN: 5},
EVENT_TYPE: {
KEYDOWN: 0,
CLICK: 1,
CLEAR: 2
}
});
module.factory('uiGridCellNavFactory', ['uiGridCellNavConstants', 'GridRowColumn',
function (uiGridCellNavConstants, GridRowColumn) {
/**
* @ngdoc object
* @name ui.grid.cellNav.object:CellNav
* @description returns a CellNav prototype function
* @param {object} rowContainer container for rows
* @param {object} colContainer parent column container
* @param {object} leftColContainer column container to the left of parent
* @param {object} rightColContainer column container to the right of parent
*/
var UiGridCellNav = function UiGridCellNav(rowContainer, colContainer, leftColContainer, rightColContainer) {
this.rows = rowContainer.visibleRowCache;
this.columns = colContainer.visibleColumnCache;
this.leftColumns = leftColContainer ? leftColContainer.visibleColumnCache : [];
this.rightColumns = rightColContainer ? rightColContainer.visibleColumnCache : [];
this.bodyContainer = rowContainer;
};
/** returns focusable columns of all containers */
UiGridCellNav.prototype.getFocusableCols = function () {
var allColumns = this.leftColumns.concat(this.columns, this.rightColumns);
return allColumns.filter(function (col) {
return col.colDef.allowCellFocus;
});
};
/**
* @ngdoc object
* @name ui.grid.cellNav.api:GridRow
*
* @description GridRow settings for cellNav feature, these are available to be
* set only internally (for example, by other features)
*/
/**
* @ngdoc object
* @name allowCellFocus
* @propertyOf ui.grid.cellNav.api:GridRow
* @description Enable focus on a cell within this row. If set to false then no cells
* in this row can be focused - group header rows as an example would set this to false.
* <br/>Defaults to true
*/
/** returns focusable rows */
UiGridCellNav.prototype.getFocusableRows = function () {
return this.rows.filter(function(row) {
return row.allowCellFocus !== false;
});
};
UiGridCellNav.prototype.getNextRowCol = function (direction, curRow, curCol) {
switch (direction) {
case uiGridCellNavConstants.direction.LEFT:
return this.getRowColLeft(curRow, curCol);
case uiGridCellNavConstants.direction.RIGHT:
return this.getRowColRight(curRow, curCol);
case uiGridCellNavConstants.direction.UP:
return this.getRowColUp(curRow, curCol);
case uiGridCellNavConstants.direction.DOWN:
return this.getRowColDown(curRow, curCol);
case uiGridCellNavConstants.direction.PG_UP:
return this.getRowColPageUp(curRow, curCol);
case uiGridCellNavConstants.direction.PG_DOWN:
return this.getRowColPageDown(curRow, curCol);
}
};
UiGridCellNav.prototype.initializeSelection = function () {
var focusableCols = this.getFocusableCols();
var focusableRows = this.getFocusableRows();
if (focusableCols.length === 0 || focusableRows.length === 0) {
return null;
}
return new GridRowColumn(focusableRows[0], focusableCols[0]); // return same row
};
UiGridCellNav.prototype.getRowColLeft = function (curRow, curCol) {
var focusableCols = this.getFocusableCols();
var focusableRows = this.getFocusableRows();
var curColIndex = focusableCols.indexOf(curCol);
var curRowIndex = focusableRows.indexOf(curRow);
// could not find column in focusable Columns so set it to 1
if (curColIndex === -1) {
curColIndex = 1;
}
var nextColIndex = curColIndex === 0 ? focusableCols.length - 1 : curColIndex - 1;
// get column to left
if (nextColIndex >= curColIndex) {
// On the first row
// if (curRowIndex === 0 && curColIndex === 0) {
// return null;
// }
if (curRowIndex === 0) {
return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row
}
else {
// up one row and far right column
return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[nextColIndex]);
}
}
else {
return new GridRowColumn(curRow, focusableCols[nextColIndex]);
}
};
UiGridCellNav.prototype.getRowColRight = function (curRow, curCol) {
var focusableCols = this.getFocusableCols();
var focusableRows = this.getFocusableRows();
var curColIndex = focusableCols.indexOf(curCol);
var curRowIndex = focusableRows.indexOf(curRow);
// could not find column in focusable Columns so set it to 0
if (curColIndex === -1) {
curColIndex = 0;
}
var nextColIndex = curColIndex === focusableCols.length - 1 ? 0 : curColIndex + 1;
if (nextColIndex <= curColIndex) {
if (curRowIndex === focusableRows.length - 1) {
return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row
}
else {
// down one row and far left column
return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[nextColIndex]);
}
}
else {
return new GridRowColumn(curRow, focusableCols[nextColIndex]);
}
};
UiGridCellNav.prototype.getRowColDown = function (curRow, curCol) {
var focusableCols = this.getFocusableCols();
var focusableRows = this.getFocusableRows();
var curColIndex = focusableCols.indexOf(curCol);
var curRowIndex = focusableRows.indexOf(curRow);
// could not find column in focusable Columns so set it to 0
if (curColIndex === -1) {
curColIndex = 0;
}
if (curRowIndex === focusableRows.length - 1) {
return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row
}
else {
// down one row
return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[curColIndex]);
}
};
UiGridCellNav.prototype.getRowColPageDown = function (curRow, curCol) {
var focusableCols = this.getFocusableCols();
var focusableRows = this.getFocusableRows();
var curColIndex = focusableCols.indexOf(curCol);
var curRowIndex = focusableRows.indexOf(curRow);
// could not find column in focusable Columns so set it to 0
if (curColIndex === -1) {
curColIndex = 0;
}
var pageSize = this.bodyContainer.minRowsToRender();
if (curRowIndex >= focusableRows.length - pageSize) {
return new GridRowColumn(focusableRows[focusableRows.length - 1], focusableCols[curColIndex]); // return last row
}
else {
// down one page
return new GridRowColumn(focusableRows[curRowIndex + pageSize], focusableCols[curColIndex]);
}
};
UiGridCellNav.prototype.getRowColUp = function (curRow, curCol) {
var focusableCols = this.getFocusableCols();
var focusableRows = this.getFocusableRows();
var curColIndex = focusableCols.indexOf(curCol);
var curRowIndex = focusableRows.indexOf(curRow);
// could not find column in focusable Columns so set it to 0
if (curColIndex === -1) {
curColIndex = 0;
}
if (curRowIndex === 0) {
return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row
}
else {
// up one row
return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[curColIndex]);
}
};
UiGridCellNav.prototype.getRowColPageUp = function (curRow, curCol) {
var focusableCols = this.getFocusableCols();
var focusableRows = this.getFocusableRows();
var curColIndex = focusableCols.indexOf(curCol);
var curRowIndex = focusableRows.indexOf(curRow);
// could not find column in focusable Columns so set it to 0
if (curColIndex === -1) {
curColIndex = 0;
}
var pageSize = this.bodyContainer.minRowsToRender();
if (curRowIndex - pageSize < 0) {
return new GridRowColumn(focusableRows[0], focusableCols[curColIndex]); // return first row
}
else {
// up one page
return new GridRowColumn(focusableRows[curRowIndex - pageSize], focusableCols[curColIndex]);
}
};
return UiGridCellNav;
}]);
/**
* @ngdoc service
* @name ui.grid.cellNav.service:uiGridCellNavService
*
* @description Services for cell navigation features. If you don't like the key maps we use,
* or the direction cells navigation, override with a service decorator (see angular docs)
*/
module.service('uiGridCellNavService', ['uiGridConstants', 'uiGridCellNavConstants', '$q', 'uiGridCellNavFactory',
function (uiGridConstants, uiGridCellNavConstants, $q, UiGridCellNav) {
var service = {
initializeGrid: function (grid) {
grid.registerColumnBuilder(service.cellNavColumnBuilder);
/**
* @ngdoc object
* @name ui.grid.cellNav.Grid:cellNav
* @description cellNav properties added to grid class
*/
grid.cellNav = {};
grid.cellNav.lastRowCol = null;
grid.cellNav.focusedCells = [];
service.defaultGridOptions(grid.options);
/**
* @ngdoc object
* @name ui.grid.cellNav.api:PublicApi
*
* @description Public Api for cellNav feature
*/
var publicApi = {
events: {
cellNav: {
/**
* @ngdoc event
* @name navigate
* @eventOf ui.grid.cellNav.api:PublicApi
* @description raised when the active cell is changed
* <pre>
* gridApi.cellNav.on.navigate(scope,function(newRowcol, oldRowCol) {})
* </pre>
* @param {object} newRowCol new position
* @param {object} oldRowCol old position
*/
navigate: function (newRowCol, oldRowCol) {},
/**
* @ngdoc event
* @name viewPortKeyDown
* @eventOf ui.grid.cellNav.api:PublicApi
* @description is raised when the viewPort receives a keyDown event. Cells never get focus in uiGrid
* due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this
* event whenever you need a keydown event on a cell
* <br/>
* @param {object} event keydown event
* @param {object} rowCol current rowCol position
*/
viewPortKeyDown: function (event, rowCol) {},
/**
* @ngdoc event
* @name viewPortKeyPress
* @eventOf ui.grid.cellNav.api:PublicApi
* @description is raised when the viewPort receives a keyPress event. Cells never get focus in uiGrid
* due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this
* event whenever you need a keypress event on a cell
* <br/>
* @param {object} event keypress event
* @param {object} rowCol current rowCol position
*/
viewPortKeyPress: function (event, rowCol) {}
}
},
methods: {
cellNav: {
/**
* @ngdoc function
* @name scrollToFocus
* @methodOf ui.grid.cellNav.api:PublicApi
* @description brings the specified row and column into view, and sets focus
* to that cell
* @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus
* @param {object} colDef to make visible and set focus
* @returns {promise} a promise that is resolved after any scrolling is finished
*/
scrollToFocus: function (rowEntity, colDef) {
return service.scrollToFocus(grid, rowEntity, colDef);
},
/**
* @ngdoc function
* @name getFocusedCell
* @methodOf ui.grid.cellNav.api:PublicApi
* @description returns the current (or last if Grid does not have focus) focused row and column
* <br> value is null if no selection has occurred
*/
getFocusedCell: function () {
return grid.cellNav.lastRowCol;
},
/**
* @ngdoc function
* @name getCurrentSelection
* @methodOf ui.grid.cellNav.api:PublicApi
* @description returns an array containing the current selection
* <br> array is empty if no selection has occurred
*/
getCurrentSelection: function () {
return grid.cellNav.focusedCells;
},
/**
* @ngdoc function
* @name rowColSelectIndex
* @methodOf ui.grid.cellNav.api:PublicApi
* @description returns the index in the order in which the GridRowColumn was selected, returns -1 if the GridRowColumn
* isn't selected
* @param {object} rowCol the rowCol to evaluate
*/
rowColSelectIndex: function (rowCol) {
// return gridUtil.arrayContainsObjectWithProperty(grid.cellNav.focusedCells, 'col.uid', rowCol.col.uid) &&
var index = -1;
for (var i = 0; i < grid.cellNav.focusedCells.length; i++) {
if (grid.cellNav.focusedCells[i].col.uid === rowCol.col.uid &&
grid.cellNav.focusedCells[i].row.uid === rowCol.row.uid) {
index = i;
break;
}
}
return index;
}
}
}
};
grid.api.registerEventsFromObject(publicApi.events);
grid.api.registerMethodsFromObject(publicApi.methods);
},
defaultGridOptions: function (gridOptions) {
/**
* @ngdoc object
* @name ui.grid.cellNav.api:GridOptions
*
* @description GridOptions for cellNav feature, these are available to be
* set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
*/
/**
* @ngdoc object
* @name modifierKeysToMultiSelectCells
* @propertyOf ui.grid.cellNav.api:GridOptions
* @description Enable multiple cell selection only when using the ctrlKey or shiftKey.
* <br/>Defaults to false
*/
gridOptions.modifierKeysToMultiSelectCells = gridOptions.modifierKeysToMultiSelectCells === true;
/**
* @ngdoc array
* @name keyDownOverrides
* @propertyOf ui.grid.cellNav.api:GridOptions
* @description An array of event objects to override on keydown. If an event is overridden, the viewPortKeyDown event will
* be raised with the overridden events, allowing custom keydown behavior.
* <br/>Defaults to []
*/
gridOptions.keyDownOverrides = gridOptions.keyDownOverrides || [];
},
/**
* @ngdoc service
* @name decorateRenderContainers
* @methodOf ui.grid.cellNav.service:uiGridCellNavService
* @description decorates grid renderContainers with cellNav functions
*/
decorateRenderContainers: function (grid) {
var rightContainer = grid.hasRightContainer() ? grid.renderContainers.right : null;
var leftContainer = grid.hasLeftContainer() ? grid.renderContainers.left : null;
if (leftContainer !== null) {
grid.renderContainers.left.cellNav = new UiGridCellNav(grid.renderContainers.body, leftContainer, rightContainer, grid.renderContainers.body);
}
if (rightContainer !== null) {
grid.renderContainers.right.cellNav = new UiGridCellNav(grid.renderContainers.body, rightContainer, grid.renderContainers.body, leftContainer);
}
grid.renderContainers.body.cellNav = new UiGridCellNav(grid.renderContainers.body, grid.renderContainers.body, leftContainer, rightContainer);
},
/**
* @ngdoc service
* @name getDirection
* @methodOf ui.grid.cellNav.service:uiGridCellNavService
* @description determines which direction to for a given keyDown event
* @returns {uiGridCellNavConstants.direction} direction
*/
getDirection: function (evt) {
if (evt.keyCode === uiGridConstants.keymap.LEFT ||
(evt.keyCode === uiGridConstants.keymap.TAB && evt.shiftKey)) {
return uiGridCellNavConstants.direction.LEFT;
}
if (evt.keyCode === uiGridConstants.keymap.RIGHT ||
evt.keyCode === uiGridConstants.keymap.TAB) {
return uiGridCellNavConstants.direction.RIGHT;
}
if (evt.keyCode === uiGridConstants.keymap.UP ||
(evt.keyCode === uiGridConstants.keymap.ENTER && evt.shiftKey) ) {
return uiGridCellNavConstants.direction.UP;
}
if (evt.keyCode === uiGridConstants.keymap.PG_UP) {
return uiGridCellNavConstants.direction.PG_UP;
}
if (evt.keyCode === uiGridConstants.keymap.DOWN ||
evt.keyCode === uiGridConstants.keymap.ENTER && !(evt.ctrlKey || evt.altKey)) {
return uiGridCellNavConstants.direction.DOWN;
}
if (evt.keyCode === uiGridConstants.keymap.PG_DOWN) {
return uiGridCellNavConstants.direction.PG_DOWN;
}
return null;
},
/**
* @ngdoc service
* @name cellNavColumnBuilder
* @methodOf ui.grid.cellNav.service:uiGridCellNavService
* @description columnBuilder function that adds cell navigation properties to grid column
* @returns {promise} promise that will load any needed templates when resolved
*/
cellNavColumnBuilder: function (colDef, col, gridOptions) {
var promises = [];
/**
* @ngdoc object
* @name ui.grid.cellNav.api:ColumnDef
*
* @description Column Definitions for cellNav feature, these are available to be
* set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs}
*/
/**
* @ngdoc object
* @name allowCellFocus
* @propertyOf ui.grid.cellNav.api:ColumnDef
* @description Enable focus on a cell within this column.
* <br/>Defaults to true
*/
colDef.allowCellFocus = colDef.allowCellFocus === undefined ? true : colDef.allowCellFocus;
return $q.all(promises);
},
/**
* @ngdoc method
* @methodOf ui.grid.cellNav.service:uiGridCellNavService
* @name scrollToFocus
* @description Scroll the grid such that the specified
* row and column is in view, and set focus to the cell in that row and column
* @param {Grid} grid the grid you'd like to act upon, usually available
* from gridApi.grid
* @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus to
* @param {object} colDef to make visible and set focus to
* @returns {promise} a promise that is resolved after any scrolling is finished
*/
scrollToFocus: function (grid, rowEntity, colDef) {
var gridRow = null, gridCol = null;
if (typeof(rowEntity) !== 'undefined' && rowEntity !== null) {
gridRow = grid.getRow(rowEntity);
}
if (typeof(colDef) !== 'undefined' && colDef !== null) {
gridCol = grid.getColumn(colDef.name ? colDef.name : colDef.field);
}
return grid.api.core.scrollToIfNecessary(gridRow, gridCol).then(function () {
var rowCol = { row: gridRow, col: gridCol };
// Broadcast the navigation
if (gridRow !== null && gridCol !== null) {
grid.cellNav.broadcastCellNav(rowCol, null, null);
}
});
},
/**
* @ngdoc method
* @methodOf ui.grid.cellNav.service:uiGridCellNavService
* @name getLeftWidth
* @description Get the current drawn width of the columns in the
* grid up to the numbered column, and add an apportionment for the
* column that we're on. So if we are on column 0, we want to scroll
* 0% (i.e. exclude this column from calc). If we're on the last column
* we want to scroll to 100% (i.e. include this column in the calc). So
* we include (thisColIndex / totalNumberCols) % of this column width
* @param {Grid} grid the grid you'd like to act upon, usually available
* from gridApi.grid
* @param {GridColumn} upToCol the column to total up to and including
*/
getLeftWidth: function (grid, upToCol) {
var width = 0;
if (!upToCol) {
return width;
}
var lastIndex = grid.renderContainers.body.visibleColumnCache.indexOf( upToCol );
// total column widths up-to but not including the passed in column
grid.renderContainers.body.visibleColumnCache.forEach( function( col, index ) {
if ( index < lastIndex ) {
width += col.drawnWidth;
}
});
// pro-rata the final column based on % of total columns.
var percentage = lastIndex === 0 ? 0 : (lastIndex + 1) / grid.renderContainers.body.visibleColumnCache.length;
width += upToCol.drawnWidth * percentage;
return width;
}
};
return service;
}]);
/**
* @ngdoc directive
* @name ui.grid.cellNav.directive:uiCellNav
* @element div
* @restrict EA
*
* @description Adds cell navigation features to the grid columns
*
* @example
<example module="app">
<file name="app.js">
var app = angular.module('app', ['ui.grid', 'ui.grid.cellNav']);
app.controller('MainCtrl', ['$scope', function ($scope) {
$scope.data = [
{ name: 'Bob', title: 'CEO' },
{ name: 'Frank', title: 'Lowly Developer' }
];
$scope.columnDefs = [
{name: 'name'},
{name: 'title'}
];
}]);
</file>
<file name="index.html">
<div ng-controller="MainCtrl">
<div ui-grid="{ data: data, columnDefs: columnDefs }" ui-grid-cellnav></div>
</div>
</file>
</example>
*/
module.directive('uiGridCellnav', ['uiGridCellNavService', 'uiGridCellNavConstants', 'uiGridConstants', 'GridRowColumn', '$compile', 'i18nService',
function (uiGridCellNavService, uiGridCellNavConstants, uiGridConstants, GridRowColumn, $compile, i18nService) {
return {
replace: true,
priority: -150,
require: '^uiGrid',
scope: false,
controller: function () {},
compile: function () {
return {
pre: function ($scope, $elm, $attrs, uiGridCtrl) {
var _scope = $scope;
var grid = uiGridCtrl.grid;
uiGridCellNavService.initializeGrid(grid);
uiGridCtrl.cellNav = {};
// Ensure that the object has all of the methods we expect it to
uiGridCtrl.cellNav.makeRowCol = function (obj) {
if (!(obj instanceof GridRowColumn)) {
obj = new GridRowColumn(obj.row, obj.col);
}
return obj;
};
uiGridCtrl.cellNav.getActiveCell = function () {
var elms = $elm[0].getElementsByClassName('ui-grid-cell-focus');
if (elms.length > 0) {
return elms[0];
}
return undefined;
};
uiGridCtrl.cellNav.broadcastCellNav = grid.cellNav.broadcastCellNav = function (newRowCol, modifierDown, originEvt) {
modifierDown = !(modifierDown === undefined || !modifierDown);
newRowCol = uiGridCtrl.cellNav.makeRowCol(newRowCol);
uiGridCtrl.cellNav.broadcastFocus(newRowCol, modifierDown, originEvt);
_scope.$broadcast(uiGridCellNavConstants.CELL_NAV_EVENT, newRowCol, modifierDown, originEvt);
};
uiGridCtrl.cellNav.clearFocus = grid.cellNav.clearFocus = function () {
grid.cellNav.focusedCells = [];
_scope.$broadcast(uiGridCellNavConstants.CELL_NAV_EVENT);
};
uiGridCtrl.cellNav.broadcastFocus = function (rowCol, modifierDown, originEvt) {
modifierDown = !(modifierDown === undefined || !modifierDown);
rowCol = uiGridCtrl.cellNav.makeRowCol(rowCol);
var row = rowCol.row,
col = rowCol.col;
var rowColSelectIndex = uiGridCtrl.grid.api.cellNav.rowColSelectIndex(rowCol);
if (grid.cellNav.lastRowCol === null || rowColSelectIndex === -1 || (grid.cellNav.lastRowCol.col === col && grid.cellNav.lastRowCol.row === row)) {
var newRowCol = new GridRowColumn(row, col);
if (grid.cellNav.lastRowCol === null || grid.cellNav.lastRowCol.row !== newRowCol.row || grid.cellNav.lastRowCol.col !== newRowCol.col || grid.options.enableCellEditOnFocus) {
grid.api.cellNav.raise.navigate(newRowCol, grid.cellNav.lastRowCol, originEvt);
grid.cellNav.lastRowCol = newRowCol;
}
if (uiGridCtrl.grid.options.modifierKeysToMultiSelectCells && modifierDown) {
grid.cellNav.focusedCells.push(rowCol);
} else {
grid.cellNav.focusedCells = [rowCol];
}
} else if (grid.options.modifierKeysToMultiSelectCells && modifierDown &&
rowColSelectIndex >= 0) {
grid.cellNav.focusedCells.splice(rowColSelectIndex, 1);
}
};
uiGridCtrl.cellNav.handleKeyDown = function (evt) {
var direction = uiGridCellNavService.getDirection(evt);
if (direction === null) {
return null;
}
var containerId = 'body';
if (evt.uiGridTargetRenderContainerId) {
containerId = evt.uiGridTargetRenderContainerId;
}
// Get the last-focused row+col combo
var lastRowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
if (lastRowCol) {
// Figure out which new row+combo we're navigating to
var rowCol = uiGridCtrl.grid.renderContainers[containerId].cellNav.getNextRowCol(direction, lastRowCol.row, lastRowCol.col);
var focusableCols = uiGridCtrl.grid.renderContainers[containerId].cellNav.getFocusableCols();
var rowColSelectIndex = uiGridCtrl.grid.api.cellNav.rowColSelectIndex(rowCol);
// Shift+tab on top-left cell should exit cellnav on render container
if (
// Navigating left
direction === uiGridCellNavConstants.direction.LEFT &&
// New col is last col (i.e. wrap around)
rowCol.col === focusableCols[focusableCols.length - 1] &&
// Staying on same row, which means we're at first row
rowCol.row === lastRowCol.row &&
evt.keyCode === uiGridConstants.keymap.TAB &&
evt.shiftKey
) {
grid.cellNav.focusedCells.splice(rowColSelectIndex, 1);
uiGridCtrl.cellNav.clearFocus();
return true;
}
// Tab on bottom-right cell should exit cellnav on render container
else if (
direction === uiGridCellNavConstants.direction.RIGHT &&
// New col is first col (i.e. wrap around)
rowCol.col === focusableCols[0] &&
// Staying on same row, which means we're at first row
rowCol.row === lastRowCol.row &&
evt.keyCode === uiGridConstants.keymap.TAB &&
!evt.shiftKey
) {
grid.cellNav.focusedCells.splice(rowColSelectIndex, 1);
uiGridCtrl.cellNav.clearFocus();
return true;
}
// Scroll to the new cell, if it's not completely visible within the render container's viewport
grid.scrollToIfNecessary(rowCol.row, rowCol.col).then(function () {
uiGridCtrl.cellNav.broadcastCellNav(rowCol, null, evt);
});
evt.stopPropagation();
evt.preventDefault();
return false;
}
};
},
post: function ($scope, $elm, $attrs, uiGridCtrl) {
var grid = uiGridCtrl.grid;
var usesAria = true;
// Detect whether we are using ngAria
// (if ngAria module is not used then the stuff inside addAriaLiveRegion
// is not used and provides extra fluff)
try {
angular.module('ngAria');
}
catch (err) {
usesAria = false;
}
function addAriaLiveRegion() {
// Thanks to google docs for the inspiration behind how to do this
// XXX: Why is this entire mess nessasary?
// Because browsers take a lot of coercing to get them to read out live regions
// http://www.paciellogroup.com/blog/2012/06/html5-accessibility-chops-aria-rolealert-browser-support/
var ariaNotifierDomElt = '<div ' +
'id="' + grid.id +'-aria-speakable" ' +
'class="ui-grid-a11y-ariascreenreader-speakable ui-grid-offscreen" ' +
'aria-live="assertive" ' +
'role="alert" ' +
'aria-atomic="true" ' +
'aria-hidden="false" ' +
'aria-relevant="additions" ' +
'>' +
' ' +
'</div>';
var ariaNotifier = $compile(ariaNotifierDomElt)($scope);
$elm.prepend(ariaNotifier);
$scope.$on(uiGridCellNavConstants.CELL_NAV_EVENT, function (evt, rowCol, modifierDown, originEvt) {
/*
* If the cell nav event was because of a focus event then we don't want to
* change the notifier text.
* Reasoning: Voice Over fires a focus events when moving arround the grid.
* If the screen reader is handing the grid nav properly then we don't need to
* use the alert to notify the user of the movement.
* In all other cases we do want a notification event.
*/
if (originEvt && originEvt.type === 'focus') {return;}
function setNotifyText(text) {
if (text === ariaNotifier.text().trim()) {return;}
ariaNotifier[0].style.clip = 'rect(0px,0px,0px,0px)';
/*
* This is how google docs handles clearing the div. Seems to work better than setting the text of the div to ''
*/
ariaNotifier[0].innerHTML = "";
ariaNotifier[0].style.visibility = 'hidden';
ariaNotifier[0].style.visibility = 'visible';
if (text !== '') {
ariaNotifier[0].style.clip = 'auto';
/*
* The space after the text is something that google docs does.
*/
ariaNotifier[0].appendChild(document.createTextNode(text + " "));
ariaNotifier[0].style.visibility = 'hidden';
ariaNotifier[0].style.visibility = 'visible';
}
}
function getAppendedColumnHeaderText(col) {
return ', ' + i18nService.getSafeText('headerCell.aria.column') + ' ' + col.displayName;
}
function getCellDisplayValue(currentRowColumn) {
var prefix = '';
if (currentRowColumn.col.field === 'selectionRowHeaderCol') {
// This is the case when the 'selection' feature is used in the grid and the user has moved
// to or inside of the left grid container which holds the checkboxes for selecting rows.
// This is necessary for Accessibility. Without this a screen reader cannot determine if the row
// is or is not currently selected.
prefix = (currentRowColumn.row.isSelected ? i18nService.getSafeText('search.aria.selected') : i18nService.getSafeText('search.aria.notSelected')) + ', ';
}
return prefix + grid.getCellDisplayValue(currentRowColumn.row, currentRowColumn.col);
}
var values = [];
var currentSelection = grid.api.cellNav.getCurrentSelection();
for (var i = 0; i < currentSelection.length; i++) {
var cellDisplayValue = getCellDisplayValue(currentSelection[i]) + getAppendedColumnHeaderText(currentSelection[i].col);
values.push(cellDisplayValue);
}
setNotifyText(values.toString());
});
}
// Only add the ngAria stuff it will be used
if (usesAria) {
addAriaLiveRegion();
}
}
};
}
};
}]);
module.directive('uiGridRenderContainer', ['$timeout', 'gridUtil', 'uiGridCellNavService', '$compile','uiGridCellNavConstants',
function ($timeout, gridUtil, uiGridCellNavService, $compile, uiGridCellNavConstants) {
return {
replace: true,
priority: -99999, // this needs to run very last
require: ['^uiGrid', 'uiGridRenderContainer', '?^uiGridCellnav'],
scope: false,
compile: function () {
return {
post: function ($scope, $elm, $attrs, controllers) {
var uiGridCtrl = controllers[0],
renderContainerCtrl = controllers[1],
uiGridCellnavCtrl = controllers[2];
// Skip attaching cell-nav specific logic if the directive is not attached above us
if (!uiGridCtrl.grid.api.cellNav) { return; }
var containerId = renderContainerCtrl.containerId;
var grid = uiGridCtrl.grid;
// run each time a render container is created
uiGridCellNavService.decorateRenderContainers(grid);
// focusser only created for body
if (containerId !== 'body') {
return;
}
if (uiGridCtrl.grid.options.modifierKeysToMultiSelectCells) {
$elm.attr('aria-multiselectable', true);
}
else {
$elm.attr('aria-multiselectable', false);
}
// add an element with no dimensions that can be used to set focus and capture keystrokes
var focuser = $compile('<div class="ui-grid-focuser" role="region" aria-live="assertive" aria-atomic="false" tabindex="0" aria-controls="' + grid.id +'-aria-speakable '+ grid.id + '-grid-container' +'" aria-owns="' + grid.id + '-grid-container' + '"></div>')($scope);
$elm.append(focuser);
focuser.on('focus', function (evt) {
evt.uiGridTargetRenderContainerId = containerId;
var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
if (rowCol === null) {
rowCol = uiGridCtrl.grid.renderContainers[containerId].cellNav.getNextRowCol(uiGridCellNavConstants.direction.DOWN, null, null);
if (rowCol.row && rowCol.col) {
uiGridCtrl.cellNav.broadcastCellNav(rowCol);
}
}
});
uiGridCellnavCtrl.setAriaActivedescendant = function(id) {
$elm.attr('aria-activedescendant', id);
};
uiGridCellnavCtrl.removeAriaActivedescendant = function(id) {
if ($elm.attr('aria-activedescendant') === id) {
$elm.attr('aria-activedescendant', '');
}
};
uiGridCtrl.focus = function () {
gridUtil.focus.byElement(focuser[0]);
// allow for first time grid focus
};
var viewPortKeyDownWasRaisedForRowCol = null;
// Bind to keydown events in the render container
focuser.on('keydown', function (evt) {
evt.uiGridTargetRenderContainerId = containerId;
var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
var raiseViewPortKeyDown = uiGridCtrl.grid.options.keyDownOverrides.some(function (override) {
return Object.keys(override).every( function (property) {
return override[property] === evt[property];
});
});
var result = raiseViewPortKeyDown ? null : uiGridCtrl.cellNav.handleKeyDown(evt);
if (result === null) {
uiGridCtrl.grid.api.cellNav.raise.viewPortKeyDown(evt, rowCol, uiGridCtrl.cellNav.handleKeyDown);
viewPortKeyDownWasRaisedForRowCol = rowCol;
}
});
// Bind to keypress events in the render container
// keypress events are needed by edit function so the key press
// that initiated an edit is not lost
// must fire the event in a timeout so the editor can
// initialize and subscribe to the event on another event loop
focuser.on('keypress', function (evt) {
if (viewPortKeyDownWasRaisedForRowCol) {
$timeout(function () {
uiGridCtrl.grid.api.cellNav.raise.viewPortKeyPress(evt, viewPortKeyDownWasRaisedForRowCol);
}, 4);
viewPortKeyDownWasRaisedForRowCol = null;
}
});
$scope.$on('$destroy', function() {
// Remove all event handlers associated with this focuser.
focuser.off();
});
}
};
}
};
}]);
module.directive('uiGridViewport',
function () {
return {
replace: true,
priority: -99999, // this needs to run very last
require: ['^uiGrid', '^uiGridRenderContainer', '?^uiGridCellnav'],
scope: false,
compile: function () {
return {
pre: function ($scope, $elm, $attrs, uiGridCtrl) {
},
post: function ($scope, $elm, $attrs, controllers) {
var uiGridCtrl = controllers[0],
renderContainerCtrl = controllers[1];
// Skip attaching cell-nav specific logic if the directive is not attached above us
if (!uiGridCtrl.grid.api.cellNav) { return; }
var containerId = renderContainerCtrl.containerId;
// no need to process for other containers
if (containerId !== 'body') {
return;
}