-
Notifications
You must be signed in to change notification settings - Fork 6
/
grid.ts
442 lines (366 loc) · 15.6 KB
/
grid.ts
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
/*
* Copyright (c) 2020, Max Klein
*
* This file is part of the tree-finder library, distributed under the terms of
* the BSD 3 Clause license. The full license can be found in the LICENSE file.
*/
import * as rt from "regular-table";
import { Content, IContentRow } from "../content";
import { ContentsModel } from "../model";
import { Format, RegularTable, Tree } from "../util";
import { TreeFinderFilterElement } from "./filter";
import { TreeFinderFiltersElement } from "./filters";
// await customElements.whenDefined('regular-table');
if (document.createElement("regular-table").constructor === HTMLElement) {
window.customElements.define("regular-table", rt.RegularTableElement);
}
const RegularTableElement = customElements.get('regular-table');
export class TreeFinderGridElement<T extends IContentRow> extends RegularTableElement {
async init(model: ContentsModel<T>, options: TreeFinderGridElement.IOptions<T> = {}) {
this.model = model;
this.options = options;
// TODO: apply the setDataListener typing fix below, once regular-table has pulled in the relevant typing fixes upstream
// this.setDataListener(this.dataListener.bind(this), {virtual_mode: this._options.virtual_mode});
(this as any).setDataListener(this.dataListener.bind(this), {virtual_mode: this._options.virtual_mode});
// run listener initializations only once
if (!this._initializedListeners) {
const [thead, tbody] = [(this as any).table_model.header.table, (this as any).table_model.body.table] as HTMLTableSectionElement[];
this.addStyleListener(() => this.columnHeaderStyleListener())
this.addStyleListener(() => this.rowStyleListener());
this.addEventListener("mouseover", event => this.onMouseover(event));
thead.addEventListener("mouseup", event => this.onSortClick(event));
// handle selection by triggering onRowClick on both left and contextmenu (ie right) button click
tbody.addEventListener("contextmenu", event => this.onRowClick(event));
tbody.addEventListener("dblclick", event => this.onRowDoubleClick(event));
tbody.addEventListener("mouseup", event => this.onRowClick(event));
tbody.addEventListener("mouseup", event => this.onTreeClick(event));
// this.addEventListener("scroll", () => (this as any)._resetAutoSize());
// click debug listener
// this.addEventListener("mousedown", event => RegularTable.clickLoggingListener(event, this));
if (this.options.doWindowResize) {
// resize whenever window size changes, if requested
window.addEventListener('resize', async () => {
await this.draw();
});
}
// effectively a listener for model.requestDraw invocations
this.model.drawSub.subscribe(async x => {
if (x) {
(this as any)._resetAutoSize();
}
await this.draw();
if (this.model.options.needsWidths) {
// correct handling of autowidth seems to frequently require the second draw
await this.draw();
}
});
this._initializedListeners = true;
}
this.model.requestDraw();
}
async dataListener(start_col: number, start_row: number, end_col: number, end_row: number) {
return {
// num_columns/rows: number -> count of cols/rows
num_columns: this.model.columns.length,
num_rows: this.model.contents.length,
// column/row_headers: string[] -> arrays of path parts that get displayed as the first value in each col/row. Length > 1 implies a tree structure
column_headers: this.model.columns.slice(start_col, end_col).map((x, i) => this.options.showFilter ? [this.filters!.getChild(i + 1), ...Tree.colHeaderSpans(x as string)] : Tree.colHeaderSpans(x as string)),
row_headers: this.model.contents.slice(start_row, end_row).map(x => this._getRowHeader(x)),
// data: object[][] -> array of arrays, each subarray containing all of the visible values for one column
// .isBlank works around issue with formatting placeholder row that shows up when data is blank
// TODO: refactor away .isBlank workaround
data: this.model.isBlank ? [Array(this.model.columns.length).fill("")] : this._getData(start_col, start_row, end_col, end_row),
};
}
columnHeaderStyleListener() {
this.cornerHeaderStyleListener();
for (const th of (this.querySelectorAll("thead tr:first-child th") as any as HTMLTableHeaderCellElement[])) {
th.classList.toggle("tf-header-align-left", true);
const filter = th.querySelector("tree-finder-filter") as TreeFinderFilterElement<T>;
if (filter) {
filter.input.classList.toggle("tf-header-input", true);
if (this.model.filterCol === filter.col) {
filter.input.focus();
delete this.model.filterCol;
}
}
}
for (const th of (this.querySelectorAll("thead tr:last-child th") as any as HTMLTableHeaderCellElement[])) {
const meta = this.getMeta(th);
const col = RegularTable.colNameFromMeta(meta) as keyof T;
if (col) {
const sortOrder = this.model.sortStates.byColumn[col === "0" ? "path" : col]?.order;
th.querySelector(".tf-header-sort")?.classList.toggle(`tf-header-sort-${sortOrder}`, !!sortOrder);
}
th.classList.toggle("tf-header-corner", typeof meta.x === "undefined");
th.classList.toggle("tf-header-align-left", true);
}
if (this.model.options.needsWidths) {
this.columnWidthStyleListener();
}
}
columnWidthStyleListener() {
// complete and accurate autowidth for the tree-finder-filter input elems
let pxs = [...(this as any)._column_sizes.indices];
if (this._pathRender === "regular" && pxs.length > 0) {
pxs = [pxs[0] + pxs[1], ...pxs.slice(2)];
}
this.model.columnWidthsSub.next(pxs.map(px => `calc(${px}px - 12px)`));
}
cornerHeaderStyleListener() {
const initSpans = this.querySelectorAll(`thead tr > th:first-child > span:first-child:not([class])`);
const newSpans = this.options.showFilter ? [this.filters!.getChild(0), ...Tree.colHeaderSpans("path")] : Tree.colHeaderSpans("path");
for (let i = 0; i < initSpans.length; i++) {
initSpans[i].replaceWith(newSpans[i]);
}
}
rowStyleListener() {
const spans = this.querySelectorAll("tbody th span.rt-group-name") as any as HTMLSpanElement[];
for (const span of spans) {
const {y} = RegularTable.metadataFromElement(span as HTMLTableCellElement, this)!;
if (y != null) {
const content = this.model.contents[y];
// style the filetype icon for this row
span.classList.add("tf-grid-filetype-icon", `tf-grid-${content.row.kind}-icon`);
// style the path renamer for this row, if neded
this._renamerStyleListener(span, content);
}
}
this._selectedStyleListener();
}
async onMouseover(event: MouseEvent) {
if (this._pathRender === "regular") {
const element = event.target as HTMLTableCellElement;
const metadata = RegularTable.metadataFromElement(element, this);
const rowHeader = metadata?.row_header?.[0] as any as string;
for (let tr of (this as any).table_model.body.rows as HTMLElement[]) {
if (tr.childElementCount > (this.model.columns.length + 1)) {
const th = tr.children[0];
th.classList.toggle("tf-mod-hover", th.textContent === rowHeader);
}
}
}
}
async onRowClick(event: MouseEvent) {
// allow both left and right click to fire this handler
if (event.button !== 0 && event.button !== 2) {
return;
}
const element = event.target as HTMLTableCellElement;
if (element.classList.contains("rt-row-header-icon")) {
// if open/close icon is clicked, don't select
return;
}
const metadata = RegularTable.metadataFromElement(element, this);
if (!metadata || !RegularTable.rowClicked(metadata)) {
return;
}
const content = this.model.contents[metadata.y!];
if (event.button === 2 && this.model.selectionModel.has(content)) {
// if right-clicking on an existing selection, don't change it
return;
}
if (event.shiftKey) {
this.model.selectionModel.selectRange(content, this.model.contents);
} else {
this.model.selectionModel.select(content, event.ctrlKey || event.metaKey);
}
// can't call draw, breaks any subsequent doubleClick event. Instead call style listener directly
this._selectedStyleListener();
}
async onSortClick(event: MouseEvent) {
if (event.button !== 0) {
return;
}
const element = event.target as HTMLTableCellElement;
if (element.classList.contains("rt-column-resize")) {
// don't sort when the column resize handle nodes are clicked
return;
}
const meta = RegularTable.metadataFromElement(element, this);
if (!meta || !RegularTable.columnHeaderClicked(meta) || meta.column_header_y! < (this as any).table_model.header.rows.length - 1) {
return;
}
await this.model.sort({
col: RegularTable.colNameFromMeta(meta) as keyof T,
multisort: event.shiftKey,
});
}
async onTreeClick(event: MouseEvent) {
if (event.button !== 0) {
return;
}
let element = event.target as HTMLTableCellElement;
if (!element.classList.contains("rt-row-header-icon")) {
// only open/close node when open/close icon is clicked
return;
}
// assert that metadata exists, given element.classList check above
const metadata = RegularTable.metadataFromElement(element, this)!;
if (this.model.contents[metadata.y!].isExpand) {
await this.model.collapse(metadata.y!);
} else {
await this.model.expand(metadata.y!);
}
// (this as any)._resetAutoSize();
// this.draw();
}
async onRowDoubleClick(event: MouseEvent) {
if (event.button !== 0) {
return;
}
const element = event.target as HTMLTableCellElement;
const metadata = RegularTable.metadataFromElement(element, this);
if (!metadata || !RegularTable.rowClicked(metadata)) {
return;
}
// event.preventDefault();
// event.stopPropagation();
// event.stopImmediatePropagation();
// event.returnValue = false;
const newRootContent = this.model.contents[metadata.y!];
await this.model.open(newRootContent.row);
}
get options() {
return {...this._options};
}
set options({
columnFormatters = undefined,
doWindowResize = false,
pathRender = "tree",
pathRenderOnFilter = "relative",
showFilter = false,
virtual_mode = "vertical",
}: TreeFinderGridElement.IOptions<T>) {
this._options = {
columnFormatters,
doWindowResize,
pathRender,
pathRenderOnFilter,
showFilter,
virtual_mode,
}
this.showFilter = this._options.showFilter!;
}
set showFilter(flag: boolean) {
if (flag) {
this.filters = document.createElement("tree-finder-filters");
this.filters.init(this.model);
} else {
delete this.filters;
}
this._options.showFilter = flag;
}
protected _getData(start_col: number, start_row: number, end_col: number, end_row: number) {
const data: T[keyof T][][] = [];
// using slice creates an unneeded shallow copy, but is currently the "official"
// regular-table endorsed pattern for guarding against spuriously large end_col/end_row values
// TODO: refactor away slice by just doing the damn math
for (const column of this.model.columns.slice(start_col, end_col)) {
const formatter = this.options.columnFormatters?.[column] ?? (x => x);
data.push(
this.model.contents.slice(start_row, end_row).map(content => {
const val = formatter(content.row[column]);
return (val instanceof Date ? Format.DATE_FORMATTER.format(val) : val) as T[keyof T];
})
);
}
return data;
}
protected _getRowHeader(target: Content<T>) {
return Tree.rowHeaderSpan({
hasChildren: target.hasChildren,
isExpand: target.isExpand,
path: target.getPathAtDepth(this.model.pathDepth),
editable: this.model.renamerTest(target),
pathRender: this._pathRender,
});
}
protected _renamerStyleListener(element: HTMLElement, target: Content<T>) {
// if this path span is a renamer element, initialize it
if (element.classList.contains("tf-mod-editable")) {
if (!element.getAttribute("contenteditable")) {
// activate renamer on enter, cancel it on escape
element.addEventListener("keydown", (event: KeyboardEvent) => {
if (event.key === "Enter") {
element.blur();
} else if (event.key === "Escape") {
element.textContent = target.name;
element.blur();
}
});
// activate then destroy renamer when it loses focus
element.addEventListener("blur", () => {
const name = element.textContent;
if (name) {
// if name is blank, skip. Otherwise, perform the actual renaming
target.row.path = [...target.row.path.slice(0, -1), name];
element.classList.toggle("tf-mod-editable", false);
element.removeAttribute("contenteditable");
// publish renamer info when the editable element loses focus
this.model.renamerSub.next({name, target: target});
}
// in any case, reset the renamer
this.model.renamerPath = null;
});
element.setAttribute("contenteditable", "true");
}
// ensure that the renamer has focus so long as it exists and is visible
element.focus();
}
}
protected _selectedStyleListener() {
const colCount = this.model.columns.length + 1;
// there may be spurious rows in table, clamp selected check to contents length
// TODO: refactor away the any cast once upstream typing fixes are released in regular-table
// for (let tr of this.table_model.body.rows.slice(0, this.model.contents.length) as HTMLElement[]) {
for (let tr of (this as any).table_model.body.rows.slice(0, this.model.contents.length) as HTMLElement[]) {
const {y} = RegularTable.metadataFromElement(tr.children[0]!, this)!;
if (tr && tr.tagName === "TR") {
tr.classList.toggle("tf-mod-select", this.model.selectionModel.has(this.model.contents[y!]));
if (this._pathRender === "regular") {
for (let i = 0; i < tr.children.length - colCount; i++) {
tr.children[0].classList.toggle("tf-mod-select-not", true);
}
}
}
}
}
protected get _pathRender() {
if (this.model.filterPatterns.any) {
return this.options.pathRenderOnFilter || "tree";
} else {
return this.options.pathRender || "tree";
}
}
protected _options: TreeFinderGridElement.IOptions<T>;
protected filters?: TreeFinderFiltersElement<T>;
protected model: ContentsModel<T>;
private _initializedListeners: boolean = false;
}
export namespace TreeFinderGridElement {
export interface IOptions<T extends IContentRow> {
columnFormatters?: {[key in keyof T]?: (datum: T[key]) => any};
/**
* if true, redraw the tree-finder-grid element on window resize events
*/
doWindowResize?: boolean;
/**
* select from different strategies for rendcering the paths
*/
pathRender?: "regular" | "relative" | "tree";
/**
* if not null, the rendering of paths will change when any filter is set
*/
pathRenderOnFilter?: "regular" | "relative" | "tree";
/**
* if true, add filter inputs to top of each colum
*/
showFilter?: boolean;
/**
* pass through to .setDataListener "virtual_mode" opt
*/
virtual_mode?: "both" | "horizontal" | "none" | "vertical";
}
}
customElements.define("tree-finder-grid", TreeFinderGridElement);