Interface IMouseHandler

An object which handles mouse events for the data grid.

interface IMouseHandler {
    isDisposed: boolean;
    dispose(): void;
    onContextMenu(grid, event): void;
    onMouseDoubleClick(grid, event): void;
    onMouseDown(grid, event): void;
    onMouseHover(grid, event): void;
    onMouseLeave(grid, event): void;
    onMouseMove(grid, event): void;
    onMouseUp(grid, event): void;
    onWheel(grid, event): void;
    release(): void;
}

Hierarchy (view full)

Implemented by

Properties

isDisposed

Methods

dispose onContextMenu onMouseDoubleClick onMouseDown onMouseHover onMouseLeave onMouseMove onMouseUp onWheel release

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

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

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 double click event of interest.

    Returns void

onMouseDown

onMouseHover

onMouseLeave

onMouseMove

onMouseUp

onWheel

release

  • release(): void

  • Release any resources acquired during a mouse press.

    Notes

    This method is called when the mouse should be released independent of a mouseup event, such as an early detach.

    Returns void

Settings

Member Visibility

Theme

On This Page

isDisposeddisposeonContextMenuonMouseDoubleClickonMouseDownonMouseHoveronMouseLeaveonMouseMoveonMouseUponWheelrelease