dojox/grid/enhanced/plugins/DnD.js

• Provides:

  • dojox.grid.enhanced.plugins.DnD

• Requires:

  • dojox.grid.enhanced._Plugin in common
  • dojox.grid.enhanced.plugins.Selector in common
  • dojox.grid.enhanced.plugins.Rearrange in common
  • dojo.dnd.move in common
  • dojo.dnd.Source in common

• dojox.grid.enhanced.plugins.DnD

  • type

    Function

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

    Provide drag and drop for grid columns/rows/cells within grid and out of grid.
    The store of grid must implement dojo.data.api.Write.
    DnD selected columns:
    Support moving within grid, moving/copying out of grid to a non-grid DnD target.
    DnD selected rows:
    Support moving within grid, moving/copying out of grid to any DnD target.
    DnD selected cells (in rectangle shape only):
    Support moving/copying within grid, moving/copying out of grid to any DnD target.

• dojox.grid.enhanced.plugins.DnD.name

  • type

    String,

  • summary

    plugin name;

• dojox.grid.enhanced.plugins.DnD._targetAnchorBorderWidth

  • type

    Number

• dojox.grid.enhanced.plugins.DnD._copyOnly

  • type

    bool

• dojox.grid.enhanced.plugins.DnD._config

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.row

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.row.within

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.row.in

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.row.out

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.col

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.col.within

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.col.in

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.col.out

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.cell

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.cell.within

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.cell.in

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._config.cell.out

  • type

    Object

• dojox.grid.enhanced.plugins.DnD.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • grid
    • args

• dojox.grid.enhanced.plugins.DnD.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._container

  • type

    Object

• dojox.grid.enhanced.plugins.DnD.grid

  • type

    Object

• dojox.grid.enhanced.plugins.DnD.selector

  • type

    Object

• dojox.grid.enhanced.plugins.DnD.rearranger

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._mixinGrid

  • summary

    Provide APIs for grid.

  • type

    Function

• dojox.grid.enhanced.plugins.DnD.grid.setupDnDConfig

  • type

    Object

• dojox.grid.enhanced.plugins.DnD.grid.dndCopyOnly

  • type

    Object

• dojox.grid.enhanced.plugins.DnD.setupConfig

  • parameters:
    • config: (typeof Object)

      DnD configuration object.
      See the examples below.

  • summary

    Configure which DnD functionalities are needed.
    Combination of any item from type set ("row", "col", "cell")
    and any item from mode set("within", "in", "out") is configurable.
    
    "row", "col", "cell" are straitforward, while the other 3 are explained below:
    "within": DnD within grid, that is, column/row reordering and cell moving/copying.
    "in": Whether allowed to accept rows/cells (currently not support columns) from another grid.
    "out": Whether allowed to drag out of grid, to another grid or even to any other DnD target.
    
    If not provided in the config, will use the default.
    When declared together, Mode set has higher priority than type set.

  • example

    The following code disables row DnD within grid,
    but still can drag rows out of grid or drag rows from other gird.
    	setUpConfig({
    		"row": {
    			"within": false
    		}
    	});
    
    The opposite way is also okay:
    	setUpConfig({
    		"within": {
    			"row": false
    		}
    	});
    
    And if you'd like to disable/enable a whole set, here's a shortcut:
    	setUpConfig({
    		"cell", true,
    		"out": false
    	});
    
    Because mode has higher priority than type, the following will disable row dnd within grid:
    	setUpConfig({
    		"within", {
    			"row": false;
    		},
    		"row", {
    			"within": true
    		}
    	});

  • type

    Function

• dojox.grid.enhanced.plugins.DnD.copyOnly

  • parameters:
    • isCopyOnly
  • summary

    Setter/getter of this._copyOnly.

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._isOutOfGrid

  • parameters:
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._onMouseMove

  • parameters:
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._dnding

  • type

    bool

• dojox.grid.enhanced.plugins.DnD._oldCursor

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._alreadyOut

  • type

    bool

• dojox.grid.enhanced.plugins.DnD._moveEvent

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._onMouseUp

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._initEvents

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._clear

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._dndRegion

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._target

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._targetAnchor

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._externalDnd

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._isSource

  • type

    bool

• dojox.grid.enhanced.plugins.DnD._extDnding

  • type

    bool

• dojox.grid.enhanced.plugins.DnD._getDnDRegion

  • parameters:
    • rowIndex
    • colIndex
  • type

    Function

• dojox.grid.enhanced.plugins.DnD.selector._selected

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

• dojox.grid.enhanced.plugins.DnD._startDnd

  • parameters:
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._endDnd

  • parameters:
    • destroySource
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._createDnDUI

  • parameters:
    • evt
    • isMovingIn
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._destroyDnDUI

  • parameters:
    • isMovingOut
    • destroySource
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._createSource

  • parameters:
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._destroySource

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._createMoveable

  • parameters:
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._markTagetAnchorHandler

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._destroyMoveable

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._calcColTargetAnchorPos

  • parameters:
    • evt
    • containerPos
  • summary

    Calculate the position of the column DnD avatar

  • type

    Function

• dojox.grid.enhanced.plugins.DnD.grid.layout.cells.length

• dojox.grid.enhanced.plugins.DnD._dndRegion.selected

• dojox.grid.enhanced.plugins.DnD._calcRowTargetAnchorPos

  • parameters:
    • evt
    • containerPos
  • summary

    Calculate the position of the row DnD avatar

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._calcCellTargetAnchorPos

  • parameters:
    • evt
    • containerPos
    • targetAnchor
  • summary

    Calculate the position of the cell DnD avatar

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._dndRegion.selected.0

• dojox.grid.enhanced.plugins.DnD._dndRegion.handle

• dojox.grid.enhanced.plugins.DnD.grid.scroller.firstVisibleRow

• dojox.grid.enhanced.plugins.DnD._markTargetAnchor

  • parameters:
    • evt
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._dndRegion.type

• dojox.grid.enhanced.plugins.DnD._unmarkTargetAnchor

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._getVisibleHeaders

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._rearrange

  • type

    Function

• dojox.grid.enhanced.plugins.DnD.onDraggingOver

  • parameters:
    • sourcePlugin
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._mapRegion

  • parameters:
    • srcGrid
    • dndRegion
  • type

    Function

• dojox.grid.enhanced.plugins.DnD.onDraggingOut

  • parameters:
    • sourcePlugin
  • type

    Function

• dojox.grid.enhanced.plugins.DnD.onDragIn

  • parameters:
    • sourcePlugin
    • isCopy
  • type

    Function

• dojox.grid.enhanced.plugins.DnD.onDragOut

  • parameters:
    • isMove
  • type

    Function

• dojox.grid.enhanced.plugins.DnD._canAccept

  • parameters:
    • sourcePlugin
  • type

    Function

• dojox.grid.enhanced.plugins.DnD.grid.rowCount

• dojox.grid.enhanced.plugins.DnD._allDnDItemsLoaded

  • type

    Function

• dojox.grid.enhanced.plugins.DnD._dndRegion.selected.0.min.row

• dojox.grid.enhanced.plugins.DnD._dndRegion.selected.0.max.row

• dojox.grid.enhanced.plugins.DnD.grid._by_idx

• dojox.grid.enhanced.plugins.DnD._elem

  • type

    Object

• dojox.grid.enhanced.plugins.DnD._source

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDElement

  • type

    Function

  • parameters:
    • dndPlugin

• dojox.grid.enhanced.plugins.GridDnDElement.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • dndPlugin

• dojox.grid.enhanced.plugins.GridDnDElement.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDElement.plugin

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDElement.node

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDElement._items

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDElement.createDnDNodes

  • parameters:
    • dndRegion
  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDElement.getDnDNodes

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDElement.destroyDnDNodes

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDElement.getItem

  • parameters:
    • nodeId
  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDSource

  • type

    Function

  • chains:
    • dojo.dnd.Source: (prototype)
    • dojo.dnd.Source: (call)
  • parameters:
    • node
    • param

• dojox.grid.enhanced.plugins.GridDnDSource.accept

  • type

    Array

• dojox.grid.enhanced.plugins.GridDnDSource.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node
    • param

• dojox.grid.enhanced.plugins.GridDnDSource.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDSource.grid

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDSource.dndElem

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDSource.dndPlugin

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDSource.sourcePlugin

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDSource.getItem

  • parameters:
    • nodeId
  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDSource.checkAcceptance

  • parameters:
    • source
    • nodes
  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDSource.onDraggingOver

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDSource.onDraggingOut

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDSource.onDndDrop

  • parameters:
    • source
    • nodes
    • copy
    • target
  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDAvatar

  • type

    Function

  • chains:
    • dojo.dnd.Avatar: (prototype)
    • dojo.dnd.Avatar: (call)

• dojox.grid.enhanced.plugins.GridDnDAvatar.construct

  • summary

    constructor function;
    it is separate so it can be (dynamically) overwritten in case of need

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDAvatar._itemType

• dojox.grid.enhanced.plugins.GridDnDAvatar._itemCount

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDAvatar.isA11y

  • type

    Object

• dojox.grid.enhanced.plugins.GridDnDAvatar.manager.source

• dojox.grid.enhanced.plugins.GridDnDAvatar.node

• dojox.grid.enhanced.plugins.GridDnDAvatar._getItemCount

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDAvatar.manager._dndPlugin.grid.layout.cells

• dojox.grid.enhanced.plugins.GridDnDAvatar._getGridDnDIconClass

  • type

    Function

• dojox.grid.enhanced.plugins.GridDnDAvatar._generateText

  • summary

    generates a proper text to reflect copying or moving of items

  • type

    Function

• dojox.grid.enhanced.plugins

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object