Interface IKeyHandler

An object which handles keydown events for the data grid.

interface IKeyHandler {
    isDisposed: boolean;
    dispose(): void;
    onKeyDown(grid, event): void;
}

Hierarchy (view full)

IDisposable
- IKeyHandler

Implemented by

BasicKeyHandler

Index

Properties

Methods

dispose onKeyDown

Properties

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Methods

dispose

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

Notes
If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from IDisposable.dispose
- Defined in disposable/types/index.d.ts:28

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
- Defined in datagrid/src/datagrid.ts:6560