| 1 |
import { |
| 2 |
BasicMouseHandler, |
| 3 |
CellRenderer, |
| 4 |
DataGrid, |
| 5 |
HyperlinkRenderer, |
| 6 |
TextRenderer, |
| 7 |
} from '@lumino/datagrid'; |
| 8 |
import { Platform } from '@lumino/domutils'; |
| 9 |
import { ISignal, Signal } from '@lumino/signaling'; |
| 10 |
import { HeaderRenderer } from './core/headerRenderer'; |
| 11 |
import { FeatherGrid } from './feathergrid'; |
| 12 |
|
| 13 |
export class MouseHandler extends BasicMouseHandler { |
| 14 |
/** |
| 15 |
* Construct a new datagrid mouse handler. |
| 16 |
* |
| 17 |
* @param grid - The FeatherGrid object for which mouse events are handled. |
| 18 |
*/ |
| 19 |
constructor(grid: FeatherGrid) { |
| 20 |
super(); |
| 21 |
|
| 22 |
this._grid = grid; |
| 23 |
} |
| 24 |
|
| 25 |
/** |
| 26 |
* Handle the mouse down event for the data grid. |
| 27 |
* |
| 28 |
* @param grid - The data grid of interest. |
| 29 |
* |
| 30 |
* @param event - The mouse down event of interest. |
| 31 |
*/ |
| 32 |
onMouseDown(grid: DataGrid, event: MouseEvent): void { |
| 33 |
const hit = grid.hitTest(event.clientX, event.clientY); |
| 34 |
const hitRegion = hit.region; |
| 35 |
const buttonSize = HeaderRenderer.iconWidth * 1.5; |
| 36 |
const buttonPadding = HeaderRenderer.buttonPadding; |
| 37 |
const accel = Platform.accelKey(event); |
| 38 |
|
| 39 |
this._mouseIsDown = true; |
| 40 |
|
| 41 |
// Send cell clicked signal |
| 42 |
if (hit.region !== 'void') { |
| 43 |
this._cellClicked.emit(hit); |
| 44 |
} |
| 45 |
|
| 46 |
if (hitRegion === 'corner-header' || hitRegion === 'column-header') { |
| 47 |
const columnWidth = grid.columnSize( |
| 48 |
hitRegion === 'corner-header' ? 'row-header' : 'body', |
| 49 |
hit.column, |
| 50 |
); |
| 51 |
const rowHeight = grid.rowSize('column-header', hit.row); |
| 52 |
|
| 53 |
const isMenuRow = |
| 54 |
(hit.region === 'column-header' && |
| 55 |
hit.row == |
| 56 |
this._grid.grid.dataModel!.rowCount('column-header') - 1) || |
| 57 |
(hit.region === 'corner-header' && hit.row === 0); |
| 58 |
|
| 59 |
const isMenuClick = |
| 60 |
hit.x > columnWidth - buttonSize - buttonPadding && |
| 61 |
hit.x < columnWidth - buttonPadding && |
| 62 |
hit.y > rowHeight - buttonSize - buttonPadding && |
| 63 |
hit.y < rowHeight - buttonPadding && |
| 64 |
isMenuRow; |
| 65 |
|
| 66 |
if (isMenuClick) { |
| 67 |
this._grid.contextMenu.open(grid, { |
| 68 |
...hit, |
| 69 |
x: event.clientX + window.scrollX, |
| 70 |
y: event.clientY + window.scrollY, |
| 71 |
}); |
| 72 |
return; |
| 73 |
} |
| 74 |
} |
| 75 |
if (grid) { |
| 76 |
// Create cell config object. |
| 77 |
const config = MouseHandler.createCellConfigObject(grid, hit); |
| 78 |
|
| 79 |
// Bail if no cell config object is defined for the region. |
| 80 |
if (!config) { |
| 81 |
return; |
| 82 |
} |
| 83 |
|
| 84 |
// Retrieve cell renderer. |
| 85 |
const renderer = grid.cellRenderers.get(config!); |
| 86 |
|
| 87 |
// Only process hyperlink renderers. |
| 88 |
if (renderer instanceof HyperlinkRenderer) { |
| 89 |
// Use the url param if it exists. |
| 90 |
let url = CellRenderer.resolveOption(renderer.url, config!); |
| 91 |
// Otherwise assume cell value is the URL. |
| 92 |
if (!url) { |
| 93 |
const format = TextRenderer.formatGeneric(); |
| 94 |
url = format(config!); |
| 95 |
} |
| 96 |
|
| 97 |
// Emit message to open the hyperlink only if user hit Ctrl+Click. |
| 98 |
if (accel) { |
| 99 |
// Emit event that will be caught in case window.open is blocked |
| 100 |
window.postMessage( |
| 101 |
{ |
| 102 |
id: 'ipydatagrid::hyperlinkclick', |
| 103 |
url, |
| 104 |
}, |
| 105 |
'*', |
| 106 |
); |
| 107 |
// Reset cursor default after clicking |
| 108 |
const cursor = this.cursorForHandle('none'); |
| 109 |
grid.viewport.node.style.cursor = cursor; |
| 110 |
} |
| 111 |
} |
| 112 |
} |
| 113 |
super.onMouseDown(grid, event); |
| 114 |
} |
| 115 |
|
| 116 |
onMouseUp(grid: DataGrid, event: MouseEvent): void { |
| 117 |
this._mouseIsDown = false; |
| 118 |
super.onMouseUp(grid, event); |
| 119 |
} |
| 120 |
|
| 121 |
get mouseIsDown(): boolean { |
| 122 |
return this._mouseIsDown; |
| 123 |
} |
| 124 |
|
| 125 |
get isResizing(): boolean { |
| 126 |
return ( |
| 127 |
this.pressData !== null && |
| 128 |
(this.pressData.type == 'column-resize' || |
| 129 |
this.pressData.type == 'row-resize') |
| 130 |
); |
| 131 |
} |
| 132 |
|
| 133 |
/** |
| 134 |
* A signal emitted when a grid cell is clicked. |
| 135 |
*/ |
| 136 |
get cellClicked(): ISignal<this, DataGrid.HitTestResult> { |
| 137 |
return this._cellClicked; |
| 138 |
} |
| 139 |
|
| 140 |
/** |
| 141 |
* Creates a CellConfig object from a hit region. |
| 142 |
*/ |
| 143 |
private static createCellConfigObject( |
| 144 |
grid: DataGrid, |
| 145 |
hit: DataGrid.HitTestResult, |
| 146 |
): CellRenderer.CellConfig | undefined { |
| 147 |
const { region, row, column } = hit; |
| 148 |
|
| 149 |
// Terminate call if region is void. |
| 150 |
if (region === 'void') { |
| 151 |
return undefined; |
| 152 |
} |
| 153 |
|
| 154 |
// Augment hit region params with value and metadata. |
| 155 |
const value = grid.dataModel!.data(region, row, column); |
| 156 |
const metadata = grid.dataModel!.metadata(region, row, column); |
| 157 |
|
| 158 |
// Create cell config object to retrieve cell renderer. |
| 159 |
const config = { |
| 160 |
...hit, |
| 161 |
value: value, |
| 162 |
metadata: metadata, |
| 163 |
} as CellRenderer.CellConfig; |
| 164 |
|
| 165 |
return config; |
| 166 |
} |
| 167 |
|
| 168 |
private _grid: FeatherGrid; |
| 169 |
private _mouseIsDown = false; |
| 170 |
private _cellClicked = new Signal<this, DataGrid.HitTestResult>(this); |
| 171 |
} |