dojox/grid/enhanced/_PluginManager.js

• Provides:

  • dojox.grid.enhanced._PluginManager

• Requires:

  • dojox.grid.enhanced._Events in common
  • dojox.grid.enhanced._FocusManager in common

• dojox.grid.enhanced._PluginManager

  • type

    Function

  • parameters:
    • inGrid
  • summary

    Singleton plugin manager

  • description

    Plugin manager is responsible for
    1. Loading required plugins
    2. Handling collaboration and dependencies among plugins
    
    Some plugin dependencies:
    - "columnReordering" attribute won't work when either DnD or Indirect Selections plugin is on.

• dojox.grid.enhanced._PluginManager._options

  • type

    Object

  • summary

    Normalized plugin options

• dojox.grid.enhanced._PluginManager._plugins

  • type

    Array

  • summary

    Plugin list

• dojox.grid.enhanced._PluginManager._connects

  • type

    Array

  • summary

    Connection list

• dojox.grid.enhanced._PluginManager.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • inGrid

• dojox.grid.enhanced._PluginManager.startup

  • type

    Function

• dojox.grid.enhanced._PluginManager.preInit

  • summary

    Load appropriate plugins before DataGrid.postCreate().
    See EnhancedGrid.postCreate()

  • type

    Function

• dojox.grid.enhanced._PluginManager.grid.focus

  • type

    Object

• dojox.grid.enhanced._PluginManager.postInit

  • summary

    Load plugins after DataGrid.postCreate() - the default phase when plugins are created
    See EnhancedGrid.postCreate()

  • type

    Function

• dojox.grid.enhanced._PluginManager.grid.edit

• dojox.grid.enhanced._PluginManager.grid.edit.styleRow

  • parameters:
    • inRow
  • type

    Function

• dojox.grid.enhanced._PluginManager.forEach

  • parameters:
    • func
    • args
  • type

    Function

• dojox.grid.enhanced._PluginManager._parseProps

  • parameters:
    • plugins: (typeof Object)

      Plugin properties defined by user

  • summary

    Parse plugins properties

  • type

    Function

• dojox.grid.enhanced._PluginManager.grid

• dojox.grid.enhanced._PluginManager._options.columnReordering

  • type

    bool

• dojox.grid.enhanced._PluginManager._normalize

  • parameters:
    • p: (typeof String)

      Plugin name

    • plugins: (typeof Object)

      Plugin properties set by user

    • registry: (typeof Object)

      The global plugin registry

    • loading: (typeof Object)

      Map for checking process state

  • summary

    Normalize plugin properties especially the dependency chain

  • type

    Function

• dojox.grid.enhanced._PluginManager._init

  • parameters:
    • pre: (typeof Boolean)

      True - preInit | False - postInit(by default)

  • summary

    Find appropriate plugins and load them

  • type

    Function

• dojox.grid.enhanced._PluginManager.loadPlugin

  • parameters:
    • name: (typeof String)

      Plugin name
      return: Object
      The newly loaded plugin

  • returns

    return if no plugin option|return if plugin("name") already existed

  • summary

    Load required plugin("name")

  • type

    Function

• dojox.grid.enhanced._PluginManager._initView

  • parameters:
    • view
  • summary

    Overwrite several default behavior for each views(including _RowSelector view)

  • type

    Function

• dojox.grid.enhanced._PluginManager.pluginExisted

  • parameters:
    • name: (typeof String)

      Plugin name
      return: Boolean
      True - existed | False - not existed

  • summary

    Check if plugin("name") existed

  • type

    Function

• dojox.grid.enhanced._PluginManager.getPlugin

  • parameters:
    • name: (typeof String)

      Plugin name
      return: Object
      Plugin instance

  • summary

    Get plugin("name")

  • type

    Function

• dojox.grid.enhanced._PluginManager._plugins.length

• dojox.grid.enhanced._PluginManager.getPluginClazz

  • parameters:
    • clazz: (typeof class)

      | String
      Plugin class

  • returns

    return if it's already a clazz

  • summary

    Load target plugin which must be already required (dojo.require(..))

  • type

    Function

• dojox.grid.enhanced._PluginManager.isFixedCell

  • parameters:
    • cell: (typeof Object)

      Target cell(column)
      return: Boolean
      True - fixed| False - not fixed

  • summary

    See if target cell(column) is fixed or not.

  • type

    Function

• dojox.grid.enhanced._PluginManager.destroy

  • summary

    Destroy all resources

  • type

    Function

• dojox.grid.enhanced._PluginManager._store

• dojox.grid.enhanced._PluginManager.registerPlugin

  • parameters:
    • clazz: (typeof String)

      Full class name, e.g. "dojox.grid.enhanced.plugins.DnD"

    • props: (typeof Object)

      - Optional
      Plugin properties e.g. {"dependency": ["nestedSorting"], ...}

  • summary

    Register plugins - TODO, a better way rather than global registry?

  • type

    Function

• dojox.grid.enhanced._PluginManager.registry

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object