dojox/grid/enhanced/plugins/IndirectSelection.js

• Provides:

  • dojox.grid.enhanced.plugins.IndirectSelection

• Requires:

  • dojo.string in common
  • dojox.grid.cells.dijit in common
  • dojox.grid.enhanced._Plugin in common

• dojox.grid.enhanced.plugins.IndirectSelection

  • type

    Function

  • chains:
    • dojox.grid.enhanced._Plugin: (prototype)
    • dojox.grid.enhanced._Plugin: (call)
  • summary

    A handy way for adding check boxe/radio button for rows, and selecting rows by swiping(or keyboard)

  • description

    For better rendering performance, div(images) are used to simulate radio button|check boxes

  • example

    <div dojoType="dojox.grid.EnhancedGrid" plugins="{indirectSelection: true}" ...></div>
    or <div dojoType="dojox.grid.EnhancedGrid" plugins="{indirectSelection: {name: 'xxx', width:'30px', styles:'text-align: center;'}}" ...></div>

• dojox.grid.enhanced.plugins.IndirectSelection.name

  • type

    String

  • summary

    Plugin name

• dojox.grid.enhanced.plugins.IndirectSelection.constructor

  • constructor - constructor
  • type

    Function

• dojox.grid.enhanced.plugins.IndirectSelection.addRowSelectCell

  • parameters:
    • option
  • summary

    Add indirectSelection cell(mapped to a column of radio button|check boxes)

  • type

    Function

• dojox.grid.enhanced.plugins.IndirectSelection.cellCount

• dojox.grid.enhanced.plugins.IndirectSelection.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.IndirectSelection.grid.layout

• dojox.grid.cells.RowSelector

  • type

    Function

  • chains:
    • dojox.grid.cells._Widget: (prototype)
    • dojox.grid.cells._Widget: (call)
  • summary

    Common attributes & functions for row selectors(Radio|CheckBox)

• dojox.grid.cells.RowSelector.inputType

  • type

    String

  • summary

    Input type - Radio|CheckBox

• dojox.grid.cells.RowSelector.map

  • type

    Object

  • summary

    Cache div refs of radio|checkbox to avoid querying each time

• dojox.grid.cells.RowSelector.disabledMap

  • type

    Object

  • summary

    Cache index of disabled rows

• dojox.grid.cells.RowSelector.isRowSelector

  • type

    Boolean

  • summary

    Marker of indirectSelection cell(column)

• dojox.grid.cells.RowSelector._connects

  • type

    Array

  • summary

    List of all connections.

• dojox.grid.cells.RowSelector._subscribes

  • type

    Array

  • summary

    List of all subscribes.

• dojox.grid.cells.RowSelector.checkedText

  • type

    String

  • summary

    Checked character for high contrast mode

• dojox.grid.cells.RowSelector.unCheckedText

  • type

    String

  • summary

    Unchecked character for high contrast mode

• dojox.grid.cells.RowSelector.constructor

  • constructor - constructor
  • type

    Function

• dojox.grid.cells.RowSelector.formatter

  • parameters:
    • data
    • rowIndex
  • summary

    Overwritten, see dojox.grid.cells._Widget

  • type

    Function

• dojox.grid.cells.RowSelector.baseClass

  • type

    String

• dojox.grid.cells.RowSelector.setValue

  • parameters:
    • rowIndex
    • inValue
  • summary

    Overwritten, see dojox.grid.cells._Widget
    Simply return, no action

  • type

    Function

• dojox.grid.cells.RowSelector.getValue

  • parameters:
    • rowIndex
  • summary

    Overwritten, see dojox.grid.cells._Widget

  • type

    Function

• dojox.grid.cells.RowSelector.toggleRow

  • parameters:
    • index: (typeof Integer)

      Row index

    • value: (typeof Boolean)

      True - checked | False - unchecked

  • summary

    toggle checked | unchecked state for given row

  • type

    Function

• dojox.grid.cells.RowSelector.setDisabled

  • parameters:
    • index
    • disabled: (typeof Boolean)

      True - disabled | False - enabled

  • summary

    toggle disabled | enabled state for given row
    idx: Integer
    Row index

  • type

    Function

• dojox.grid.cells.RowSelector.disabled

  • parameters:
    • index
  • summary

    Check if one row is disabled

  • type

    Function

• dojox.grid.cells.RowSelector._onClick

  • parameters:
    • e
  • summary

    When mouse click on the selector cell, select/deselect the row.

  • type

    Function

• dojox.grid.cells.RowSelector._dokeyup

  • parameters:
    • e: (typeof Event)

      Key up event

  • summary

    Event handler for key up event
    - from dojox.grid.enhanced._Events.dokeyup()

  • type

    Function

• dojox.grid.cells.RowSelector.focus

  • parameters:
    • rowIndex: (typeof Integer)

      Target row

  • summary

    Set focus to given row

  • type

    Function

• dojox.grid.cells.RowSelector._focusEndingCell

  • parameters:
    • rowIndex: (typeof Integer)

      Row index

    • cellIndex: (typeof Integer)

      Column index

  • summary

    Set focus to the ending grid cell(rowIndex,cellIndex) when swipe selection finished

  • type

    Function

• dojox.grid.cells.RowSelector._nativeSelect

  • parameters:
    • index
    • value
  • summary

    Use grid's native selection

  • type

    Function

• dojox.grid.cells.RowSelector._onSelected

  • parameters:
    • index
  • summary

    Triggered when a row is selected

  • type

    Function

• dojox.grid.cells.RowSelector._onDeselected

  • parameters:
    • index
  • summary

    Triggered when a row is deselected

  • type

    Function

• dojox.grid.cells.RowSelector._onUpdateRow

  • parameters:
    • index
  • summary

    Clear cache when row is re-built.

  • type

    Function

• dojox.grid.cells.RowSelector._toggleCheckedStyle

  • parameters:
    • index
    • value
  • summary

    Change css styles for checked | unchecked

  • type

    Function

• dojox.grid.cells.RowSelector._toggleDisabledStyle

  • parameters:
    • index
    • disabled
  • summary

    Change css styles for disabled | enabled

  • type

    Function

• dojox.grid.cells.RowSelector._getSelector

  • parameters:
    • index
  • summary

    Find selector for given row caching it if 1st time found

  • type

    Function

• dojox.grid.cells.RowSelector._pageDestroyed

  • parameters:
    • pageIndex: (typeof Integer)

      Index of destroyed page

  • summary

    Explicitly empty map cache when a page destroyed
    See dojox.grid._Scroller.invalidatePageNode()

  • type

    Function

• dojox.grid.cells.RowSelector.grid.scroller.rowsPerPage

• dojox.grid.cells.RowSelector.destroy

  • type

    Function

• dojox.grid.cells.RowSelector.disabledCount

  • type

    Number

• dojox.grid.cells.RowSelector.inA11YMode

  • type

    Object

• dojox.grid.cells.RowSelector.checkedClass

  • type

    String

• dojox.grid.cells.RowSelector.disabledClass

  • type

    String

• dojox.grid.cells.RowSelector.checkedDisabledClass

  • type

    String

• dojox.grid.cells.RowSelector.statusTextClass

  • type

    String

• dojox.grid.cells.SingleRowSelector

  • type

    Function

  • chains:
    • dojox.grid.cells.RowSelector: (prototype)
    • dojox.grid.cells.RowSelector: (call)
  • summary

    IndirectSelection cell(column) for single selection mode, using styles of dijit.form.RadioButton

• dojox.grid.cells.SingleRowSelector.inputType

  • type

    String

• dojox.grid.cells.SingleRowSelector._selectRow

  • parameters:
    • e: (typeof Event)

      Event fired on the target row

  • summary

    Select the target row

  • type

    Function

• dojox.grid.cells.MultipleRowSelector

  • type

    Function

  • chains:
    • dojox.grid.cells.RowSelector: (prototype)
    • dojox.grid.cells.RowSelector: (call)
  • summary

    Indirect selection cell for multiple or extended mode, using dijit.form.CheckBox

• dojox.grid.cells.MultipleRowSelector.inputType

  • type

    String

• dojox.grid.cells.MultipleRowSelector.swipeStartRowIndex

  • type

    Integer

  • summary

    Start row index for swipe selection

• dojox.grid.cells.MultipleRowSelector.swipeMinRowIndex

  • type

    Integer

  • summary

    Max row index for swipe selection

• dojox.grid.cells.MultipleRowSelector.swipeMaxRowIndex

  • type

    Number

• dojox.grid.cells.MultipleRowSelector.toSelect

  • type

    Boolean

  • summary

    new state for selection

• dojox.grid.cells.MultipleRowSelector.lastClickRowIdx

  • type

    Integer

  • summary

    Row index for last click, used for range selection via Shift + click

• dojox.grid.cells.MultipleRowSelector.toggleAllTrigerred

  • type

    Boolean

  • summary

    Whether toggle all has been triggered or not

• dojox.grid.cells.MultipleRowSelector.unCheckedText

  • type

    String

• dojox.grid.cells.MultipleRowSelector.constructor

  • constructor - constructor
  • type

    Function

• dojox.grid.cells.MultipleRowSelector.toggleAllSelection

  • parameters:
    • checked: (typeof Boolean)

      True - select all, False - deselect all

  • summary

    Toggle select all|deselect all

  • type

    Function

• dojox.grid.cells.MultipleRowSelector.grid

• dojox.grid.cells.MultipleRowSelector.grid.selection

• dojox.grid.cells.MultipleRowSelector._onMouseDown

  • parameters:
    • e
  • type

    Function

• dojox.grid.cells.MultipleRowSelector._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(outside of this column).
    - from dojox.grid.enhanced._Events.onRowMouseOver()

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._domouseup

  • parameters:
    • e: (typeof Event)

      Mouse up event

  • summary

    Event handler for mouse up event - from dojo.doc.domouseup()

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._dokeyup

  • parameters:
    • e: (typeof Event)

      Key up event

  • summary

    Event handler for key up event
    - from dojox.grid.enhanced._Events.dokeyup()

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._startSelection

  • parameters:
    • rowIndex: (typeof Integer)

      Index of the start row

  • summary

    Initialize parameters to start a new swipe selection

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._updateSelection

  • parameters:
    • e: (typeof Event)

      Event of the current row,

    • delta: (typeof Integer)

      Row index delta, used for swipe selection via Shift + Arrow key
      0: not via key, -1 : Shift +  Up, 1 : Shift + Down

  • summary

    Update row selections, fired during a swipe selection

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._swipeByKey

  • parameters:
    • rowOffset: (typeof Integer)

      Row offset, used for swipe selection via Shift + Cursor
      -1 : Shift +  Up, 1 : Shift + Down

    • colOffset
    • e: (typeof Event)

      Event of the current row,

  • summary

    Update row selections, fired when Shift + Cursor is used for swipe selection
    See dojox.grid.enhanced._Events.onKeyDown

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._finishSelect

  • summary

    Reset parameters to end a swipe selection

  • type

    Function

• dojox.grid.cells.MultipleRowSelector.inSwipeSelection

  • summary

    Check if during a swipe selection
    return: Boolean
    Whether in swipe selection

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._nativeSelect

  • parameters:
    • index
    • value
  • summary

    Overwritten

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._selectRow

  • parameters:
    • e: (typeof Event)

      Event fired on the target row

  • summary

    Select the target row or range or rows

  • type

    Function

• dojox.grid.cells.MultipleRowSelector.getValue

  • parameters:
    • rowIndex
  • summary

    Overwritten

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._addHeaderSelector

  • summary

    Add selector in column header for selecting|deselecting all

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._headerSelectorConnectIdx

• dojox.grid.cells.MultipleRowSelector._toggletHeader

  • summary

    Toggle state for head selector

  • type

    Function

• dojox.grid.cells.MultipleRowSelector.grid._selectingRange

  • type

    bool

• dojox.grid.cells.MultipleRowSelector._onSelectionChanged

  • summary

    Update header selector anytime selection changed

  • type

    Function

• dojox.grid.cells.MultipleRowSelector._toggleDisabledStyle

  • parameters:
    • index
    • disabled
  • summary

    Overwritten

  • type

    Function

• dojox.grid.enhanced.plugins

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object