dojox/grid/enhanced/plugins/NestedSorting.js

• Provides:

  • dojox.grid.enhanced.plugins.NestedSorting

• Requires:

  • dojox.grid.enhanced._Plugin in common

• dojox.grid.enhanced.plugins.NestedSorting

  • type

    Function

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

    Provides nested sorting feature

  • description

    A flexible way to control multiple column sorting, including
    1. Set default sorting order
    2. Disable sorting for certain columns
    3. Set sorting order dynamically with JS API

  • example

    	<script type="text/javascript">
    		var grid = new dojox.grid.EnhancedGrid({plugins : {nestedSorting: true}},
    	               sortFields: [{attribute: 'col4', descending: false},...],//set default sorting order
    			       canSort: function(index, field){ return true},//disable sorting for a column
    				   ... }, dojo.byId('gridDiv'));
    		grid.startup();
    		//set new sorting order
    		grid.setSortIndex([{attribute: 'col3', descending: true},...])
    	</script>

• dojox.grid.enhanced.plugins.NestedSorting.name

  • type

    String

  • summary

    Plugin name
    
    
    'none'|'asc'|'desc'

• dojox.grid.enhanced.plugins.NestedSorting._currMainSort

  • type

    String

• dojox.grid.enhanced.plugins.NestedSorting._currRegionIdx

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting._a11yText

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting._a11yText.dojoxGridDescending

  • type

    String

• dojox.grid.enhanced.plugins.NestedSorting._a11yText.dojoxGridAscending

  • type

    String

• dojox.grid.enhanced.plugins.NestedSorting._a11yText.dojoxGridAscendingTip

  • type

    String

• dojox.grid.enhanced.plugins.NestedSorting._a11yText.dojoxGridDescendingTip

  • type

    String

• dojox.grid.enhanced.plugins.NestedSorting._a11yText.dojoxGridUnsortedTip

  • type

    String

• dojox.grid.enhanced.plugins.NestedSorting.constructor

  • constructor - constructor
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.onStartUp

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._onColumnDnD

  • parameters:
    • type
    • mapping
  • summary

    Update nested sorting after column moved

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._sortData

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting._setGridSortIndex

  • parameters:
    • inIndex
    • inAsc
    • noRefresh
  • returns

    header click from base DataGrid

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.getSortProps

  • summary

    Overwritten, see DataGrid.getSortProps()

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._initSort

  • parameters:
    • postSort
  • summary

    Initiate sorting

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.grid

• dojox.grid.enhanced.plugins.NestedSorting.grid.domNode

• dojox.grid.enhanced.plugins.NestedSorting._sortDef.length

  • type

    Number

• dojox.grid.enhanced.plugins.NestedSorting._excludedCoIdx

  • type

    Array

• dojox.grid.enhanced.plugins.NestedSorting._headerNodes

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting._initHeaderNode

  • parameters:
    • node
  • summary

    Initiate sort for each header cell node

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._connects

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting._onHeaderCellClick

  • parameters:
    • e
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._onHeaderCellMouseOver

  • parameters:
    • e
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._onHeaderCellMouseOut

  • parameters:
    • e
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._onSortBtnClick

  • parameters:
    • e
  • summary

    If the click target is single sort button, do single sort.
    Else if the click target is nested sort button, do nest sort.
    Otherwise return.

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._doSort

  • parameters:
    • cellIdx
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.setSortData

  • parameters:
    • cellIdx
    • attr
    • value
  • summary

    Set sorting data for a column.

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.removeSortData

  • parameters:
    • cellIdx
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._prepareSingleSort

  • parameters:
    • cellIdx
  • summary

    Prepare the single sort, also called main sort, this will clear any existing sorting and just sort the grid by current column.

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._prepareNestedSort

  • parameters:
    • cellIdx
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._updateSortDef

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._updateHeaderNodeUI

  • parameters:
    • node
  • summary

    Update the column header UI based on current sorting state.
    Show indicator of the sorting order of the column, no order no indicator

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.isAsc

  • parameters:
    • cellIndex
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.isDesc

  • parameters:
    • cellIndex
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._getCellByNode

  • parameters:
    • node
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.clearSort

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.initCookieHandler

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._loadNestedSortingProps

  • parameters:
    • sortInfo
    • grid
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._saveNestedSortingProps

  • parameters:
    • grid
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._initFocus

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.focus

• dojox.grid.enhanced.plugins.NestedSorting._focusRegions

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting._headerArea

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting._focusHeader

  • parameters:
    • evt
  • summary

    Overwritten, see _FocusManager.focusHeader()
    delayed: Boolean
    If called from "this.focus._delayedHeaderFocus()"

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._blurHeader

  • parameters:
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._onMove

  • parameters:
    • rowStep
    • colStep
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._onKeyDown

  • parameters:
    • e
    • isBubble
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._getRegionView

  • parameters:
    • region
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._getRegions

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.grid.layout.cells

• dojox.grid.enhanced.plugins.NestedSorting._focusRegion

  • parameters:
    • region
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._blurRegion

  • parameters:
    • region
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._getCurrentRegion

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._getRegionHeader

  • parameters:
    • region
  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting._sortDef

  • type

    Array

• dojox.grid.enhanced.plugins.NestedSorting._excludedColIdx

  • type

    Array

• dojox.grid.enhanced.plugins.NestedSorting.nls

• dojox.grid.enhanced.plugins.NestedSorting.grid.setSortInfo

  • type

    Function

• dojox.grid.enhanced.plugins.NestedSorting.grid.setSortIndex

  • type

    Object

• dojox.grid.enhanced.plugins.NestedSorting.grid.getSortProps

  • type

    Object

• dojox.grid.enhanced.plugins

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object