dojox/grid/_Events.js

• Provides:

  • dojox.grid._Events

• dojox.grid._Events

  • type

    Function

  • summary

    _Grid mixin that provides default implementations for grid events.

  • description

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

• dojox.grid._Events.cellOverClass

  • type

    String

  • summary

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

• dojox.grid._Events.onKeyEvent

  • parameters:
    • e
  • summary

    top level handler for Key Events

  • type

    Function

• dojox.grid._Events.onContentEvent

  • parameters:
    • e
  • summary

    Top level handler for Content events

  • type

    Function

• dojox.grid._Events.onHeaderEvent

  • parameters:
    • e
  • summary

    Top level handler for header events

  • type

    Function

• dojox.grid._Events.onStyleRow

  • parameters:
    • inRow: (typeof 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.

  • summary

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

  • example

    onStyleRow({ selected: true, over:true, odd:false })

  • type

    Function

• dojox.grid._Events.onKeyDown

  • parameters:
    • e
  • summary

    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.

  • type

    Function

• dojox.grid._Events.focus.focusView

  • type

    Object

• dojox.grid._Events.onMouseOver

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse is over the grid.

  • type

    Function

• dojox.grid._Events.onMouseOut

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves out of the grid.

  • type

    Function

• dojox.grid._Events.onMouseDown

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse is down inside grid.

  • type

    Function

• dojox.grid._Events.onMouseOverRow

  • parameters:
    • e: (typeof Event)

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

  • summary

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

  • type

    Function

• dojox.grid._Events.onMouseOutRow

  • parameters:
    • e: (typeof Event)

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

  • summary

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

  • type

    Function

• dojox.grid._Events.onMouseDownRow

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse is down inside grid row

  • type

    Function

• dojox.grid._Events.onCellMouseOver

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse is over a cell.

  • type

    Function

• dojox.grid._Events.onCellMouseOut

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves out of a cell.

  • type

    Function

• dojox.grid._Events.onCellMouseDown

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse is down in a header cell.

  • type

    Function

• dojox.grid._Events.onCellClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when a cell is clicked.

  • type

    Function

• dojox.grid._Events._click.0

• dojox.grid._Events._click.1

• dojox.grid._Events.onCellDblClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when a cell is double-clicked.

  • type

    Function

• dojox.grid._Events.onCellContextMenu

  • parameters:
    • e: (typeof Event)

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

  • summary

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

  • type

    Function

• dojox.grid._Events.onCellFocus

  • parameters:
    • inCell: (typeof Object)

      Cell object containing properties of the grid column.

    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event fired when a cell receives focus.

  • type

    Function

• dojox.grid._Events.onRowClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when a row is clicked.

  • type

    Function

• dojox.grid._Events.onRowDblClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when a row is double clicked.

  • type

    Function

• dojox.grid._Events.onRowMouseOver

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves over a data row.

  • type

    Function

• dojox.grid._Events.onRowMouseOut

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves out of a data row.

  • type

    Function

• dojox.grid._Events.onRowMouseDown

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse is down in a row.

  • type

    Function

• dojox.grid._Events.onRowContextMenu

  • parameters:
    • e: (typeof Event)

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

  • summary

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

  • type

    Function

• dojox.grid._Events.onHeaderMouseOver

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves over the grid header.

  • type

    Function

• dojox.grid._Events.onHeaderMouseOut

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves out of the grid header.

  • type

    Function

• dojox.grid._Events.onHeaderCellMouseOver

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves over a header cell.

  • type

    Function

• dojox.grid._Events.onHeaderCellMouseOut

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse moves out of a header cell.

  • type

    Function

• dojox.grid._Events.onHeaderCellMouseDown

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when mouse is down in a header cell.

  • type

    Function

• dojox.grid._Events.onHeaderClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when the grid header is clicked.

  • type

    Function

• dojox.grid._Events.onHeaderCellClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when a header cell is clicked.

  • type

    Function

• dojox.grid._Events.onHeaderDblClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when the grid header is double clicked.

  • type

    Function

• dojox.grid._Events.onHeaderCellDblClick

  • parameters:
    • e: (typeof Event)

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

  • summary

    Event fired when a header cell is double clicked.

  • type

    Function

• dojox.grid._Events.onHeaderCellContextMenu

  • parameters:
    • e: (typeof Event)

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

  • summary

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

  • type

    Function

• dojox.grid._Events.onHeaderContextMenu

  • parameters:
    • e: (typeof Event)

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

  • summary

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

  • type

    Function

• dojox.grid._Events.onStartEdit

  • parameters:
    • inCell: (typeof Object)

      Cell object containing properties of the grid column.

    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event fired when editing is started for a given grid cell

  • type

    Function

• dojox.grid._Events.onApplyCellEdit

  • parameters:
    • inValue: (typeof String)

      Value from cell editor

    • inRowIndex: (typeof Integer)

      Index of the grid row

    • inFieldIndex: (typeof Integer)

      Index in the grid's data store

  • summary

    Event fired when editing is applied for a given grid cell

  • type

    Function

• dojox.grid._Events.onCancelEdit

  • parameters:
    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event fired when editing is cancelled for a given grid cell

  • type

    Function

• dojox.grid._Events.onApplyEdit

  • parameters:
    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event fired when editing is applied for a given grid row

  • type

    Function

• dojox.grid._Events.onCanSelect

  • parameters:
    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event to determine if a grid row may be selected

  • return_summary

    Boolean
    true if the row can be selected

  • type

    Function

• dojox.grid._Events.onCanDeselect

  • parameters:
    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event to determine if a grid row may be deselected

  • return_summary

    Boolean
    true if the row can be deselected

  • type

    Function

• dojox.grid._Events.onSelected

  • parameters:
    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event fired when a grid row is selected

  • type

    Function

• dojox.grid._Events.onDeselected

  • parameters:
    • inRowIndex: (typeof Integer)

      Index of the grid row

  • summary

    Event fired when a grid row is deselected

  • type

    Function

• dojox.grid._Events.onSelectionChanged

  • type

    Function

• dojox.grid

  • type

    Object

• dojox

  • type

    Object