Class BasicMouseHandler

A basic implementation of a data grid mouse handler.

Notes

This class may be subclassed and customized as needed.

Implements

IMouseHandler

Index

Constructors

Properties

_disposed _pressData

Accessors

isDisposed pressData

Methods

cursorForHandle dispose onContextMenu onMouseDoubleClick onMouseDown onMouseHover onMouseLeave onMouseMove onMouseUp onWheel release

Constructors

constructor

new BasicMouseHandler(): BasicMouseHandler
Returns BasicMouseHandler

Properties

`Private` _disposed

_disposed: boolean = false

`Protected` _pressData

_pressData: null | PressData = null

Accessors

isDisposed

get isDisposed(): boolean
Whether the mouse handler is disposed.

Returns boolean
Implementation of IMouseHandler.isDisposed
- Defined in datagrid/src/basicmousehandler.ts:58

pressData

get pressData(): null | PressData
Get the current pressData

Returns null | PressData
- Defined in datagrid/src/basicmousehandler.ts:739

Methods

cursorForHandle

cursorForHandle(handle): string
Convert a resize handle into a cursor.
Parameters
- handle: ResizeHandle
Returns string
- Defined in datagrid/src/basicmousehandler.ts:732

dispose

dispose(): void
Dispose of the resources held by the mouse handler.

Returns void
Implementation of IMouseHandler.dispose
- Defined in datagrid/src/basicmousehandler.ts:42

onContextMenu

onContextMenu(grid, event): void
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
Implementation of IMouseHandler.onContextMenu
- Defined in datagrid/src/basicmousehandler.ts:670

onMouseDoubleClick

onMouseDoubleClick(grid, event): void
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
Implementation of IMouseHandler.onMouseDoubleClick
- Defined in datagrid/src/basicmousehandler.ts:604

onMouseDown

onMouseDown(grid, event): void
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
Implementation of IMouseHandler.onMouseDown
- Defined in datagrid/src/basicmousehandler.ts:136

onMouseHover

onMouseHover(grid, event): void
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
Implementation of IMouseHandler.onMouseHover
- Defined in datagrid/src/basicmousehandler.ts:88

onMouseLeave

onMouseLeave(grid, event): void
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
Implementation of IMouseHandler.onMouseLeave
- Defined in datagrid/src/basicmousehandler.ts:122

onMouseMove

onMouseMove(grid, event): void
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
Implementation of IMouseHandler.onMouseMove
- Defined in datagrid/src/basicmousehandler.ts:419

onMouseUp

onMouseUp(grid, event): void
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
Implementation of IMouseHandler.onMouseUp
- Defined in datagrid/src/basicmousehandler.ts:593

onWheel

onWheel(grid, event): void
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
Implementation of IMouseHandler.onWheel
- Defined in datagrid/src/basicmousehandler.ts:681

release

release(): void
Release the resources held by the handler.

Returns void
Implementation of IMouseHandler.release
- Defined in datagrid/src/basicmousehandler.ts:65