GridElementEvents
Mixin

Mixin for Grid that handles dom events. Some listeners fire own events but all can be chained by features. None of the functions in this class are indented to be called directly.

See Grid for more information on grid keyboard interaction.

Configs

Configs are options you supply in a configuration object when creating an instance of this class

enableUndoRedoKeys : Booleantrue

Set to true to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is pressed). Only applicable when using a StateTrackingManager.

Has a corresponding runtime enableUndoRedoKeys property.
hoverCls : Stringb-hover

A CSS class to add to hovered row elements
longPressTime : Number400

Time in ms until a longpress is triggered

Has a corresponding runtime longPressTime property.

Properties

Properties are getters/setters or publicly accessible variables on this class

isGridElementEvents : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of GridElementEvents class, or subclass thereof.

isGridElementEvents : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of GridElementEvents class, or subclass thereof.
enableUndoRedoKeys : Booleantrue

Set to true to listen for CTRL-Z (CMD-Z on Mac OS) keyboard event and trigger undo (redo when SHIFT is pressed). Only applicable when using a StateTrackingManager.

Has a corresponding enableUndoRedoKeys config.
hoveredCell : HTMLElement

READONLY

The currently hovered grid cell
longPressTime : Number400

Time in ms until a longpress is triggered

Has a corresponding longPressTime config.

Functions

Functions are methods available for calling on the class

getCellDataFromElement( cellElement )
: Object

internal

This method finds the cell location of the passed element. It returns an object describing the cell.
getCellDataFromEvent( event, includeSingleAxisMatchfalse )
: Object

internal

This method finds the cell location of the passed event. It returns an object describing the cell.
getHeaderDataFromEvent( event )
: Object

internal

This method finds the header location of the passed event. It returns an object describing the header.
handleEvent( event )

private

Handles all dom events, routing them to correct functions (touchstart -> onElementTouchStart)
initInternalEvents( )

private

Init listeners for a bunch of dom events. All events are handled by handleEvent().
onElementKeyDown( event )

internal

To catch all keydowns. For more specific keydown actions, use keyMap.
onElementKeyPress( event )

internal

Key press, chain this function in features to handle the dom event.
onElementKeyUp( event )

internal

Key up, chain this function in features to handle the dom event.
onElementClick( event )

internal

Click, select cell on click and also fire 'cellClick' event. Chain this function in features to handle the dom event.

Triggers: cellClick
onElementDblClick( event )

internal

Double click, fires 'cellDblClick' event. Chain this function in features to handle the dom event.

Triggers: cellDblClick, columnResize
onElementMouseDown( event )

internal

Mouse down, chain this function in features to handle the event.
onElementMouseMove( event )

internal

Mouse move, chain this function in features to handle the event.
onElementMouseOut( event )

internal

Mouse out, removes 'hover' class from elements.

Triggers: mouseOut
onElementMouseOver( event )

internal

Mouse over, adds 'hover' class to elements.

Triggers: mouseOver
onElementMouseUp( event )

internal

Mouse up, chain this function in features to handle the event.
onElementPointerUp( event )

internal

Pointer up, chain this function in features to handle the event.
onHandleElementClick( event )

internal

Called before onElementClick. Fires 'beforeElementClick' event which can return false to cancel further onElementClick actions.

Triggers: beforeElementClick
onElementContextMenu( event )

internal

Context menu, chain this function in features to handle the dom event. In most cases, include ContextMenu feature instead.
onInternalResize( element, width, height, oldWidth, oldHeight )

internal

Overrides empty base function in View, called when view is resized.

Triggers: resize
onElementTouchEnd( event )

internal

Touch end, chain this function in features to handle the event.
onElementTouchMove( event )

internal

Touch move, chain this function in features to handle the event.
onElementTouchStart( event )

internal

Touch start, chain this function in features to handle the event.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

cellClick

Fired when user clicks in a grid cell
cellContextMenu

Fired when user activates contextmenu in a grid cell
cellDblClick

Fired when user double clicks a grid cell
cellMouseEnter

Fired when the mouse enters a cell
cellMouseLeave

Fired when the mouse leaves a cell
cellMouseOut

Fired when a user moves the mouse out of a grid cell
cellMouseOver

Fired when user moves the mouse over a grid cell
headerClick

PREVENTABLE

Fired when a grid header is clicked on.

Returning false from a handler prevents any features (such as Sort) from recieving and processing the click event.
mouseOut

Mouse moved out from element in grid
mouseOver

Mouse moved in over element in grid
rowMouseEnter

Fired when the mouse enters a row
rowMouseLeave

Fired when the mouse leaves a row

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onCellClick

Called when user clicks in a grid cell
onCellContextMenu

Called when user activates contextmenu in a grid cell
onCellDblClick

Called when user double clicks a grid cell
onCellMouseEnter

Called when the mouse enters a cell
onCellMouseLeave

Called when the mouse leaves a cell
onCellMouseOut

Called when a user moves the mouse out of a grid cell
onCellMouseOver

Called when user moves the mouse over a grid cell
onHeaderClick

PREVENTABLE

Called when a grid header is clicked on.

Returning false from a handler prevents any features (such as Sort) from recieving and processing the click event.
onMouseOut

Mouse moved out from element in grid
onMouseOver

Mouse moved in over element in grid
onRowMouseEnter

Called when the mouse enters a row
onRowMouseLeave

Called when the mouse leaves a row

Source path

Grid/view/mixin/GridElementEvents.js

Inheritance tree1

GridElementEvents

GridElementEvents
Mixin

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree1

Contents

GridElementEvents Mixin

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree1

Contents

GridElementEvents
Mixin