dojox/grid/enhanced/plugins/_SelectionPreserver.js

• Provides:

  • dojox.grid.enhanced.plugins._SelectionPreserver

• dojox.grid.enhanced.plugins._SelectionPreserver

  • type

    Function

  • parameters:
    • selection
  • summary

    Preserve selections across various user actions.

  • description

    When this feature turned on, Grid will try to preserve selections across various user actions, e.g. sorting, filtering etc.
    Precondition - Identifier(id) is required for store, as id is used for differentiating row items.
    Known issue - The preserved selections might be inaccurate if some unloaded rows are selected by range previously(e.g.SHIFT + click)

  • example

    	//To turn on this - set 'keepSelection' attribute to true
    	<div dojoType="dojox.grid.EnhancedGrid" keepSelection = true .../>

• dojox.grid.enhanced.plugins._SelectionPreserver._connects

  • type

    Array

  • summary

    List of all connections.

• dojox.grid.enhanced.plugins._SelectionPreserver.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • selection

• dojox.grid.enhanced.plugins._SelectionPreserver.destroy

  • type

    Function

• dojox.grid.enhanced.plugins._SelectionPreserver.connect

  • parameters:
    • obj
    • event
    • method
  • summary

    Connects specified obj/event to specified method of this object.

  • type

    Function

• dojox.grid.enhanced.plugins._SelectionPreserver.reset

  • type

    Function

• dojox.grid.enhanced.plugins._SelectionPreserver._idMap

  • type

    Array

• dojox.grid.enhanced.plugins._SelectionPreserver._selectedById

  • type

    Object

• dojox.grid.enhanced.plugins._SelectionPreserver._trustSelection

  • type

    Array

• dojox.grid.enhanced.plugins._SelectionPreserver._defaultSelected

  • type

    bool

• dojox.grid.enhanced.plugins._SelectionPreserver._reSelectById

  • parameters:
    • item
    • index
  • summary

    When some rows is fetched, determine whether it should be selected.
    When this function is called, grid.selection.selected[] is not trustable.

  • type

    Function

• dojox.grid.enhanced.plugins._SelectionPreserver.selection

• dojox.grid.enhanced.plugins._SelectionPreserver.grid

• dojox.grid.enhanced.plugins._SelectionPreserver._selectById

  • parameters:
    • toSelect
    • inItemOrIndex
  • summary

    Record selected rows by ID.

  • type

    Function

• dojox.grid.enhanced.plugins._SelectionPreserver.onSelectedById

  • parameters:
    • id
    • rowIndex
    • value
  • type

    Function

• dojox.grid.enhanced.plugins._SelectionPreserver._updateMapping

  • parameters:
    • trustSelection
    • isSelect
    • isForAll
    • from
    • to
  • summary

    This function trys to keep the selection info updated when range selection is performed.
    1. Calculate how many unloaded rows are there;
    2. update _selectedById data if grid.selection._selected can be trusted, so loaded but unselected rows can
    be properly recorded.

  • type

    Function

• dojox.grid.enhanced.plugins._SelectionPreserver._idMap.length

  • type

    Number

• dojox.grid.enhanced.plugins

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object