Class BasicKeyHandler

A basic implementation of a data grid key handler.

Notes

This class may be subclassed and customized as needed.

Hierarchy

BasicKeyHandler

Implements

IKeyHandler

Index

Properties

_disposed

Accessors

isDisposed

Methods

Properties

Private _disposed

_disposed: boolean = false

Accessors

isDisposed

get isDisposed(): boolean

- Defined in datagrid/src/basickeyhandler.ts:32
Whether the key handler is disposed.

Returns boolean

Methods

dispose

dispose(): void

Implementation of IKeyHandler.dispose
- Defined in datagrid/src/basickeyhandler.ts:39
Dispose of the resources held by the key handler.

Returns void

Protected onArrowDown

onArrowDown(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:473
Handle the 'ArrowDown' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Protected onArrowLeft

onArrowLeft(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:131
Handle the 'ArrowLeft' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Protected onArrowRight

onArrowRight(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:245
Handle the 'ArrowRight' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Protected onArrowUp

onArrowUp(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:359
Handle the 'ArrowUp' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Protected onDelete

onDelete(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:754
Handle the 'Delete' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Protected onEscape

onEscape(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:741
Handle the 'Escape' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Protected onKeyC

onKeyC(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:786
Handle the 'C' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

onKeyDown

onKeyDown(grid: DataGrid, event: KeyboardEvent): void

Implementation of IKeyHandler.onKeyDown
- Defined in datagrid/src/basickeyhandler.ts:53
Handle the key down event for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keydown event of interest.
  
  Notes
  
  This will not be called if the mouse button is pressed.
Returns void

Protected onPageDown

onPageDown(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:664
Handle the 'PageDown' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Protected onPageUp

onPageUp(grid: DataGrid, event: KeyboardEvent): void

- Defined in datagrid/src/basickeyhandler.ts:587
Handle the 'PageUp' key press for the data grid.

Parameters
- grid: DataGrid
  
  The data grid of interest.
- event: KeyboardEvent
  
  The keyboard event of interest.
Returns void

Generated using TypeDoc