Class BasicKeyHandler

A basic implementation of a data grid key handler.

Notes

This class may be subclassed and customized as needed.

Implements

IKeyHandler

Index

Constructors

Properties

Accessors

Methods

dispose onArrowDown onArrowLeft onArrowRight onArrowUp onDelete onEscape onKeyC onKeyDown onPageDown onPageUp

Constructors

constructor

new BasicKeyHandler(): BasicKeyHandler
Returns BasicKeyHandler

Properties

`Private` _disposed

_disposed: boolean = false

Accessors

isDisposed

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

Returns boolean
Implementation of IKeyHandler.isDisposed
- Defined in datagrid/src/basickeyhandler.ts:32

Methods

dispose

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

Returns void
Implementation of IKeyHandler.dispose
- Defined in datagrid/src/basickeyhandler.ts:39

`Protected` onArrowDown

onArrowDown(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:473

`Protected` onArrowLeft

onArrowLeft(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:131

`Protected` onArrowRight

onArrowRight(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:245

`Protected` onArrowUp

onArrowUp(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:359

`Protected` onDelete

onDelete(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:754

`Protected` onEscape

onEscape(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:741

`Protected` onKeyC

onKeyC(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:784

onKeyDown

onKeyDown(grid, event): void
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
Implementation of IKeyHandler.onKeyDown
- Defined in datagrid/src/basickeyhandler.ts:53

`Protected` onPageDown

onPageDown(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:664

`Protected` onPageUp

onPageUp(grid, event): void
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
- Defined in datagrid/src/basickeyhandler.ts:587