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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const EventEmitter = require("devtools/shared/event-emitter");
loader.lazyRequireGetter(this, "setNamedTimeout",
"devtools/client/shared/widgets/view-helpers", true);
loader.lazyRequireGetter(this, "clearNamedTimeout",
"devtools/client/shared/widgets/view-helpers", true);
const {KeyCodes} = require("devtools/client/shared/keycodes");
const XUL_NS = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
const HTML_NS = "http://www.w3.org/1999/xhtml";
const AFTER_SCROLL_DELAY = 100;
// Different types of events emitted by the Various components of the
// TableWidget.
const EVENTS = {
CELL_EDIT: "cell-edit",
COLUMN_SORTED: "column-sorted",
COLUMN_TOGGLED: "column-toggled",
FIELDS_EDITABLE: "fields-editable",
HEADER_CONTEXT_MENU: "header-context-menu",
ROW_EDIT: "row-edit",
ROW_CONTEXT_MENU: "row-context-menu",
ROW_REMOVED: "row-removed",
ROW_SELECTED: "row-selected",
ROW_UPDATED: "row-updated",
TABLE_CLEARED: "table-cleared",
TABLE_FILTERED: "table-filtered",
SCROLL_END: "scroll-end"
};
Object.defineProperty(this, "EVENTS", {
value: EVENTS,
enumerable: true,
writable: false
});
/**
* A table widget with various features like resizble/toggleable columns,
* sorting, keyboard navigation etc.
*
* @param {nsIDOMNode} node
* The container element for the table widget.
* @param {object} options
* - initialColumns: map of key vs display name for initial columns of
* the table. See @setupColumns for more info.
* - uniqueId: the column which will be the unique identifier of each
* entry in the table. Default: name.
* - wrapTextInElements: Don't ever use 'value' attribute on labels.
* Default: false.
* - emptyText: text to display when no entries in the table to display.
* - highlightUpdated: true to highlight the changed/added row.
* - removableColumns: Whether columns are removeable. If set to false,
* the context menu in the headers will not appear.
* - firstColumn: key of the first column that should appear.
* - cellContextMenuId: ID of a <menupopup> element to be set as a
* context menu of every cell.
*/
function TableWidget(node, options = {}) {
EventEmitter.decorate(this);
this.document = node.ownerDocument;
this.window = this.document.defaultView;
this._parent = node;
let {initialColumns, emptyText, uniqueId, highlightUpdated, removableColumns,
firstColumn, wrapTextInElements, cellContextMenuId} = options;
this.emptyText = emptyText || "";
this.uniqueId = uniqueId || "name";
this.wrapTextInElements = wrapTextInElements || false;
this.firstColumn = firstColumn || "";
this.highlightUpdated = highlightUpdated || false;
this.removableColumns = removableColumns !== false;
this.cellContextMenuId = cellContextMenuId;
this.tbody = this.document.createElementNS(XUL_NS, "hbox");
this.tbody.className = "table-widget-body theme-body";
this.tbody.setAttribute("flex", "1");
this.tbody.setAttribute("tabindex", "0");
this._parent.appendChild(this.tbody);
this.afterScroll = this.afterScroll.bind(this);
this.tbody.addEventListener("scroll", this.onScroll.bind(this));
this.placeholder = this.document.createElementNS(XUL_NS, "label");
this.placeholder.className = "plain table-widget-empty-text";
this.placeholder.setAttribute("flex", "1");
this._parent.appendChild(this.placeholder);
this.items = new Map();
this.columns = new Map();
// Setup the column headers context menu to allow users to hide columns at
// will.
if (this.removableColumns) {
this.onPopupCommand = this.onPopupCommand.bind(this);
this.setupHeadersContextMenu();
}
if (initialColumns) {
this.setColumns(initialColumns, uniqueId);
} else if (this.emptyText) {
this.setPlaceholderText(this.emptyText);
}
this.bindSelectedRow = (event, id) => {
this.selectedRow = id;
};
this.on(EVENTS.ROW_SELECTED, this.bindSelectedRow);
this.onChange = this.onChange.bind(this);
this.onEditorDestroyed = this.onEditorDestroyed.bind(this);
this.onEditorTab = this.onEditorTab.bind(this);
this.onKeydown = this.onKeydown.bind(this);
this.onMousedown = this.onMousedown.bind(this);
this.onRowRemoved = this.onRowRemoved.bind(this);
this.document.addEventListener("keydown", this.onKeydown, false);
this.document.addEventListener("mousedown", this.onMousedown, false);
}
TableWidget.prototype = {
items: null,
/**
* Getter for the headers context menu popup id.
*/
get headersContextMenu() {
if (this.menupopup) {
return this.menupopup.id;
}
return null;
},
/**
* Select the row corresponding to the json object `id`
*/
set selectedRow(id) {
for (let column of this.columns.values()) {
column.selectRow(id[this.uniqueId] || id);
}
},
/**
* Returns the json object corresponding to the selected row.
*/
get selectedRow() {
return this.items.get(this.columns.get(this.uniqueId).selectedRow);
},
/**
* Selects the row at index `index`.
*/
set selectedIndex(index) {
for (let column of this.columns.values()) {
column.selectRowAt(index);
}
},
/**
* Returns the index of the selected row.
*/
get selectedIndex() {
return this.columns.get(this.uniqueId).selectedIndex;
},
/**
* Returns the index of the selected row disregarding hidden rows.
*/
get visibleSelectedIndex() {
let cells = this.columns.get(this.uniqueId).visibleCellNodes;
for (let i = 0; i < cells.length; i++) {
if (cells[i].classList.contains("theme-selected")) {
return i;
}
}
return -1;
},
/**
* returns all editable columns.
*/
get editableColumns() {
let filter = columns => {
columns = [...columns].filter(col => {
if (col.clientWidth === 0) {
return false;
}
let cell = col.querySelector(".table-widget-cell");
for (let selector of this._editableFieldsEngine.selectors) {
if (cell.matches(selector)) {
return true;
}
}
return false;
});
return columns;
};
let columns = this._parent.querySelectorAll(".table-widget-column");
return filter(columns);
},
/**
* Emit all cell edit events.
*/
onChange: function (type, data) {
let changedField = data.change.field;
let colName = changedField.parentNode.id;
let column = this.columns.get(colName);
let uniqueId = column.table.uniqueId;
let itemIndex = column.cellNodes.indexOf(changedField);
let items = {};
for (let [name, col] of this.columns) {
items[name] = col.cellNodes[itemIndex].value;
}
let change = {
host: this.host,
key: uniqueId,
field: colName,
oldValue: data.change.oldValue,
newValue: data.change.newValue,
items: items
};
// A rows position in the table can change as the result of an edit. In
// order to ensure that the correct row is highlighted after an edit we
// save the uniqueId in editBookmark.
this.editBookmark = colName === uniqueId ? change.newValue
: items[uniqueId];
this.emit(EVENTS.CELL_EDIT, change);
},
onEditorDestroyed: function () {
this._editableFieldsEngine = null;
},
/**
* Called by the inplace editor when Tab / Shift-Tab is pressed in edit-mode.
* Because tables are live any row, column, cell or table can be added,
* deleted or moved by deleting and adding e.g. a row again.
*
* This presents various challenges when navigating via the keyboard so please
* keep this in mind whenever editing this method.
*
* @param {Event} event
* Keydown event
*/
onEditorTab: function (event) {
let textbox = event.target;
let editor = this._editableFieldsEngine;
if (textbox.id !== editor.INPUT_ID) {
return;
}
let column = textbox.parentNode;
// Changing any value can change the position of the row depending on which
// column it is currently sorted on. In addition to this, the table cell may
// have been edited and had to be recreated when the user has pressed tab or
// shift+tab. Both of these situations require us to recover our target,
// select the appropriate row and move the textbox on to the next cell.
if (editor.changePending) {
// We need to apply a change, which can mean that the position of cells
// within the table can change. Because of this we need to wait for
// EVENTS.ROW_EDIT and then move the textbox.
this.once(EVENTS.ROW_EDIT, (e, uniqueId) => {
let cell;
let cells;
let columnObj;
let cols = this.editableColumns;
let rowIndex = this.visibleSelectedIndex;
let colIndex = cols.indexOf(column);
let newIndex;
// If the row has been deleted we should bail out.
if (!uniqueId) {
return;
}
// Find the column we need to move to.
if (event.shiftKey) {
// Navigate backwards on shift tab.
if (colIndex === 0) {
if (rowIndex === 0) {
return;
}
newIndex = cols.length - 1;
} else {
newIndex = colIndex - 1;
}
} else if (colIndex === cols.length - 1) {
let id = cols[0].id;
columnObj = this.columns.get(id);
let maxRowIndex = columnObj.visibleCellNodes.length - 1;
if (rowIndex === maxRowIndex) {
return;
}
newIndex = 0;
} else {
newIndex = colIndex + 1;
}
let newcol = cols[newIndex];
columnObj = this.columns.get(newcol.id);
// Select the correct row even if it has moved due to sorting.
let dataId = editor.currentTarget.getAttribute("data-id");
if (this.items.get(dataId)) {
this.emit(EVENTS.ROW_SELECTED, dataId);
} else {
this.emit(EVENTS.ROW_SELECTED, uniqueId);
}
// EVENTS.ROW_SELECTED may have changed the selected row so let's save
// the result in rowIndex.
rowIndex = this.visibleSelectedIndex;
// Edit the appropriate cell.
cells = columnObj.visibleCellNodes;
cell = cells[rowIndex];
editor.edit(cell);
// Remove flash-out class... it won't have been auto-removed because the
// cell was hidden for editing.
cell.classList.remove("flash-out");
});
}
// Begin cell edit. We always do this so that we can begin editing even in
// the case that the previous edit will cause the row to move.
let cell = this.getEditedCellOnTab(event, column);
editor.edit(cell);
},
/**
* Get the cell that will be edited next on tab / shift tab and highlight the
* appropriate row. Edits etc. are not taken into account.
*
* This is used to tab from one field to another without editing and makes the
* editor much more responsive.
*
* @param {Event} event
* Keydown event
*/
getEditedCellOnTab: function (event, column) {
let cell = null;
let cols = this.editableColumns;
let rowIndex = this.visibleSelectedIndex;
let colIndex = cols.indexOf(column);
let maxCol = cols.length - 1;
let maxRow = this.columns.get(column.id).visibleCellNodes.length - 1;
if (event.shiftKey) {
// Navigate backwards on shift tab.
if (colIndex === 0) {
if (rowIndex === 0) {
this._editableFieldsEngine.completeEdit();
return null;
}
column = cols[cols.length - 1];
let cells = this.columns.get(column.id).visibleCellNodes;
cell = cells[rowIndex - 1];
let rowId = cell.getAttribute("data-id");
this.emit(EVENTS.ROW_SELECTED, rowId);
} else {
column = cols[colIndex - 1];
let cells = this.columns.get(column.id).visibleCellNodes;
cell = cells[rowIndex];
}
} else if (colIndex === maxCol) {
// If in the rightmost column on the last row stop editing.
if (rowIndex === maxRow) {
this._editableFieldsEngine.completeEdit();
return null;
}
// If in the rightmost column of a row then move to the first column of
// the next row.
column = cols[0];
let cells = this.columns.get(column.id).visibleCellNodes;
cell = cells[rowIndex + 1];
let rowId = cell.getAttribute("data-id");
this.emit(EVENTS.ROW_SELECTED, rowId);
} else {
// Navigate forwards on tab.
column = cols[colIndex + 1];
let cells = this.columns.get(column.id).visibleCellNodes;
cell = cells[rowIndex];
}
return cell;
},
/**
* Reset the editable fields engine if the currently edited row is removed.
*
* @param {String} event
* The event name "event-removed."
* @param {Object} row
* The values from the removed row.
*/
onRowRemoved: function (event, row) {
if (!this._editableFieldsEngine || !this._editableFieldsEngine.isEditing) {
return;
}
let removedKey = row[this.uniqueId];
let column = this.columns.get(this.uniqueId);
if (removedKey in column.items) {
return;
}
// The target is lost so we need to hide the remove the textbox from the DOM
// and reset the target nodes.
this.onEditorTargetLost();
},
/**
* Cancel an edit because the edit target has been lost.
*/
onEditorTargetLost: function () {
let editor = this._editableFieldsEngine;
if (!editor || !editor.isEditing) {
return;
}
editor.cancelEdit();
},
/**
* Keydown event handler for the table. Used for keyboard navigation amongst
* rows.
*/
onKeydown: function (event) {
// If we are in edit mode bail out.
if (this._editableFieldsEngine && this._editableFieldsEngine.isEditing) {
return;
}
let selectedCell = this.tbody.querySelector(".theme-selected");
if (!selectedCell) {
return;
}
let colName;
let column;
let visibleCells;
let index;
let cell;
switch (event.keyCode) {
case KeyCodes.DOM_VK_UP:
event.preventDefault();
colName = selectedCell.parentNode.id;
column = this.columns.get(colName);
visibleCells = column.visibleCellNodes;
index = visibleCells.indexOf(selectedCell);
if (index > 0) {
index--;
} else {
index = visibleCells.length - 1;
}
cell = visibleCells[index];
this.emit(EVENTS.ROW_SELECTED, cell.getAttribute("data-id"));
break;
case KeyCodes.DOM_VK_DOWN:
event.preventDefault();
colName = selectedCell.parentNode.id;
column = this.columns.get(colName);
visibleCells = column.visibleCellNodes;
index = visibleCells.indexOf(selectedCell);
if (index === visibleCells.length - 1) {
index = 0;
} else {
index++;
}
cell = visibleCells[index];
this.emit(EVENTS.ROW_SELECTED, cell.getAttribute("data-id"));
break;
}
},
/**
* Close any editors if the area "outside the table" is clicked. In reality,
* the table covers the whole area but there are labels filling the top few
* rows. This method clears any inline editors if an area outside a textbox or
* label is clicked.
*/
onMousedown: function ({target}) {
let nodeName = target.nodeName;
if (nodeName === "textbox" || !this._editableFieldsEngine) {
return;
}
// Force any editor fields to hide due to XUL focus quirks.
this._editableFieldsEngine.blur();
},
/**
* Make table fields editable.
*
* @param {String|Array} editableColumns
* An array or comma separated list of editable column names.
*/
makeFieldsEditable: function (editableColumns) {
let selectors = [];
if (typeof editableColumns === "string") {
editableColumns = [editableColumns];
}
for (let id of editableColumns) {
selectors.push("#" + id + " .table-widget-cell");
}
for (let [name, column] of this.columns) {
if (!editableColumns.includes(name)) {
column.column.setAttribute("readonly", "");
}
}
if (this._editableFieldsEngine) {
this._editableFieldsEngine.selectors = selectors;
} else {
this._editableFieldsEngine = new EditableFieldsEngine({
root: this.tbody,
onTab: this.onEditorTab,
onTriggerEvent: "dblclick",
selectors: selectors
});
this._editableFieldsEngine.on("change", this.onChange);
this._editableFieldsEngine.on("destroyed", this.onEditorDestroyed);
this.on(EVENTS.ROW_REMOVED, this.onRowRemoved);
this.on(EVENTS.TABLE_CLEARED, this._editableFieldsEngine.cancelEdit);
this.emit(EVENTS.FIELDS_EDITABLE, this._editableFieldsEngine);
}
},
destroy: function () {
this.off(EVENTS.ROW_SELECTED, this.bindSelectedRow);
this.off(EVENTS.ROW_REMOVED, this.onRowRemoved);
this.document.removeEventListener("keydown", this.onKeydown, false);
this.document.removeEventListener("mousedown", this.onMousedown, false);
if (this._editableFieldsEngine) {
this.off(EVENTS.TABLE_CLEARED, this._editableFieldsEngine.cancelEdit);
this._editableFieldsEngine.off("change", this.onChange);
this._editableFieldsEngine.off("destroyed", this.onEditorDestroyed);
this._editableFieldsEngine.destroy();
this._editableFieldsEngine = null;
}
if (this.menupopup) {
this.menupopup.removeEventListener("command", this.onPopupCommand);
this.menupopup.remove();
}
},
/**
* Sets the text to be shown when the table is empty.
*/
setPlaceholderText: function (text) {
this.placeholder.setAttribute("value", text);
},
/**
* Prepares the context menu for the headers of the table columns. This
* context menu allows users to toggle various columns, only with an exception
* of the unique columns and when only two columns are visible in the table.
*/
setupHeadersContextMenu: function () {
let popupset = this.document.getElementsByTagName("popupset")[0];
if (!popupset) {
popupset = this.document.createElementNS(XUL_NS, "popupset");
this.document.documentElement.appendChild(popupset);
}
this.menupopup = this.document.createElementNS(XUL_NS, "menupopup");
this.menupopup.id = "table-widget-column-select";
this.menupopup.addEventListener("command", this.onPopupCommand);
popupset.appendChild(this.menupopup);
this.populateMenuPopup();
},
/**
* Populates the header context menu with the names of the columns along with
* displaying which columns are hidden or visible.
*
* @param {Array} privateColumns=[]
* An array of column names that should never appear in the table. This
* allows us to e.g. have an invisible compound primary key for a
* table's rows.
*/
populateMenuPopup: function (privateColumns = []) {
if (!this.menupopup) {
return;
}
while (this.menupopup.firstChild) {
this.menupopup.firstChild.remove();
}
for (let column of this.columns.values()) {
if (privateColumns.includes(column.id)) {
continue;
}
let menuitem = this.document.createElementNS(XUL_NS, "menuitem");
menuitem.setAttribute("label", column.header.getAttribute("value"));
menuitem.setAttribute("data-id", column.id);
menuitem.setAttribute("type", "checkbox");
menuitem.setAttribute("checked", !column.wrapper.getAttribute("hidden"));
if (column.id == this.uniqueId) {
menuitem.setAttribute("disabled", "true");
}
this.menupopup.appendChild(menuitem);
}
let checked = this.menupopup.querySelectorAll("menuitem[checked]");
if (checked.length == 2) {
checked[checked.length - 1].setAttribute("disabled", "true");
}
},
/**
* Event handler for the `command` event on the column headers context menu
*/
onPopupCommand: function (event) {
let item = event.originalTarget;
let checked = !!item.getAttribute("checked");
let id = item.getAttribute("data-id");
this.emit(EVENTS.HEADER_CONTEXT_MENU, id, checked);
checked = this.menupopup.querySelectorAll("menuitem[checked]");
let disabled = this.menupopup.querySelectorAll("menuitem[disabled]");
if (checked.length == 2) {
checked[checked.length - 1].setAttribute("disabled", "true");
} else if (disabled.length > 1) {
disabled[disabled.length - 1].removeAttribute("disabled");
}
},
/**
* Creates the columns in the table. Without calling this method, data cannot
* be inserted into the table unless `initialColumns` was supplied.
*
* @param {Object} columns
* A key value pair representing the columns of the table. Where the
* key represents the id of the column and the value is the displayed
* label in the header of the column.
* @param {String} sortOn
* The id of the column on which the table will be initially sorted on.
* @param {Array} hiddenColumns
* Ids of all the columns that are hidden by default.
* @param {Array} privateColumns=[]
* An array of column names that should never appear in the table. This
* allows us to e.g. have an invisible compound primary key for a
* table's rows.
*/
setColumns: function (columns, sortOn = this.sortedOn, hiddenColumns = [],
privateColumns = []) {
for (let column of this.columns.values()) {
column.destroy();
}
this.columns.clear();
if (!(sortOn in columns)) {
sortOn = null;
}
if (!(this.firstColumn in columns)) {
this.firstColumn = null;
}
if (this.firstColumn) {
this.columns.set(this.firstColumn,
new Column(this, this.firstColumn, columns[this.firstColumn]));
}
for (let id in columns) {
if (!sortOn) {
sortOn = id;
}
if (this.firstColumn && id == this.firstColumn) {
continue;
}
this.columns.set(id, new Column(this, id, columns[id]));
if (hiddenColumns.includes(id) || privateColumns.includes(id)) {
// Hide the column.
this.columns.get(id).toggleColumn();
}
}
this.sortedOn = sortOn;
this.sortBy(this.sortedOn);
this.populateMenuPopup(privateColumns);
},
/**
* Returns true if the passed string or the row json object corresponds to the
* selected item in the table.
*/
isSelected: function (item) {
if (typeof item == "object") {
item = item[this.uniqueId];
}
return this.selectedRow && item == this.selectedRow[this.uniqueId];
},
/**
* Selects the row corresponding to the `id` json.
*/
selectRow: function (id) {
this.selectedRow = id;
},
/**
* Selects the next row. Cycles over to the first row if last row is selected
*/
selectNextRow: function () {
for (let column of this.columns.values()) {
column.selectNextRow();
}
},
/**
* Selects the previous row. Cycles over to the last row if first row is
* selected.
*/
selectPreviousRow: function () {
for (let column of this.columns.values()) {
column.selectPreviousRow();
}
},
/**
* Clears any selected row.
*/
clearSelection: function () {
this.selectedIndex = -1;
},
/**
* Adds a row into the table.
*
* @param {object} item
* The object from which the key-value pairs will be taken and added
* into the row. This object can have any arbitarary key value pairs,
* but only those will be used whose keys match to the ids of the
* columns.
* @param {boolean} suppressFlash
* true to not flash the row while inserting the row.
*/
push: function (item, suppressFlash) {
if (!this.sortedOn || !this.columns) {
console.error("Can't insert item without defining columns first");
return;
}
if (this.items.has(item[this.uniqueId])) {
this.update(item);
return;
}
if (this.editBookmark && !this.items.has(this.editBookmark)) {
// Key has been updated... update bookmark.
this.editBookmark = item[this.uniqueId];
}
let index = this.columns.get(this.sortedOn).push(item);
for (let [key, column] of this.columns) {
if (key != this.sortedOn) {
column.insertAt(item, index);
}
column.updateZebra();
}
this.items.set(item[this.uniqueId], item);
this.tbody.removeAttribute("empty");
if (!suppressFlash) {
this.emit(EVENTS.ROW_UPDATED, item[this.uniqueId]);
}
this.emit(EVENTS.ROW_EDIT, item[this.uniqueId]);
},
/**
* Removes the row associated with the `item` object.
*/
remove: function (item) {
if (typeof item != "object") {
item = this.items.get(item);
}
if (!item) {
return;
}
let removed = this.items.delete(item[this.uniqueId]);
if (!removed) {
return;
}
for (let column of this.columns.values()) {
column.remove(item);
column.updateZebra();
}
if (this.items.size == 0) {
this.tbody.setAttribute("empty", "empty");
}
this.emit(EVENTS.ROW_REMOVED, item);
},
/**
* Updates the items in the row corresponding to the `item` object previously
* used to insert the row using `push` method. The linking is done via the
* `uniqueId` key's value.
*/
update: function (item) {
let oldItem = this.items.get(item[this.uniqueId]);
if (!oldItem) {
return;
}
this.items.set(item[this.uniqueId], item);
let changed = false;
for (let column of this.columns.values()) {
if (item[column.id] != oldItem[column.id]) {
column.update(item);
changed = true;
}
}
if (changed) {
this.emit(EVENTS.ROW_UPDATED, item[this.uniqueId]);
this.emit(EVENTS.ROW_EDIT, item[this.uniqueId]);
}
},
/**
* Removes all of the rows from the table.
*/
clear: function () {
this.items.clear();
for (let column of this.columns.values()) {
column.clear();
}
this.tbody.setAttribute("empty", "empty");
this.setPlaceholderText(this.emptyText);
this.emit(EVENTS.TABLE_CLEARED, this);
},
/**
* Sorts the table by a given column.
*
* @param {string} column
* The id of the column on which the table should be sorted.
*/
sortBy: function (column) {
this.emit(EVENTS.COLUMN_SORTED, column);
this.sortedOn = column;
if (!this.items.size) {
return;
}
let sortedItems = this.columns.get(column).sort([...this.items.values()]);
for (let [id, col] of this.columns) {
if (id != col) {
col.sort(sortedItems);
}
}
},
/**
* Filters the table based on a specific value
*
* @param {String} value: The filter value
* @param {Array} ignoreProps: Props to ignore while filtering
*/
filterItems(value, ignoreProps = []) {
if (this.filteredValue == value) {
return;
}
if (this._editableFieldsEngine) {
this._editableFieldsEngine.completeEdit();
}
this.filteredValue = value;
if (!value) {
this.emit(EVENTS.TABLE_FILTERED, []);
return;
}
// Shouldn't be case-sensitive
value = value.toLowerCase();
let itemsToHide = [...this.items.keys()];
// Loop through all items and hide unmatched items
for (let [id, val] of this.items) {
for (let prop in val) {
if (ignoreProps.includes(prop)) {
continue;
}
let propValue = val[prop].toString().toLowerCase();
if (propValue.includes(value)) {
itemsToHide.splice(itemsToHide.indexOf(id), 1);
break;
}
}
}
this.emit(EVENTS.TABLE_FILTERED, itemsToHide);
},
/**
* Calls the afterScroll function when the user has stopped scrolling
*/
onScroll: function () {
clearNamedTimeout("table-scroll");
setNamedTimeout("table-scroll", AFTER_SCROLL_DELAY, this.afterScroll);
},
/**
* Emits the "scroll-end" event when the whole table is scrolled
*/
afterScroll: function () {
let scrollHeight = this.tbody.getBoundingClientRect().height -
this.tbody.querySelector(".table-widget-column-header").clientHeight;
// Emit scroll-end event when 9/10 of the table is scrolled
if (this.tbody.scrollTop >= 0.9 * scrollHeight) {
this.emit("scroll-end");
}
}
};
TableWidget.EVENTS = EVENTS;
module.exports.TableWidget = TableWidget;
/**
* A single column object in the table.
*
* @param {TableWidget} table
* The table object to which the column belongs.
* @param {string} id
* Id of the column.
* @param {String} header
* The displayed string on the column's header.
*/
function Column(table, id, header) {
this.tbody = table.tbody;
this.document = table.document;
this.window = table.window;
this.id = id;
this.uniqueId = table.uniqueId;
this.wrapTextInElements = table.wrapTextInElements;
this.table = table;
this.cells = [];
this.items = {};
this.highlightUpdated = table.highlightUpdated;
// This wrapping element is required solely so that position:sticky works on
// the headers of the columns.
this.wrapper = this.document.createElementNS(XUL_NS, "vbox");
this.wrapper.className = "table-widget-wrapper";
this.wrapper.setAttribute("flex", "1");
this.wrapper.setAttribute("tabindex", "0");
this.tbody.appendChild(this.wrapper);
this.splitter = this.document.createElementNS(XUL_NS, "splitter");
this.splitter.className = "devtools-side-splitter";
this.tbody.appendChild(this.splitter);
this.column = this.document.createElementNS(HTML_NS, "div");
this.column.id = id;
this.column.className = "table-widget-column";
this.wrapper.appendChild(this.column);
this.header = this.document.createElementNS(XUL_NS, "label");
this.header.className = "devtools-toolbar table-widget-column-header";
this.header.setAttribute("value", header);
this.column.appendChild(this.header);
if (table.headersContextMenu) {
this.header.setAttribute("context", table.headersContextMenu);
}
this.toggleColumn = this.toggleColumn.bind(this);
this.table.on(EVENTS.HEADER_CONTEXT_MENU, this.toggleColumn);
this.onColumnSorted = this.onColumnSorted.bind(this);
this.table.on(EVENTS.COLUMN_SORTED, this.onColumnSorted);
this.onRowUpdated = this.onRowUpdated.bind(this);
this.table.on(EVENTS.ROW_UPDATED, this.onRowUpdated);
this.onTableFiltered = this.onTableFiltered.bind(this);
this.table.on(EVENTS.TABLE_FILTERED, this.onTableFiltered);
this.onClick = this.onClick.bind(this);
this.onMousedown = this.onMousedown.bind(this);
this.column.addEventListener("click", this.onClick);
this.column.addEventListener("mousedown", this.onMousedown);
}
Column.prototype = {
// items is a cell-id to cell-index map. It is basically a reverse map of the
// this.cells object and is used to quickly reverse lookup a cell by its id
// instead of looping through the cells array. This reverse map is not kept
// upto date in sync with the cells array as updating it is in itself a loop
// through all the cells of the columns. Thus update it on demand when it goes
// out of sync with this.cells.
items: null,
// _itemsDirty is a flag which becomes true when this.items goes out of sync
// with this.cells
_itemsDirty: null,
selectedRow: null,
cells: null,
/**
* Gets whether the table is sorted on this column or not.
* 0 - not sorted.
* 1 - ascending order
* 2 - descending order
*/
get sorted() {
return this._sortState || 0;
},
/**
* Sets the sorted value
*/
set sorted(value) {
if (!value) {
this.header.removeAttribute("sorted");
} else {
this.header.setAttribute("sorted",
value == 1 ? "ascending" : "descending");
}
this._sortState = value;
},
/**
* Gets the selected row in the column.
*/
get selectedIndex() {
if (!this.selectedRow) {
return -1;
}
return this.items[this.selectedRow];
},
get cellNodes() {
return [...this.column.querySelectorAll(".table-widget-cell")];
},
get visibleCellNodes() {
let editor = this.table._editableFieldsEngine;
let nodes = this.cellNodes.filter(node => {
// If the cell is currently being edited we should class it as visible.
if (editor && editor.currentTarget === node) {
return true;
}
return node.clientWidth !== 0;
});
return nodes;
},
/**
* Called when the column is sorted by.
*
* @param {string} event
* The event name of the event. i.e. EVENTS.COLUMN_SORTED
* @param {string} column
* The id of the column being sorted by.
*/
onColumnSorted: function (event, column) {
if (column != this.id) {
this.sorted = 0;
return;
} else if (this.sorted == 0 || this.sorted == 2) {
this.sorted = 1;
} else {
this.sorted = 2;
}
this.updateZebra();
},
onTableFiltered: function (event, itemsToHide) {
this._updateItems();
if (!this.cells) {
return;
}
for (let cell of this.cells) {
cell.hidden = false;
}
for (let id of itemsToHide) {
this.cells[this.items[id]].hidden = true;
}
this.updateZebra();
},
/**
* Called when a row is updated.
*
* @param {string} event
* The event name of the event. i.e. EVENTS.ROW_UPDATED
* @param {string} id
* The unique id of the object associated with the row.
*/
onRowUpdated: function (event, id) {
this._updateItems();
if (this.highlightUpdated && this.items[id] != null) {
if (this.table.editBookmark) {
// A rows position in the table can change as the result of an edit. In
// order to ensure that the correct row is highlighted after an edit we
// save the uniqueId in editBookmark. Here we send the signal that the
// row has been edited and that the row needs to be selected again.
this.table.emit(EVENTS.ROW_SELECTED, this.table.editBookmark);
this.table.editBookmark = null;
}
this.cells[this.items[id]].flash();
}
this.updateZebra();
},
destroy: function () {
this.table.off(EVENTS.COLUMN_SORTED, this.onColumnSorted);
this.table.off(EVENTS.HEADER_CONTEXT_MENU, this.toggleColumn);
this.table.off(EVENTS.ROW_UPDATED, this.onRowUpdated);
this.table.off(EVENTS.TABLE_FILTERED, this.onTableFiltered);
this.column.removeEventListener("click", this.onClick);
this.column.removeEventListener("mousedown", this.onMousedown);
this.splitter.remove();
this.column.parentNode.remove();
this.cells = null;
this.items = null;
this.selectedRow = null;
},
/**
* Selects the row at the `index` index
*/
selectRowAt: function (index) {
if (this.selectedRow != null) {
this.cells[this.items[this.selectedRow]].toggleClass("theme-selected");
}
if (index < 0) {
this.selectedRow = null;
return;
}
let cell = this.cells[index];
cell.toggleClass("theme-selected");
this.selectedRow = cell.id;
},
/**
* Selects the row with the object having the `uniqueId` value as `id`
*/
selectRow: function (id) {
this._updateItems();
this.selectRowAt(this.items[id]);
},
/**
* Selects the next row. Cycles to first if last row is selected.
*/
selectNextRow: function () {
this._updateItems();
let index = this.items[this.selectedRow] + 1;
if (index == this.cells.length) {
index = 0;
}
this.selectRowAt(index);
},
/**
* Selects the previous row. Cycles to last if first row is selected.
*/
selectPreviousRow: function () {
this._updateItems();
let index = this.items[this.selectedRow] - 1;
if (index == -1) {
index = this.cells.length - 1;
}
this.selectRowAt(index);
},
/**
* Pushes the `item` object into the column. If this column is sorted on,
* then inserts the object at the right position based on the column's id
* key's value.
*
* @returns {number}
* The index of the currently pushed item.
*/
push: function (item) {
let value = item[this.id];
if (this.sorted) {
let index;
if (this.sorted == 1) {
index = this.cells.findIndex(element => {
return value < element.value;
});
} else {
index = this.cells.findIndex(element => {
return value > element.value;
});
}
index = index >= 0 ? index : this.cells.length;
if (index < this.cells.length) {
this._itemsDirty = true;
}
this.items[item[this.uniqueId]] = index;
this.cells.splice(index, 0, new Cell(this, item, this.cells[index]));
return index;
}
this.items[item[this.uniqueId]] = this.cells.length;
return this.cells.push(new Cell(this, item)) - 1;
},
/**
* Inserts the `item` object at the given `index` index in the table.
*/
insertAt: function (item, index) {
if (index < this.cells.length) {
this._itemsDirty = true;
}
this.items[item[this.uniqueId]] = index;
this.cells.splice(index, 0, new Cell(this, item, this.cells[index]));
this.updateZebra();
},
/**
* Event handler for the command event coming from the header context menu.
* Toggles the column if it was requested by the user.
* When called explicitly without parameters, it toggles the corresponding
* column.
*
* @param {string} event
* The name of the event. i.e. EVENTS.HEADER_CONTEXT_MENU
* @param {string} id
* Id of the column to be toggled
* @param {string} checked
* true if the column is visible
*/
toggleColumn: function (event, id, checked) {
if (arguments.length == 0) {
// Act like a toggling method when called with no params
id = this.id;
checked = this.wrapper.hasAttribute("hidden");
}
if (id != this.id) {
return;
}
if (checked) {
this.wrapper.removeAttribute("hidden");
} else {
this.wrapper.setAttribute("hidden", "true");
}
},
/**
* Removes the corresponding item from the column.
*/
remove: function (item) {
this._updateItems();
let index = this.items[item[this.uniqueId]];
if (index == null) {
return;
}
if (index < this.cells.length) {
this._itemsDirty = true;
}
this.cells[index].destroy();
this.cells.splice(index, 1);
delete this.items[item[this.uniqueId]];
},
/**
* Updates the corresponding item from the column.
*/
update: function (item) {
this._updateItems();
let index = this.items[item[this.uniqueId]];
if (index == null) {
return;
}
this.cells[index].value = item[this.id];
},
/**
* Updates the `this.items` cell-id vs cell-index map to be in sync with
* `this.cells`.
*/
_updateItems: function () {
if (!this._itemsDirty) {
return;
}
for (let i = 0; i < this.cells.length; i++) {
this.items[this.cells[i].id] = i;
}
this._itemsDirty = false;
},
/**
* Clears the current column
*/
clear: function () {
this.cells = [];
this.items = {};
this._itemsDirty = false;
this.selectedRow = null;
while (this.header.nextSibling) {
this.header.nextSibling.remove();
}
},
/**
* Sorts the given items and returns the sorted list if the table was sorted
* by this column.
*/
sort: function (items) {
// Only sort the array if we are sorting based on this column
if (this.sorted == 1) {
items.sort((a, b) => {
let val1 = (a[this.id] instanceof Node) ?
a[this.id].textContent : a[this.id];
let val2 = (b[this.id] instanceof Node) ?
b[this.id].textContent : b[this.id];
return val1 > val2;
});
} else if (this.sorted > 1) {
items.sort((a, b) => {
let val1 = (a[this.id] instanceof Node) ?
a[this.id].textContent : a[this.id];
let val2 = (b[this.id] instanceof Node) ?
b[this.id].textContent : b[this.id];
return val2 > val1;
});
}
if (this.selectedRow) {
this.cells[this.items[this.selectedRow]].toggleClass("theme-selected");
}
this.items = {};
// Otherwise, just use the sorted array passed to update the cells value.
items.forEach((item, i) => {
this.items[item[this.uniqueId]] = i;
this.cells[i].value = item[this.id];
this.cells[i].id = item[this.uniqueId];
});
if (this.selectedRow) {
this.cells[this.items[this.selectedRow]].toggleClass("theme-selected");
}
this._itemsDirty = false;
this.updateZebra();
return items;
},
updateZebra() {
this._updateItems();
let i = 0;
for (let cell of this.cells) {
if (!cell.hidden) {
i++;
}
cell.toggleClass("even", !(i % 2));
}
},
/**
* Click event handler for the column. Used to detect click on header for
* for sorting.
*/
onClick: function (event) {
let target = event.originalTarget;
if (target.nodeType !== target.ELEMENT_NODE || target == this.column) {
return;
}
if (event.button == 0 && target == this.header) {
this.table.sortBy(this.id);
}
},
/**
* Mousedown event handler for the column. Used to select rows.
*/
onMousedown: function (event) {
let target = event.originalTarget;
if (target.nodeType !== target.ELEMENT_NODE ||
target == this.column ||
target == this.header) {
return;
}
if (event.button == 0) {
let closest = target.closest("[data-id]");
if (!closest) {
return;
}
let dataid = closest.getAttribute("data-id");
this.table.emit(EVENTS.ROW_SELECTED, dataid);
}
},
};
/**
* A single cell in a column
*
* @param {Column} column
* The column object to which the cell belongs.
* @param {object} item
* The object representing the row. It contains a key value pair
* representing the column id and its associated value. The value
* can be a DOMNode that is appended or a string value.
* @param {Cell} nextCell
* The cell object which is next to this cell. null if this cell is last
* cell of the column
*/
function Cell(column, item, nextCell) {
let document = column.document;
this.wrapTextInElements = column.wrapTextInElements;
this.label = document.createElementNS(XUL_NS, "label");
this.label.setAttribute("crop", "end");
this.label.className = "plain table-widget-cell";
if (nextCell) {
column.column.insertBefore(this.label, nextCell.label);
} else {
column.column.appendChild(this.label);
}
if (column.table.cellContextMenuId) {
this.label.setAttribute("context", column.table.cellContextMenuId);
this.label.addEventListener("contextmenu", (event) => {
// Make the ID of the clicked cell available as a property on the table.
// It's then available for the popupshowing or command handler.
column.table.contextMenuRowId = this.id;
}, false);
}
this.value = item[column.id];
this.id = item[column.uniqueId];
}
Cell.prototype = {
set id(value) {
this._id = value;
this.label.setAttribute("data-id", value);
},
get id() {
return this._id;
},
get hidden() {
return this.label.hasAttribute("hidden");
},
set hidden(value) {
if (value) {
this.label.setAttribute("hidden", "hidden");
} else {
this.label.removeAttribute("hidden");
}
},
set value(value) {
this._value = value;
if (value == null) {
this.label.setAttribute("value", "");
return;
}
if (this.wrapTextInElements && !(value instanceof Node)) {
let span = this.label.ownerDocument.createElementNS(HTML_NS, "span");
span.textContent = value;
value = span;
}
if (value instanceof Node) {
this.label.removeAttribute("value");
while (this.label.firstChild) {
this.label.removeChild(this.label.firstChild);
}
this.label.appendChild(value);
} else {
this.label.setAttribute("value", value + "");
}
},
get value() {
return this._value;
},
toggleClass: function (className, condition) {
this.label.classList.toggle(className, condition);
},
/**
* Flashes the cell for a brief time. This when done for with cells in all
* columns, makes it look like the row is being highlighted/flashed.
*/
flash: function () {
if (!this.label.parentNode) {
return;
}
this.label.classList.remove("flash-out");
// Cause a reflow so that the animation retriggers on adding back the class
let a = this.label.parentNode.offsetWidth; // eslint-disable-line
let onAnimEnd = () => {
this.label.classList.remove("flash-out");
this.label.removeEventListener("animationend", onAnimEnd);
};
this.label.addEventListener("animationend", onAnimEnd);
this.label.classList.add("flash-out");
},
focus: function () {
this.label.focus();
},
destroy: function () {
this.label.remove();
this.label = null;
}
};
/**
* Simple widget to make nodes matching a CSS selector editable.
*
* @param {Object} options
* An object with the following format:
* {
* // The node that will act as a container for the editor e.g. a
* // div or table.
* root: someNode,
*
* // The onTab event to be handled by the caller.
* onTab: function(event) { ... }
*
* // Optional event used to trigger the editor. By default this is
* // dblclick.
* onTriggerEvent: "dblclick",
*
* // Array or comma separated string of CSS Selectors matching
* // elements that are to be made editable.
* selectors: [
* "#name .table-widget-cell",
* "#value .table-widget-cell"
* ]
* }
*/
function EditableFieldsEngine(options) {
EventEmitter.decorate(this);
if (!Array.isArray(options.selectors)) {
options.selectors = [options.selectors];
}
this.root = options.root;
this.selectors = options.selectors;
this.onTab = options.onTab;
this.onTriggerEvent = options.onTriggerEvent || "dblclick";
this.edit = this.edit.bind(this);
this.cancelEdit = this.cancelEdit.bind(this);
this.destroy = this.destroy.bind(this);
this.onTrigger = this.onTrigger.bind(this);
this.root.addEventListener(this.onTriggerEvent, this.onTrigger);
}
EditableFieldsEngine.prototype = {
INPUT_ID: "inlineEditor",
get changePending() {
return this.isEditing && (this.textbox.value !== this.currentValue);
},
get isEditing() {
return this.root && !this.textbox.hidden;
},
get textbox() {
if (!this._textbox) {
let doc = this.root.ownerDocument;
this._textbox = doc.createElementNS(XUL_NS, "textbox");
this._textbox.id = this.INPUT_ID;
this._textbox.setAttribute("flex", "1");
this.onKeydown = this.onKeydown.bind(this);
this._textbox.addEventListener("keydown", this.onKeydown);
this.completeEdit = this.completeEdit.bind(this);
doc.addEventListener("blur", this.completeEdit);
}
return this._textbox;
},
/**
* Called when a trigger event is detected (default is dblclick).
*
* @param {EventTarget} target
* Calling event's target.
*/
onTrigger: function ({target}) {
this.edit(target);
},
/**
* Handle keypresses when in edit mode:
* - <escape> revert the value and close the textbox.
* - <return> apply the value and close the textbox.
* - <tab> Handled by the consumer's `onTab` callback.
* - <shift><tab> Handled by the consumer's `onTab` callback.
*
* @param {Event} event
* The calling event.
*/
onKeydown: function (event) {
if (!this.textbox) {
return;
}
switch (event.keyCode) {
case KeyCodes.DOM_VK_ESCAPE:
this.cancelEdit();
event.preventDefault();
break;
case KeyCodes.DOM_VK_RETURN:
this.completeEdit();
break;
case KeyCodes.DOM_VK_TAB:
if (this.onTab) {
this.onTab(event);
}
break;
}
},
/**
* Overlay the target node with an edit field.
*
* @param {Node} target
* Dom node to be edited.
*/
edit: function (target) {
if (!target) {
return;
}
target.scrollIntoView(false);
target.focus();
if (!target.matches(this.selectors.join(","))) {
return;
}
// If we are actively editing something complete the edit first.
if (this.isEditing) {
this.completeEdit();
}
this.copyStyles(target, this.textbox);
target.parentNode.insertBefore(this.textbox, target);
this.currentTarget = target;
this.textbox.value = this.currentValue = target.value;
target.hidden = true;
this.textbox.hidden = false;
this.textbox.focus();
this.textbox.select();
},
completeEdit: function () {
if (!this.isEditing) {
return;
}
let oldValue = this.currentValue;
let newValue = this.textbox.value;
let changed = oldValue !== newValue;
this.textbox.hidden = true;
if (!this.currentTarget) {
return;
}
this.currentTarget.hidden = false;
if (changed) {
this.currentTarget.value = newValue;
let data = {
change: {
field: this.currentTarget,
oldValue: oldValue,
newValue: newValue
}
};
this.emit("change", data);
}
},
/**
* Cancel an edit.
*/
cancelEdit: function () {
if (!this.isEditing) {
return;
}
if (this.currentTarget) {
this.currentTarget.hidden = false;
}
this.textbox.hidden = true;
},
/**
* Stop edit mode and apply changes.
*/
blur: function () {
if (this.isEditing) {
this.completeEdit();
}
},
/**
* Copies various styles from one node to another.
*
* @param {Node} source
* The node to copy styles from.
* @param {Node} destination [description]
* The node to copy styles to.
*/
copyStyles: function (source, destination) {
let style = source.ownerDocument.defaultView.getComputedStyle(source);
let props = [
"borderTopWidth",
"borderRightWidth",
"borderBottomWidth",
"borderLeftWidth",
"fontFamily",
"fontSize",
"fontWeight",
"height",
"marginTop",
"marginRight",
"marginBottom",
"marginLeft",
"marginInlineStart",
"marginInlineEnd"
];
for (let prop of props) {
destination.style[prop] = style[prop];
}
// We need to set the label width to 100% to work around a XUL flex bug.
destination.style.width = "100%";
},
/**
* Destroys all editors in the current document.
*/
destroy: function () {
if (this.textbox) {
this.textbox.removeEventListener("keydown", this.onKeydown);
this.textbox.remove();
}
if (this.root) {
this.root.removeEventListener(this.onTriggerEvent, this.onTrigger);
this.root.ownerDocument.removeEventListener("blur", this.completeEdit);
}
this._textbox = this.root = this.selectors = this.onTab = null;
this.currentTarget = this.currentValue = null;
this.emit("destroyed");
},
};
|