This plugin provides drag and/or drop functionality for a GridView.
\n\n\nIt creates a specialized instance of DragZone which knows how to drag out of a GridView\nand loads the data object which is passed to a cooperating DragZone's methods with the following properties:
copy property, or true if the GridView was configured\n with allowCopy: true and the control key was pressed when the drag operation was begun.It also creates a specialized instance of Ext.dd.DropZone which cooperates with other DropZones which are members of the same\nddGroup which processes such data objects.
\n\n\nAdding this plugin to a view means that two new events may be fired from the client GridView, beforedrop and\ndrop
A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone\nused by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/plugin/DragDrop.js", - "linenr": 90, - "html_filename": "DragDrop2.html", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-ddGroup", - "shortDoc": "A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone\n..." - }, - { - "tagname": "cfg", - "name": "dragGroup", - "member": "Ext.grid.plugin.DragDrop", - "type": "String", - "doc": "The ddGroup to which the DragZone will belong.
\n\n\nThis defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/plugin/DragDrop.js", - "linenr": 97, - "html_filename": "DragDrop2.html", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dragGroup", - "shortDoc": "The ddGroup to which the DragZone will belong.\n\n\nThis defines which other DropZones the DragZone will interact with. ..." - }, - { - "tagname": "cfg", - "name": "dropGroup", - "member": "Ext.grid.plugin.DragDrop", - "type": "String", - "doc": "The ddGroup to which the DropZone will belong.
\n\n\nThis defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/plugin/DragDrop.js", - "linenr": 104, - "html_filename": "DragDrop2.html", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dropGroup", - "shortDoc": "The ddGroup to which the DropZone will belong.\n\n\nThis defines which other DragZones the DropZone will interact with. ..." - }, - { - "tagname": "cfg", - "name": "enableDrag", - "member": "Ext.grid.plugin.DragDrop", - "type": "Boolean", - "doc": "Defaults to true
Set to false to disallow dragging items from the View
Defaults to true
Set to false to disallow the View from accepting drop gestures
The destroy method is invoked by the owning Component at the time the Component is being destroyed.\nUse this method to clean up an resources.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" + "members": { + "cfg": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-ddGroup", + "shortDoc": "A named drag drop group to which this object belongs. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", + "private": false, + "name": "ddGroup", + "owner": "Ext.grid.plugin.DragDrop", + "doc": "A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone\nused by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
\n", + "linenr": 90, + "html_filename": "DragDrop2.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js", - "linenr": 30, - "html_filename": "AbstractPlugin.html", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-destroy", - "shortDoc": "The destroy method is invoked by the owning Component at the time the Component is being destroyed.\nUse this method t..." - }, - { - "tagname": "method", - "name": "disable", - "member": "Ext.AbstractPlugin", - "doc": "Disable the plugin and set the disabled flag to true.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dragGroup", + "shortDoc": "The ddGroup to which the DragZone will belong. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", + "private": false, + "name": "dragGroup", + "owner": "Ext.grid.plugin.DragDrop", + "doc": "The ddGroup to which the DragZone will belong.
\n\n\nThis defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.
\n\n", + "linenr": 97, + "html_filename": "DragDrop2.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js", - "linenr": 44, - "html_filename": "AbstractPlugin.html", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-disable", - "shortDoc": "Disable the plugin and set the disabled flag to true.
\n" - }, - { - "tagname": "method", - "name": "enable", - "member": "Ext.AbstractPlugin", - "doc": "Enable the plugin and set the disabled flag to false.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dropGroup", + "shortDoc": "The ddGroup to which the DropZone will belong. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", + "private": false, + "name": "dropGroup", + "owner": "Ext.grid.plugin.DragDrop", + "doc": "The ddGroup to which the DropZone will belong.
\n\n\nThis defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.
\n\n", + "linenr": 104, + "html_filename": "DragDrop2.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractPlugin.js", - "linenr": 37, - "html_filename": "AbstractPlugin.html", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-enable", - "shortDoc": "Enable the plugin and set the disabled flag to false.
\n" - }, - { - "tagname": "method", - "name": "init", - "member": "Ext.AbstractPlugin", - "doc": "The init method is invoked after initComponent has been run for the\ncomponent which we are injecting the plugin into.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-enableDrag", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", + "private": false, + "name": "enableDrag", + "owner": "Ext.grid.plugin.DragDrop", + "doc": "Defaults to true
Set to false to disallow dragging items from the View
The init method is invoked after initComponent has been run for the\ncomponent which we are injecting the plugin into.
\n" - } - ], - "property": [ + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-enableDrop", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", + "private": false, + "name": "enableDrop", + "owner": "Ext.grid.plugin.DragDrop", + "doc": "Defaults to true
Set to false to disallow the View from accepting drop gestures
This event is fired through the GridView. Add listeners to the GridView object
\n\n\nFired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.\n\n", - "params": [ - { - "type": "HtmlElement", - "name": "node", - "doc": "
The GridView node if any over which the mouse was positioned.
\n\nReturning false to this event signals that the drop gesture was invalid, and if the drag proxy\nwill animate back to the point from which the drag began.
Returning 0 To this event signals that the data transfer operation should not take place, but\nthat the gesture was valid, and that the repair operation should not take place.
Any other return value continues with the data transfer operation.
\n\n", - "optional": false - }, - { - "type": "Object", - "name": "data", - "doc": "The data object gathered at mousedown time by the cooperating DragZone's\ngetDragData method it contains the following properties:
copy property, or true if the GridView was configured\n with allowCopy: true and the control key was pressed when the drag operation was begunThe Model over which the drop gesture took place.
\n", - "optional": false - }, - { - "type": "String", - "name": "dropPosition", - "doc": "\"before\" or \"after\" depending on whether the mouse is above or below the midline of the node.
The destroy method is invoked by the owning Component at the time the Component is being destroyed.
\n\n\nThe supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.
\n\n", + "linenr": 42, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "dropFunction", - "doc": "A function to call to complete the data transfer operation and either move or copy Model instances from the source\nView's Store to the destination View's Store.
\n\n\nThis is useful when you want to perform some kind of asynchronous processing before confirming\nthe drop, such as an confirm call, or an Ajax request.
\n\n\nReturn 0 from this event handler, and call the dropFunction at any time to perform the data transfer.
This event is fired through the GridView. Add listeners to the GridView object\nFired when a drop operation has been completed and the data has been moved or copied.
\n", - "params": [ - { - "type": "HtmlElement", - "name": "node", - "doc": "The GridView node if any over which the mouse was positioned.
\n", - "optional": false + "html_filename": "AbstractPlugin.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-disable", + "shortDoc": "The base implementation just sets the plugin's disabled flag to true\n\n\nPlugin subclasses which need more complex proc...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", + "private": false, + "params": [ + + ], + "name": "disable", + "owner": "Ext.AbstractPlugin", + "doc": "The base implementation just sets the plugin's disabled flag to true
Plugin subclasses which need more complex processing may implement an overriding implementation.
\n\n", + "linenr": 57, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "data", - "doc": "The data object gathered at mousedown time by the cooperating DragZone's\ngetDragData method it contains the following properties:
copy property, or true if the GridView was configured\n with allowCopy: true and the control key was pressed when the drag operation was begunThe base implementation just sets the plugin's disabled flag to false
Plugin subclasses which need more complex processing may implement an overriding implementation.
\n\n", + "linenr": 49, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Ext.data.Model", - "name": "overModel", - "doc": "The Model over which the drop gesture took place.
\n", - "optional": false + "html_filename": "AbstractPlugin.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-init", + "shortDoc": "The init method is invoked after initComponent has been run for the client Component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", + "private": false, + "params": [ + { + "type": "Component", + "optional": false, + "doc": "The client Component which owns this plugin.
\n", + "name": "client" + } + ], + "name": "init", + "owner": "Ext.AbstractPlugin", + "doc": "The init method is invoked after initComponent has been run for the client Component.
\n\n\nThe supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional\nlinks between the plugin and its client Component in their own implementation of this method.
\n\n", + "linenr": 33, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "String", - "name": "dropPosition", - "doc": "\"before\" or \"after\" depending on whether the mouse is above or below the midline of the node.
The GridView node if any over which the mouse was positioned.
\n\nReturning false to this event signals that the drop gesture was invalid, and if the drag proxy\nwill animate back to the point from which the drag began.
Returning 0 To this event signals that the data transfer operation should not take place, but\nthat the gesture was valid, and that the repair operation should not take place.
Any other return value continues with the data transfer operation.
\n\n", + "name": "node" + }, + { + "type": "Object", + "optional": false, + "doc": "The data object gathered at mousedown time by the cooperating DragZone's\ngetDragData method it contains the following properties:
copy property, or true if the GridView was configured\n with allowCopy: true and the control key was pressed when the drag operation was begunThe Model over which the drop gesture took place.
\n", + "name": "overModel" + }, + { + "type": "String", + "optional": false, + "doc": "\"before\" or \"after\" depending on whether the mouse is above or below the midline of the node.
A function to call to complete the data transfer operation and either move or copy Model instances from the source\nView's Store to the destination View's Store.
\n\n\nThis is useful when you want to perform some kind of asynchronous processing before confirming\nthe drop, such as an confirm call, or an Ajax request.
\n\n\nReturn 0 from this event handler, and call the dropFunction at any time to perform the data transfer.
The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforedrop", + "owner": "Ext.grid.plugin.DragDrop", + "doc": "This event is fired through the GridView. Add listeners to the GridView object
\n\n\nFired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.\n\n", + "linenr": 32, + "html_filename": "DragDrop2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-event-drop", + "shortDoc": "This event is fired through the GridView. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", + "private": false, + "params": [ + { + "type": "HtmlElement", + "optional": false, + "doc": "
The GridView node if any over which the mouse was positioned.
\n", + "name": "node" + }, + { + "type": "Object", + "optional": false, + "doc": "The data object gathered at mousedown time by the cooperating DragZone's\ngetDragData method it contains the following properties:
copy property, or true if the GridView was configured\n with allowCopy: true and the control key was pressed when the drag operation was begunThe Model over which the drop gesture took place.
\n", + "name": "overModel" + }, + { + "type": "String", + "optional": false, + "doc": "\"before\" or \"after\" depending on whether the mouse is above or below the midline of the node.
The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "drop", + "owner": "Ext.grid.plugin.DragDrop", + "doc": "This event is fired through the GridView. Add listeners to the GridView object\nFired when a drop operation has been completed and the data has been moved or copied.
\n", + "linenr": 65, + "html_filename": "DragDrop2.html" + } + ] + }, + "singleton": false, + "alias": null, "superclasses": [ "Ext.AbstractPlugin" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "DragDrop2.html#Ext-grid-plugin-DragDrop", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.grid.plugin.DragDrop", + "doc": "This plugin provides drag and/or drop functionality for a GridView.
\n\n\nIt creates a specialized instance of DragZone which knows how to drag out of a GridView\nand loads the data object which is passed to a cooperating DragZone's methods with the following properties:
copy property, or true if the GridView was configured\n with allowCopy: true and the control key was pressed when the drag operation was begun.It also creates a specialized instance of Ext.dd.DropZone which cooperates with other DropZones which are members of the same\nddGroup which processes such data objects.
\n\n\nAdding this plugin to a view means that two new events may be fired from the client GridView, beforedrop and\ndrop