docs/output/Ext.grid.plugin.DragDrop.js

   1 Ext.data.JsonP.Ext_grid_plugin_DragDrop({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9       {
  10         "type": "String",
  11         "deprecated": null,
  12         "alias": null,
  13         "protected": false,
  14         "tagname": "cfg",
  15         "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-ddGroup",
  16         "shortDoc": "A named drag drop group to which this object belongs. ...",
  17         "static": false,
  18         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
  19         "private": false,
  20         "name": "ddGroup",
  21         "owner": "Ext.grid.plugin.DragDrop",
  22         "doc": "<p>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').</p>\n",
  23         "linenr": 90,
  24         "html_filename": "DragDrop2.html"
  25       },
  26       {
  27         "type": "String",
  28         "deprecated": null,
  29         "alias": null,
  30         "protected": false,
  31         "tagname": "cfg",
  32         "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dragGroup",
  33         "shortDoc": "The ddGroup to which the DragZone will belong. ...",
  34         "static": false,
  35         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
  36         "private": false,
  37         "name": "dragGroup",
  38         "owner": "Ext.grid.plugin.DragDrop",
  39         "doc": "<p>The ddGroup to which the DragZone will belong.</p>\n\n\n<p>This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.</p>\n\n",
  40         "linenr": 97,
  41         "html_filename": "DragDrop2.html"
  42       },
  43       {
  44         "type": "String",
  45         "deprecated": null,
  46         "alias": null,
  47         "protected": false,
  48         "tagname": "cfg",
  49         "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dropGroup",
  50         "shortDoc": "The ddGroup to which the DropZone will belong. ...",
  51         "static": false,
  52         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
  53         "private": false,
  54         "name": "dropGroup",
  55         "owner": "Ext.grid.plugin.DragDrop",
  56         "doc": "<p>The ddGroup to which the DropZone will belong.</p>\n\n\n<p>This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.</p>\n\n",
  57         "linenr": 104,
  58         "html_filename": "DragDrop2.html"
  59       },
  60       {
  61         "type": "Boolean",
  62         "deprecated": null,
  63         "alias": null,
  64         "protected": false,
  65         "tagname": "cfg",
  66         "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-enableDrag",
  67         "static": false,
  68         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
  69         "private": false,
  70         "name": "enableDrag",
  71         "owner": "Ext.grid.plugin.DragDrop",
  72         "doc": "<p>Defaults to <code>true</code></p>\n\n\n<p>Set to <code>false</code> to disallow dragging items from the View </p>\n\n",
  73         "linenr": 118,
  74         "html_filename": "DragDrop2.html"
  75       },
  76       {
  77         "type": "Boolean",
  78         "deprecated": null,
  79         "alias": null,
  80         "protected": false,
  81         "tagname": "cfg",
  82         "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-enableDrop",
  83         "static": false,
  84         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
  85         "private": false,
  86         "name": "enableDrop",
  87         "owner": "Ext.grid.plugin.DragDrop",
  88         "doc": "<p>Defaults to <code>true</code></p>\n\n\n<p>Set to <code>false</code> to disallow the View from accepting drop gestures</p>\n\n",
  89         "linenr": 111,
  90         "html_filename": "DragDrop2.html"
  91       }
  92     ],
  93     "method": [
  94       {
  95         "deprecated": null,
  96         "alias": null,
  97         "protected": false,
  98         "tagname": "method",
  99         "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-destroy",
 100         "shortDoc": "The destroy method is invoked by the owning Component at the time the Component is being destroyed. ...",
 101         "static": false,
 102         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
 103         "private": false,
 104         "params": [
 105
 106         ],
 107         "name": "destroy",
 108         "owner": "Ext.AbstractPlugin",
 109         "doc": "<p>The destroy method is invoked by the owning Component at the time the Component is being destroyed.</p>\n\n\n<p>The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.</p>\n\n",
 110         "linenr": 42,
 111         "return": {
 112           "type": "void",
 113           "doc": "\n"
 114         },
 115         "html_filename": "AbstractPlugin.html"
 116       },
 117       {
 118         "deprecated": null,
 119         "alias": null,
 120         "protected": false,
 121         "tagname": "method",
 122         "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-disable",
 123         "shortDoc": "The base implementation just sets the plugin's disabled flag to true\n\n\nPlugin subclasses which need more complex proc...",
 124         "static": false,
 125         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
 126         "private": false,
 127         "params": [
 128
 129         ],
 130         "name": "disable",
 131         "owner": "Ext.AbstractPlugin",
 132         "doc": "<p>The base implementation just sets the plugin's <code>disabled</code> flag to <code>true</code></p>\n\n\n<p>Plugin subclasses which need more complex processing may implement an overriding implementation.</p>\n\n",
 133         "linenr": 57,
 134         "return": {
 135           "type": "void",
 136           "doc": "\n"
 137         },
 138         "html_filename": "AbstractPlugin.html"
 139       },
 140       {
 141         "deprecated": null,
 142         "alias": null,
 143         "protected": false,
 144         "tagname": "method",
 145         "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-enable",
 146         "shortDoc": "The base implementation just sets the plugin's disabled flag to false\n\n\nPlugin subclasses which need more complex pro...",
 147         "static": false,
 148         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
 149         "private": false,
 150         "params": [
 151
 152         ],
 153         "name": "enable",
 154         "owner": "Ext.AbstractPlugin",
 155         "doc": "<p>The base implementation just sets the plugin's <code>disabled</code> flag to <code>false</code></p>\n\n\n<p>Plugin subclasses which need more complex processing may implement an overriding implementation.</p>\n\n",
 156         "linenr": 49,
 157         "return": {
 158           "type": "void",
 159           "doc": "\n"
 160         },
 161         "html_filename": "AbstractPlugin.html"
 162       },
 163       {
 164         "deprecated": null,
 165         "alias": null,
 166         "protected": false,
 167         "tagname": "method",
 168         "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-init",
 169         "shortDoc": "The init method is invoked after initComponent has been run for the client Component. ...",
 170         "static": false,
 171         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js",
 172         "private": false,
 173         "params": [
 174           {
 175             "type": "Component",
 176             "optional": false,
 177             "doc": "<p>The client Component which owns this plugin.</p>\n",
 178             "name": "client"
 179           }
 180         ],
 181         "name": "init",
 182         "owner": "Ext.AbstractPlugin",
 183         "doc": "<p>The init method is invoked after initComponent has been run for the client Component.</p>\n\n\n<p>The 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.</p>\n\n",
 184         "linenr": 33,
 185         "return": {
 186           "type": "void",
 187           "doc": "\n"
 188         },
 189         "html_filename": "AbstractPlugin.html"
 190       }
 191     ],
 192     "property": [
 193
 194     ],
 195     "cssVar": [
 196
 197     ],
 198     "cssMixin": [
 199
 200     ],
 201     "event": [
 202       {
 203         "deprecated": null,
 204         "alias": null,
 205         "protected": false,
 206         "tagname": "event",
 207         "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-event-beforedrop",
 208         "shortDoc": "This event is fired through the GridView. ...",
 209         "static": false,
 210         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
 211         "private": false,
 212         "params": [
 213           {
 214             "type": "HtmlElement",
 215             "optional": false,
 216             "doc": "<p>The GridView node <b>if any</b> over which the mouse was positioned.</p></p>\n\n<p>Returning <code>false</code> 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.</p>\n\n\n<p>Returning <code>0</code> 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.</p>\n\n\n<p>Any other return value continues with the data transfer operation.</p>\n\n",
 217             "name": "node"
 218           },
 219           {
 220             "type": "Object",
 221             "optional": false,
 222             "doc": "<p>The data object gathered at mousedown time by the cooperating <a href=\"#/api/Ext.dd.DragZone\" rel=\"Ext.dd.DragZone\" class=\"docClass\">DragZone</a>'s\n<a href=\"#/api/Ext.dd.DragZone-method-getDragData\" rel=\"Ext.dd.DragZone-method-getDragData\" class=\"docClass\">getDragData</a> method it contains the following properties:<ul>\n<li>copy : Boolean\n <div class=\"sub-desc\">The value of the GridView's <code>copy</code> property, or <code>true</code> if the GridView was configured\n with <code>allowCopy: true</code> and the control key was pressed when the drag operation was begun</div></li>\n<li>view : GridView\n <div class=\"sub-desc\">The source GridView from which the drag originated.</div></li>\n<li>ddel : HtmlElement\n <div class=\"sub-desc\">The drag proxy element which moves with the mouse</div></li>\n<li>item : HtmlElement\n <div class=\"sub-desc\">The GridView node upon which the mousedown event was registered.</div></li>\n<li>records : Array\n <div class=\"sub-desc\">An Array of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>s representing the selected data being dragged from the source GridView.</div></li>\n</ul></p>\n",
 223             "name": "data"
 224           },
 225           {
 226             "type": "Ext.data.Model",
 227             "optional": false,
 228             "doc": "<p>The Model over which the drop gesture took place.</p>\n",
 229             "name": "overModel"
 230           },
 231           {
 232             "type": "String",
 233             "optional": false,
 234             "doc": "<p><code>\"before\"</code> or <code>\"after\"</code> depending on whether the mouse is above or below the midline of the node.</p>\n",
 235             "name": "dropPosition"
 236           },
 237           {
 238             "type": "Function",
 239             "optional": false,
 240             "doc": "<p>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.</p>\n\n\n<p>This is useful when you want to perform some kind of asynchronous processing before confirming\nthe drop, such as an <a href=\"#/api/Ext.window.MessageBox-method-confirm\" rel=\"Ext.window.MessageBox-method-confirm\" class=\"docClass\">confirm</a> call, or an Ajax request.</p>\n\n\n<p>Return <code>0</code> from this event handler, and call the <code>dropFunction</code> at any time to perform the data transfer.</p>\n\n",
 241             "name": "dropFunction"
 242           },
 243           {
 244             "type": "Object",
 245             "tagname": "param",
 246             "name": "options",
 247             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
 248           }
 249         ],
 250         "name": "beforedrop",
 251         "owner": "Ext.grid.plugin.DragDrop",
 252         "doc": "<p><b>This event is fired through the GridView. Add listeners to the GridView object</b></p>\n\n\n<p>Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.\n\n",
 253         "linenr": 32,
 254         "html_filename": "DragDrop2.html"
 255       },
 256       {
 257         "deprecated": null,
 258         "alias": null,
 259         "protected": false,
 260         "tagname": "event",
 261         "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-event-drop",
 262         "shortDoc": "This event is fired through the GridView. ...",
 263         "static": false,
 264         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
 265         "private": false,
 266         "params": [
 267           {
 268             "type": "HtmlElement",
 269             "optional": false,
 270             "doc": "<p>The GridView node <b>if any</b> over which the mouse was positioned.</p>\n",
 271             "name": "node"
 272           },
 273           {
 274             "type": "Object",
 275             "optional": false,
 276             "doc": "<p>The data object gathered at mousedown time by the cooperating <a href=\"#/api/Ext.dd.DragZone\" rel=\"Ext.dd.DragZone\" class=\"docClass\">DragZone</a>'s\n<a href=\"#/api/Ext.dd.DragZone-method-getDragData\" rel=\"Ext.dd.DragZone-method-getDragData\" class=\"docClass\">getDragData</a> method it contains the following properties:<ul>\n<li>copy : Boolean\n <div class=\"sub-desc\">The value of the GridView's <code>copy</code> property, or <code>true</code> if the GridView was configured\n with <code>allowCopy: true</code> and the control key was pressed when the drag operation was begun</div></li>\n<li>view : GridView\n <div class=\"sub-desc\">The source GridView from which the drag originated.</div></li>\n<li>ddel : HtmlElement\n <div class=\"sub-desc\">The drag proxy element which moves with the mouse</div></li>\n<li>item : HtmlElement\n <div class=\"sub-desc\">The GridView node upon which the mousedown event was registered.</div></li>\n<li>records : Array\n <div class=\"sub-desc\">An Array of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>s representing the selected data being dragged from the source GridView.</div></li>\n</ul></p>\n",
 277             "name": "data"
 278           },
 279           {
 280             "type": "Ext.data.Model",
 281             "optional": false,
 282             "doc": "<p>The Model over which the drop gesture took place.</p>\n",
 283             "name": "overModel"
 284           },
 285           {
 286             "type": "String",
 287             "optional": false,
 288             "doc": "<p><code>\"before\"</code> or <code>\"after\"</code> depending on whether the mouse is above or below the midline of the node.</p>\n",
 289             "name": "dropPosition"
 290           },
 291           {
 292             "type": "Object",
 293             "tagname": "param",
 294             "name": "options",
 295             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
 296           }
 297         ],
 298         "name": "drop",
 299         "owner": "Ext.grid.plugin.DragDrop",
 300         "doc": "<p><b>This event is fired through the GridView. Add listeners to the GridView object</b>\nFired when a drop operation has been completed and the data has been moved or copied.</p>\n",
 301         "linenr": 65,
 302         "html_filename": "DragDrop2.html"
 303       }
 304     ]
 305   },
 306   "singleton": false,
 307   "alias": null,
 308   "superclasses": [
 309     "Ext.AbstractPlugin"
 310   ],
 311   "protected": false,
 312   "tagname": "class",
 313   "mixins": [
 314
 315   ],
 316   "href": "DragDrop2.html#Ext-grid-plugin-DragDrop",
 317   "subclasses": [
 318
 319   ],
 320   "static": false,
 321   "author": null,
 322   "component": false,
 323   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js",
 324   "private": false,
 325   "alternateClassNames": [
 326
 327   ],
 328   "name": "Ext.grid.plugin.DragDrop",
 329   "doc": "<p>This plugin provides drag and/or drop functionality for a GridView.</p>\n\n\n<p>It creates a specialized instance of <a href=\"#/api/Ext.dd.DragZone\" rel=\"Ext.dd.DragZone\" class=\"docClass\">DragZone</a> which knows how to drag out of a <a href=\"#/api/Ext.grid.View\" rel=\"Ext.grid.View\" class=\"docClass\">GridView</a>\nand loads the data object which is passed to a cooperating <a href=\"#/api/Ext.dd.DragZone\" rel=\"Ext.dd.DragZone\" class=\"docClass\">DragZone</a>'s methods with the following properties:<ul>\n<li>copy : Boolean\n <div class=\"sub-desc\">The value of the GridView's <code>copy</code> property, or <code>true</code> if the GridView was configured\n with <code>allowCopy: true</code> <u>and</u> the control key was pressed when the drag operation was begun.</div></li>\n<li>view : GridView\n <div class=\"sub-desc\">The source GridView from which the drag originated.</div></li>\n<li>ddel : HtmlElement\n <div class=\"sub-desc\">The drag proxy element which moves with the mouse</div></li>\n<li>item : HtmlElement\n <div class=\"sub-desc\">The GridView node upon which the mousedown event was registered.</div></li>\n<li>records : Array\n <div class=\"sub-desc\">An Array of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Model</a>s representing the selected data being dragged from the source GridView.</div></li>\n</ul></p>\n\n\n<p>It also creates a specialized instance of <a href=\"#/api/Ext.dd.DropZone\" rel=\"Ext.dd.DropZone\" class=\"docClass\">Ext.dd.DropZone</a> which cooperates with other DropZones which are members of the same\nddGroup which processes such data objects.</p>\n\n\n<p>Adding this plugin to a view means that two new events may be fired from the client GridView, <code>beforedrop</code> and\n<code>drop</code></p>\n\n",
 330   "mixedInto": [
 331
 332   ],
 333   "linenr": 1,
 334   "xtypes": [
 335
 336   ],
 337   "html_filename": "DragDrop2.html",
 338   "extends": "Ext.AbstractPlugin"
 339 });