-
-
Notifications
You must be signed in to change notification settings - Fork 286
Expand file tree
/
Copy pathKeyHandlingTableView.swift
More file actions
424 lines (361 loc) · 14.8 KB
/
KeyHandlingTableView.swift
File metadata and controls
424 lines (361 loc) · 14.8 KB
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
//
// KeyHandlingTableView.swift
// TablePro
//
// NSTableView subclass that handles keyboard shortcuts and TablePlus-style cell focus.
// Uses Apple's responder chain pattern with interpretKeyEvents for standard shortcuts.
//
// Architecture:
// - Keyboard events → interpretKeyEvents → Standard selectors (@objc moveUp, delete, etc.)
// - Uses KeyCode enum for readability (no magic numbers)
// - Responder chain validation via validateUserInterfaceItem
//
import AppKit
/// NSTableView subclass that handles keyboard shortcuts and TablePlus-style cell focus on click
final class KeyHandlingTableView: NSTableView {
weak var coordinator: TableViewCoordinator?
// MARK: - First Responder
override var acceptsFirstResponder: Bool {
true
}
/// Currently focused row index (-1 = no focus)
var focusedRow: Int = -1 {
didSet {
if oldValue != focusedRow && oldValue >= 0 {
if focusedColumn >= 0 && focusedColumn < numberOfColumns && oldValue < numberOfRows {
reloadData(forRowIndexes: IndexSet(integer: oldValue),
columnIndexes: IndexSet(integer: focusedColumn))
}
}
}
}
/// Currently focused column index (-1 = no focus, 0 = row number column)
var focusedColumn: Int = -1 {
didSet {
guard oldValue != focusedColumn else { return }
let row = focusedRow
guard row >= 0 && row < numberOfRows else { return }
var cols = IndexSet()
if oldValue >= 0 && oldValue < numberOfColumns { cols.insert(oldValue) }
if focusedColumn >= 0 && focusedColumn < numberOfColumns { cols.insert(focusedColumn) }
if !cols.isEmpty {
reloadData(forRowIndexes: IndexSet(integer: row), columnIndexes: cols)
}
}
}
/// Anchor row for Shift+Arrow range selection (-1 = no anchor)
var selectionAnchor: Int = -1
/// Current pivot row for Shift+Arrow navigation
var selectionPivot: Int = -1
// MARK: - TablePlus-Style Cell Focus
override func mouseDown(with event: NSEvent) {
// Become first responder to capture keyboard events (especially Delete key)
window?.makeFirstResponder(self)
let point = convert(event.locationInWindow, from: nil)
let clickedRow = row(at: point)
let clickedColumn = column(at: point)
// Double-click in empty area adds a new row
if event.clickCount == 2 && clickedRow == -1 && coordinator?.isEditable == true {
if let callback = coordinator?.onAddRow {
callback()
} else {
NotificationCenter.default.post(name: .addNewRow, object: nil)
}
return
}
// Reset anchor/pivot when clicking without Shift
if clickedRow >= 0 && !event.modifierFlags.contains(.shift) {
selectionAnchor = clickedRow
selectionPivot = clickedRow
}
super.mouseDown(with: event)
// Only handle editing for valid clicks on data cells (not row number column)
guard clickedRow >= 0,
clickedColumn >= 0,
clickedColumn < numberOfColumns else {
return
}
// Skip row number column
let column = tableColumns[clickedColumn]
if column.identifier.rawValue == "__rowNumber__" {
focusedRow = -1
focusedColumn = -1
return
}
// Update focus (edit mode is triggered by double-click, not single click)
focusedRow = clickedRow
focusedColumn = clickedColumn
}
// MARK: - Standard Edit Menu Actions
/// Delete selected rows - called from menu or keyboard shortcut
@objc func delete(_ sender: Any?) {
guard coordinator?.isEditable == true else { return }
guard !selectedRowIndexes.isEmpty else { return }
// Use callback if available (e.g., Structure tab), otherwise fall back to notification (Data tab)
if let callback = coordinator?.onDeleteRows {
callback(Set(selectedRowIndexes))
} else {
// Fallback for views that haven't migrated to callback pattern
// Pass selected indices so the handler doesn't rely on SwiftUI binding sync timing
NotificationCenter.default.post(
name: .deleteSelectedRows,
object: nil,
userInfo: ["rowIndices": Set(selectedRowIndexes)]
)
}
}
/// Copy selected rows to clipboard
@objc func copy(_ sender: Any?) {
let indices = Set(selectedRowIndexes)
if let callback = coordinator?.onCopyRows {
callback(indices)
} else {
coordinator?.copyRows(at: indices)
}
}
/// Paste rows from clipboard
@objc func paste(_ sender: Any?) {
guard coordinator?.isEditable == true else { return }
if let callback = coordinator?.onPasteRows {
callback()
}
}
/// Undo last change
@objc func undo(_ sender: Any?) {
guard coordinator?.isEditable == true else { return }
if let callback = coordinator?.onUndo {
callback()
}
}
/// Redo last undone change
@objc func redo(_ sender: Any?) {
guard coordinator?.isEditable == true else { return }
if let callback = coordinator?.onRedo {
callback()
}
}
/// Validate menu items and shortcuts
override func validateUserInterfaceItem(_ item: NSValidatedUserInterfaceItem) -> Bool {
switch item.action {
case #selector(delete(_:)), #selector(deleteBackward(_:)):
return coordinator?.isEditable == true && !selectedRowIndexes.isEmpty
case #selector(copy(_:)):
return !selectedRowIndexes.isEmpty
case #selector(paste(_:)):
return coordinator?.isEditable == true && coordinator?.onPasteRows != nil
case #selector(undo(_:)):
return coordinator?.isEditable == true && (coordinator?.canUndo() ?? false)
case #selector(redo(_:)):
return coordinator?.isEditable == true && (coordinator?.canRedo() ?? false)
case #selector(insertNewline(_:)):
return selectedRow >= 0 && focusedColumn >= 1 && coordinator?.isEditable == true
case #selector(cancelOperation(_:)):
return focusedRow >= 0 || focusedColumn >= 0 || !selectedRowIndexes.isEmpty
default:
return super.validateUserInterfaceItem(item)
}
}
// MARK: - Keyboard Handling
/// Convert key events to standard selectors using interpretKeyEvents
/// This enables proper responder chain behavior and accessibility support
override func keyDown(with event: NSEvent) {
guard let key = KeyCode(rawValue: event.keyCode) else {
super.keyDown(with: event)
return
}
// Handle Tab manually (NSTableView cell navigation requires custom logic)
if key == .tab {
handleTabKey()
return
}
// Handle arrow keys (custom Shift+selection logic)
let row = selectedRow
let modifiers = event.modifierFlags.intersection(.deviceIndependentFlagsMask)
let isShiftHeld = modifiers.contains(.shift)
// Ctrl+HJKL navigation (arrow key alternatives for keyboards without dedicated arrows)
if modifiers.contains(.control) {
switch key {
case .h:
handleLeftArrow(currentRow: row)
return
case .j:
handleDownArrow(currentRow: row, isShiftHeld: isShiftHeld)
return
case .k:
handleUpArrow(currentRow: row, isShiftHeld: isShiftHeld)
return
case .l:
handleRightArrow(currentRow: row)
return
default:
break
}
}
switch key {
case .upArrow:
handleUpArrow(currentRow: row, isShiftHeld: isShiftHeld)
return
case .downArrow:
handleDownArrow(currentRow: row, isShiftHeld: isShiftHeld)
return
case .leftArrow:
handleLeftArrow(currentRow: row)
return
case .rightArrow:
handleRightArrow(currentRow: row)
return
default:
break
}
// For all other keys, use interpretKeyEvents to map to standard selectors
// This handles Return → insertNewline(_:), Delete → deleteBackward(_:), ESC → cancelOperation(_:)
interpretKeyEvents([event])
}
// MARK: - Standard Responder Selectors
/// Handle Return/Enter key - start editing current cell
@objc override func insertNewline(_ sender: Any?) {
let row = selectedRow
guard row >= 0, focusedColumn >= 1, coordinator?.isEditable == true else {
return
}
// Multiline values use overlay editor instead of field editor
let columnIndex = focusedColumn - 1
if let value = coordinator?.rowProvider.value(atRow: row, column: columnIndex),
value.containsLineBreak {
coordinator?.showOverlayEditor(tableView: self, row: row, column: focusedColumn, columnIndex: columnIndex, value: value)
return
}
editColumn(focusedColumn, row: row, with: nil, select: true)
}
/// Handle Delete/Backspace key - delete selected rows
@objc override func deleteBackward(_ sender: Any?) {
guard coordinator?.isEditable == true else { return }
guard !selectedRowIndexes.isEmpty else { return }
delete(sender)
}
/// Handle ESC key - clear selection and focus
@objc override func cancelOperation(_ sender: Any?) {
focusedRow = -1
focusedColumn = -1
deselectAll(sender)
}
// MARK: - Arrow Key and Tab Helpers
/// Handle left arrow key - move focus to previous column
private func handleLeftArrow(currentRow: Int) {
if focusedColumn > 1 {
focusedColumn -= 1
if currentRow >= 0 { scrollColumnToVisible(focusedColumn) }
} else if focusedColumn == -1 && numberOfColumns > 1 {
focusedColumn = numberOfColumns - 1
if currentRow >= 0 { scrollColumnToVisible(focusedColumn) }
}
}
/// Handle right arrow key - move focus to next column
private func handleRightArrow(currentRow: Int) {
if focusedColumn >= 1 && focusedColumn < numberOfColumns - 1 {
focusedColumn += 1
if currentRow >= 0 { scrollColumnToVisible(focusedColumn) }
} else if focusedColumn == -1 && numberOfColumns > 1 {
focusedColumn = 1
if currentRow >= 0 { scrollColumnToVisible(focusedColumn) }
}
}
/// Handle Tab key - navigate to next cell (manual implementation required for NSTableView)
private func handleTabKey() {
let row = selectedRow
guard row >= 0, focusedColumn >= 1 else { return }
var nextColumn = focusedColumn + 1
var nextRow = row
if nextColumn >= numberOfColumns {
nextColumn = 1
nextRow += 1
}
if nextRow >= numberOfRows {
nextRow = numberOfRows - 1
nextColumn = numberOfColumns - 1
}
selectRowIndexes(IndexSet(integer: nextRow), byExtendingSelection: false)
focusedRow = nextRow
focusedColumn = nextColumn
scrollRowToVisible(nextRow)
scrollColumnToVisible(nextColumn)
}
// MARK: - Arrow Key Selection Helpers
private func handleUpArrow(currentRow: Int, isShiftHeld: Bool) {
guard numberOfRows > 0 else { return }
if currentRow == -1 {
let targetRow = numberOfRows - 1
selectionAnchor = targetRow
selectionPivot = targetRow
focusedRow = targetRow
selectRowIndexes(IndexSet(integer: targetRow), byExtendingSelection: false)
scrollRowToVisible(targetRow)
return
}
if isShiftHeld {
if selectionAnchor == -1 {
selectionAnchor = currentRow
selectionPivot = currentRow
}
let currentPivot = selectionPivot >= 0 ? selectionPivot : currentRow
let targetRow = max(0, currentPivot - 1)
selectionPivot = targetRow
let startRow = min(selectionAnchor, selectionPivot)
let endRow = max(selectionAnchor, selectionPivot)
let range = IndexSet(integersIn: startRow...endRow)
selectRowIndexes(range, byExtendingSelection: false)
scrollRowToVisible(targetRow)
} else {
let targetRow = max(0, currentRow - 1)
selectionAnchor = targetRow
selectionPivot = targetRow
focusedRow = targetRow
selectRowIndexes(IndexSet(integer: targetRow), byExtendingSelection: false)
scrollRowToVisible(targetRow)
}
}
private func handleDownArrow(currentRow: Int, isShiftHeld: Bool) {
guard numberOfRows > 0 else { return }
if currentRow == -1 {
selectionAnchor = 0
selectionPivot = 0
focusedRow = 0
selectRowIndexes(IndexSet(integer: 0), byExtendingSelection: false)
scrollRowToVisible(0)
return
}
if isShiftHeld {
if selectionAnchor == -1 {
selectionAnchor = currentRow
selectionPivot = currentRow
}
let currentPivot = selectionPivot >= 0 ? selectionPivot : currentRow
let targetRow = min(numberOfRows - 1, currentPivot + 1)
selectionPivot = targetRow
let startRow = min(selectionAnchor, selectionPivot)
let endRow = max(selectionAnchor, selectionPivot)
let range = IndexSet(integersIn: startRow...endRow)
selectRowIndexes(range, byExtendingSelection: false)
scrollRowToVisible(targetRow)
} else {
let targetRow = min(numberOfRows - 1, currentRow + 1)
selectionAnchor = targetRow
selectionPivot = targetRow
focusedRow = targetRow
selectRowIndexes(IndexSet(integer: targetRow), byExtendingSelection: false)
scrollRowToVisible(targetRow)
}
}
override func menu(for event: NSEvent) -> NSMenu? {
let point = convert(event.locationInWindow, from: nil)
let clickedRow = row(at: point)
if clickedRow >= 0,
let rowView = rowView(atRow: clickedRow, makeIfNecessary: false) as? TableRowViewWithMenu {
if !selectedRowIndexes.contains(clickedRow) {
selectRowIndexes(IndexSet(integer: clickedRow), byExtendingSelection: false)
}
return rowView.menu(for: event)
}
return super.menu(for: event)
}
}