_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.
css class to apply to grid cells over which the cursor is placed.
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 |
Event fired when editing is applied for a given grid row
Parameter | Type | Description |
---|---|---|
inRowIndex | Integer | Index of the grid row |
Event fired when editing is cancelled for a given grid cell
Parameter | Type | Description |
---|---|---|
inRowIndex | Integer | Index of the grid row |
Event to determine if a grid row may be deselected
Parameter | Type | Description |
---|---|---|
inRowIndex | Integer | Index of the grid row |
true if the row can be deselected
Event to determine if a grid row may be selected
Parameter | Type | Description |
---|---|---|
inRowIndex | Integer | Index of the grid row |
true if the row can be selected
Event fired when a cell is clicked.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object which contains reference to grid, cell, and rowIndex |
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 |
Event fired when a cell is double-clicked.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object contains reference to grid, cell, and rowIndex |
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 |
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 |
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 |
Event fired when mouse is over a cell.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object contains reference to grid, cell, and rowIndex |
Top level handler for Content events
Parameter | Type | Description |
---|---|---|
e | undefined |
Event fired when a grid row is deselected
Parameter | Type | Description |
---|---|---|
inRowIndex | Integer | Index of the grid row |
Event fired when a header cell is clicked.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object which contains reference to grid, cell, and rowIndex |
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 |
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 |
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 |
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 |
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 |
Event fired when the grid header is clicked.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object which contains reference to grid, cell, and rowIndex |
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 |
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 |
Top level handler for header events
Parameter | Type | Description |
---|---|---|
e | undefined |
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 |
Event fired when mouse moves over the grid header.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object contains reference to grid, cell, and rowIndex |
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 |
top level handler for Key Events
Parameter | Type | Description |
---|---|---|
e | undefined |
Event fired when mouse is down inside grid.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object that contains reference to grid, cell, and rowIndex |
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 |
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 |
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 |
Event fired when mouse is over the grid.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object contains reference to grid, cell, and rowIndex |
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 |
Event fired when a row is clicked.
Parameter | Type | Description |
---|---|---|
e | Event | Decorated event object which contains reference to grid, cell, and rowIndex |
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 |
Event fired when a row is double clicked.
Parameter | Type | Description |
---|---|---|
e | Event | decorated event object which contains reference to grid, cell, and rowIndex |
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 |
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 |
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 |
Event fired when a grid row is selected
Parameter | Type | Description |
---|---|---|
inRowIndex | Integer | Index of the grid row |
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 |
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. |
onStyleRow({ selected: true, over:true, odd:false })