Class BasicMouseHandler

A basic implementation of a data grid mouse handler.

Notes

This class may be subclassed and customized as needed.

Hierarchy

BasicMouseHandler

Implements

IMouseHandler

Index

Properties

Accessors

Methods

Properties

Private _disposed

_disposed: boolean = false

Protected _pressData

_pressData: PressData | null = null

Accessors

isDisposed

get isDisposed(): boolean

- Defined in datagrid/src/basicmousehandler.ts:58
Whether the mouse handler is disposed.

Returns boolean

pressData

get pressData(): PressData | null

- Defined in datagrid/src/basicmousehandler.ts:697
Get the current pressData

Returns PressData | null

Methods

cursorForHandle

cursorForHandle(handle: ResizeHandle): string

- Defined in datagrid/src/basicmousehandler.ts:690
Convert a resize handle into a cursor.

Parameters
- handle: ResizeHandle
Returns string

dispose

dispose(): void

Implementation of IMouseHandler.dispose
- Defined in datagrid/src/basicmousehandler.ts:42
Dispose of the resources held by the mouse handler.

Returns void

onContextMenu

onContextMenu(grid: DataGrid, event: MouseEvent): void

Implementation of IMouseHandler.onContextMenu
- Defined in datagrid/src/basicmousehandler.ts:645
Handle the context menu event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: MouseEvent
  
  The context menu event of interest.
Returns void

onMouseDoubleClick

onMouseDoubleClick(grid: DataGrid, event: MouseEvent): void

Implementation of IMouseHandler.onMouseDoubleClick
- Defined in datagrid/src/basicmousehandler.ts:604
Handle the mouse double click event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: MouseEvent
  
  The mouse up event of interest.
Returns void

onMouseDown

onMouseDown(grid: DataGrid, event: MouseEvent): void

Implementation of IMouseHandler.onMouseDown
- Defined in datagrid/src/basicmousehandler.ts:136
Handle the mouse down event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: MouseEvent
  
  The mouse down event of interest.
Returns void

onMouseHover

onMouseHover(grid: DataGrid, event: MouseEvent): void

Implementation of IMouseHandler.onMouseHover
- Defined in datagrid/src/basicmousehandler.ts:88
Handle the mouse hover event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: MouseEvent
  
  The mouse hover event of interest.
Returns void

onMouseLeave

onMouseLeave(grid: DataGrid, event: MouseEvent): void

Implementation of IMouseHandler.onMouseLeave
- Defined in datagrid/src/basicmousehandler.ts:122
Handle the mouse leave event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: MouseEvent
  
  The mouse hover event of interest.
Returns void

onMouseMove

onMouseMove(grid: DataGrid, event: MouseEvent): void

Implementation of IMouseHandler.onMouseMove
- Defined in datagrid/src/basicmousehandler.ts:419
Handle the mouse move event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: MouseEvent
  
  The mouse move event of interest.
Returns void

onMouseUp

onMouseUp(grid: DataGrid, event: MouseEvent): void

Implementation of IMouseHandler.onMouseUp
- Defined in datagrid/src/basicmousehandler.ts:593
Handle the mouse up event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: MouseEvent
  
  The mouse up event of interest.
Returns void

onWheel

onWheel(grid: DataGrid, event: WheelEvent): void

Implementation of IMouseHandler.onWheel
- Defined in datagrid/src/basicmousehandler.ts:656
Handle the wheel event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: WheelEvent
  
  The wheel event of interest.
Returns void

release

release(): void

Implementation of IMouseHandler.release
- Defined in datagrid/src/basicmousehandler.ts:65
Release the resources held by the handler.

Returns void

Generated using TypeDoc