dojox/grid/_Events (version 1.10)

Summary

_Grid mixin that provides default implementations for grid events.

Default synthetic events dispatched for _Grid. dojo.connect to events to retain default implementation or override them for custom handling.

Property Summary

  • cellOverClasscss class to apply to grid cells over which the cursor is placed.

Event Summary

Properties

cellOverClass
Defined by: dojox/grid/_Events

css class to apply to grid cells over which the cursor is placed.

Events

onApplyCellEdit(inValue,inRowIndex,inFieldIndex)
Defined by: dojox/grid/_Events

Event fired when editing is applied for a given grid cell

Parameter Type Description
inValue String

Value from cell editor

inRowIndex Integer

Index of the grid row

inFieldIndex Integer

Index in the grid's data store

onApplyEdit(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when editing is applied for a given grid row

Parameter Type Description
inRowIndex Integer

Index of the grid row

onCancelEdit(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when editing is cancelled for a given grid cell

Parameter Type Description
inRowIndex Integer

Index of the grid row

onCanDeselect(inRowIndex)
Defined by: dojox/grid/_Events

Event to determine if a grid row may be deselected

Parameter Type Description
inRowIndex Integer

Index of the grid row

Returns:Boolean | boolean

true if the row can be deselected

onCanSelect(inRowIndex)
Defined by: dojox/grid/_Events

Event to determine if a grid row may be selected

Parameter Type Description
inRowIndex Integer

Index of the grid row

Returns:Boolean | boolean

true if the row can be selected

onCellClick(e)
Defined by: dojox/grid/_Events

Event fired when a cell is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onCellContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when a cell context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onCellDblClick(e)
Defined by: dojox/grid/_Events

Event fired when a cell is double-clicked.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

onCellFocus(inCell,inRowIndex)
Defined by: dojox/grid/_Events

Event fired when a cell receives focus.

Parameter Type Description
inCell Object

Cell object containing properties of the grid column.

inRowIndex Integer

Index of the grid row

onCellMouseDown(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down in a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onCellMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of a cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onCellMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse is over a cell.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

onContentEvent(e)
Defined by: dojox/grid/_Events

Top level handler for Content events

Parameter Type Description
e undefined
onDeselected(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when a grid row is deselected

Parameter Type Description
inRowIndex Integer

Index of the grid row

onHeaderCellClick(e)
Defined by: dojox/grid/_Events

Event fired when a header cell is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderCellContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when a header cell context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderCellDblClick(e)
Defined by: dojox/grid/_Events

Event fired when a header cell is double clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderCellMouseDown(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down in a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderCellMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderCellMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves over a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderClick(e)
Defined by: dojox/grid/_Events

Event fired when the grid header is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when the grid header context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderDblClick(e)
Defined by: dojox/grid/_Events

Event fired when the grid header is double clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderEvent(e)
Defined by: dojox/grid/_Events

Top level handler for header events

Parameter Type Description
e undefined
onHeaderMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of the grid header.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onHeaderMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves over the grid header.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

onKeyDown(e)
Defined by: dojox/grid/_Events

Grid key event handler. By default enter begins editing and applies edits, escape cancels an edit, tab, shift-tab, and arrow keys move grid cell focus.

Parameter Type Description
e undefined
onKeyEvent(e)
Defined by: dojox/grid/_Events

top level handler for Key Events

Parameter Type Description
e undefined
onMouseDown(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down inside grid.

Parameter Type Description
e Event

Decorated event object that contains reference to grid, cell, and rowIndex

onMouseDownRow(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down inside grid row

Parameter Type Description
e Event

Decorated event object that contains reference to grid, cell, and rowIndex

onMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of the grid.

Parameter Type Description
e Event

Decorated event object that contains reference to grid, cell, and rowIndex

onMouseOutRow(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of any row (data or header).

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

onMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse is over the grid.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

onMouseOverRow(e)
Defined by: dojox/grid/_Events

Event fired when mouse is over any row (data or header).

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

onRowClick(e)
Defined by: dojox/grid/_Events

Event fired when a row is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onRowContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when a row context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onRowDblClick(e)
Defined by: dojox/grid/_Events

Event fired when a row is double clicked.

Parameter Type Description
e Event

decorated event object which contains reference to grid, cell, and rowIndex

onRowMouseDown(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down in a row.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onRowMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of a data row.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

onRowMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves over a data row.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

onSelected(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when a grid row is selected

Parameter Type Description
inRowIndex Integer

Index of the grid row

onSelectionChanged()
Defined by: dojox/grid/_Events
onStartEdit(inCell,inRowIndex)
Defined by: dojox/grid/_Events

Event fired when editing is started for a given grid cell

Parameter Type Description
inCell Object

Cell object containing properties of the grid column.

inRowIndex Integer

Index of the grid row

onStyleRow(inRow)
Defined by: dojox/grid/_Events

Perform row styling on a given row. Called whenever row styling is updated.

Parameter Type Description
inRow Object

Object containing row state information: selected, true if the row is selcted; over: true of the mouse is over the row; odd: true if the row is odd. Use customClasses and customStyles to control row css classes and styles; both properties are strings.

Examples

Example 1

onStyleRow({ selected: true, over:true, odd:false })
Error in the documentation? Can’t find what you are looking for? Let us know!