dojox/grid/EnhancedGrid.js

• Provides:

  • dojox.grid.enhanced.DataSelection

• Requires:

  • dojox.grid.DataGrid in common
  • dojox.grid.enhanced._PluginManager in common
  • dojox.grid.enhanced.plugins._SelectionPreserver in common

• dojox.grid.EnhancedGrid

  • type

    Function

  • chains:
    • dojox.grid.DataGrid: (prototype)
    • dojox.grid.DataGrid: (call)
  • summary

    Provides enhanced features based on DataGrid

  • description

    EnhancedGrid features are implemented as plugins that could be loaded on demand.
    Explicit dojo.require() is needed to use these feature plugins.

  • example

    A quick sample to use EnhancedGrid features:
    
    Step 1. Load EnhancedGrid and required features
       <script type="text/javascript">
    		dojo.require("dojox.grid.EnhancedGrid");
    		dojo.require("dojox.grid.enhanced.plugins.DnD");
    		dojo.require("dojox.grid.enhanced.plugins.Menu");
    		dojo.require("dojox.grid.enhanced.plugins.NestedSorting");
    		dojo.require("dojox.grid.enhanced.plugins.IndirectSelection");
    	</script>
    
    Step 2. Use EnhancedGrid
    - Via HTML markup
    	<div dojoType="dojox.grid.EnhancedGrid" ...
    		plugins="{nestedSorting: true, dnd: true, indirectSelection: true,
    		menus:{headerMenu:"headerMenuId", rowMenu:"rowMenuId", cellMenu:"cellMenuId",
    		selectedRegionMenu:"selectedRegionMenuId"}}">
    			...
    	</div>
    
    - Or via JavaScript
    	<script type="text/javascript">
    		var grid = new dojox.grid.EnhancedGrid({plugins : {nestedSorting: true, dnd: true, indirectSelection: true,
    	               menus:{headerMenu:"headerMenuId", rowMenu:"rowMenuId", cellMenu:"cellMenuId",selectedRegionMenu:"selectedRegionMenuId"}},
    			       ... }, dojo.byId('gridDiv'));
    		grid.startup();
    	</script>
    
    
    Plugin Support
    [Note: Plugin support is still experimental]
    
    You can either customize the default plugins or add new ones, more details please see
    - dojox.grid.enhanced._PluginManager
    - dojox.grid.enhanced._Plugin
    - dojox.grid.enhanced.plugins.*

• dojox.grid.EnhancedGrid.plugins

  • type

    Object

  • summary

    Plugin properties, e.g. {nestedSorting: true, dnd: true, ...}

• dojox.grid.EnhancedGrid.pluginMgr

  • type

    Object

  • summary

    Singleton plugin manager

• dojox.grid.EnhancedGrid.keepSelection

  • type

    Boolean

  • summary

    Whether keep selection after sort, filter, pagination etc.

• dojox.grid.EnhancedGrid._pluginMgrClass

  • alias - dojox.grid.enhanced._PluginManager
  • type

    Object

  • summary

    Default plugin manager class

• dojox.grid.EnhancedGrid.postMixInProperties

  • type

    Function

• dojox.grid.EnhancedGrid._nls

  • type

    Object

• dojox.grid.EnhancedGrid.postCreate

  • type

    Function

• dojox.grid.EnhancedGrid.plugin

  • parameters:
    • name: (typeof String)
  • summary

    An easier way for getting a plugin, e.g. grid.plugin('dnd')

  • type

    Function

• dojox.grid.EnhancedGrid.startup

  • type

    Function

• dojox.grid.EnhancedGrid.createSelection

  • type

    Function

• dojox.grid.EnhancedGrid.selection

  • type

    Object

• dojox.grid.EnhancedGrid.canSort

  • parameters:
    • colIndex
    • field
  • summary

    Overwritten

  • type

    Function

• dojox.grid.EnhancedGrid.doKeyEvent

  • parameters:
    • e
  • summary

    Overwritten, see _Grid.doKeyEvent()

  • type

    Function

• dojox.grid.EnhancedGrid.focus.focusView

• dojox.grid.EnhancedGrid.doApplyCellEdit

  • parameters:
    • inValue
    • inRowIndex
    • inAttrName
  • summary

    Overwritten, see DataGrid.doApplyCellEdit()

  • type

    Function

• dojox.grid.EnhancedGrid.mixin

  • parameters:
    • target
    • source
  • type

    Function

• dojox.grid.EnhancedGrid._copyAttr

  • parameters:
    • idx
    • attr
  • summary

    Overwritten, see DataGrid._copyAttr()
    Fix cell TAB navigation for single click editing

  • type

    Function

• dojox.grid.EnhancedGrid._getHeaderHeight

  • summary

    Overwritten, see _Grid._getHeaderHeight()
    Should include borders/margins of this.viewsHeaderNode

  • type

    Function

• dojox.grid.EnhancedGrid._fetch

  • parameters:
    • start
    • isRender
  • summary

    Overwritten, see DataGrid._fetch()

  • type

    Function

• dojox.grid.EnhancedGrid._isLoading

  • type

    Object

• dojox.grid.EnhancedGrid._storeLayerFetch

  • parameters:
    • req
  • summary

    Extracted fetch specifically for store layer use

  • type

    Function

• dojox.grid.EnhancedGrid.getCellByField

  • parameters:
    • field
  • type

    Function

• dojox.grid.EnhancedGrid.onMouseUp

  • parameters:
    • e
  • type

    Function

• dojox.grid.EnhancedGrid.createView

  • type

    Function

• dojox.grid.EnhancedGrid.destroy

  • summary

    Destroy all resources

  • type

    Function

• dojox.grid.enhanced.DataSelection

  • type

    Function

  • chains:
    • dojox.grid.DataSelection: (prototype)
    • dojox.grid.DataSelection: (call)
  • parameters:
    • grid

• dojox.grid.enhanced.DataSelection.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • grid

• dojox.grid.enhanced.DataSelection._range

  • parameters:
    • inFrom
    • inTo
  • type

    Function

• dojox.grid.enhanced.DataSelection.grid._selectingRange

  • type

    bool

• dojox.grid.enhanced.DataSelection.deselectAll

  • parameters:
    • inItemOrIndex
  • type

    Function

• dojox.grid.enhanced.DataSelection.destroy

  • type

    Function

• dojox.grid.enhanced.DataSelection.preserver

  • type

    Object

• dojox.grid.EnhancedGrid.markupFactory

  • parameters:
    • props
    • node
    • ctor
    • cellFunc
  • type

    Function

• dojox.grid.EnhancedGrid.registerPlugin

  • parameters:
    • clazz
    • props
  • type

    Function

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object