Class GeMouseEvent

A mouse event of the table: where it happened (area, side, row, column) plus the browser event. Passed to EventListenerIf.onMouseClicked, EventListenerIf.onContextmenu and the other mouse methods.

rowIndex is the row as displayed (after filter and sorting) – get your object with tableModel.getBodyModel().getRowByIndex(evt.rowIndex).

Example

override onContextmenu(evt: GeMouseEvent): void {
  if (evt.areaIdent !== "body" || evt.rowIndex < 0) return;
  evt.originalEvent?.preventDefault();                       // no browser menu
  showMyMenu(evt.originalEvent!.clientX, evt.originalEvent!.clientY, evt.rowIndex);
}

See

Training: Events and a context menu of your own

Hierarchy

  • GeMouseEvent

Constructors

constructor

Properties

action areaIdent? clickCount columnIndex columnLeft draggingX draggingY originalEvent? rowIndex rowTop sideIdent?

Methods

clone

Constructors

constructor

  • Parameters

    • rowIndex: number = -1

      Row index in the area (as displayed); -1 outside of rows.

    • rowTop: number = -1

      Top position of the row in px.

    • columnIndex: number = -1

      Column index (model index over west + center + east); -1 outside of columns.

    • columnLeft: number = -1

      Left position of the column in px.

    • Optional areaIdent: AreaIdent

      "header", "body" or "footer".

    • Optional sideIdent: SideIdent

      "west" (fixed left), "center" or "east" (fixed right).

    • Optional originalEvent: MouseEvent

      The browser event – position, buttons, modifier keys.

    • clickCount: number = 0

      1 = click, 2 = double-click on the same cell.

    • draggingX: number = 0

      Horizontal distance in px while dragging.

    • draggingY: number = 0

      Vertical distance in px while dragging.

    • action: null | string = ""

      Internal action of the clicked element (e.g. a tree arrow), otherwise empty.

    Returns GeMouseEvent

Properties

action

action: null | string = ""

Internal action of the clicked element (e.g. a tree arrow), otherwise empty.

Optional areaIdent

areaIdent?: AreaIdent

"header", "body" or "footer".

clickCount

clickCount: number = 0

1 = click, 2 = double-click on the same cell.

columnIndex

columnIndex: number = -1

Column index (model index over west + center + east); -1 outside of columns.

columnLeft

columnLeft: number = -1

Left position of the column in px.

draggingX

draggingX: number = 0

Horizontal distance in px while dragging.

draggingY

draggingY: number = 0

Vertical distance in px while dragging.

Optional originalEvent

originalEvent?: MouseEvent

The browser event – position, buttons, modifier keys.

rowIndex

rowIndex: number = -1

Row index in the area (as displayed); -1 outside of rows.

rowTop

rowTop: number = -1

Top position of the row in px.

Optional sideIdent

sideIdent?: SideIdent

"west" (fixed left), "center" or "east" (fixed right).

Methods

clone

Settings

Member Visibility

Theme

On This Page