docs/output/Ext.dd.StatusProxy.js

   1 Ext.data.JsonP.Ext_dd_StatusProxy({
   2   "tagname": "class",
   3   "name": "Ext.dd.StatusProxy",
   4   "doc": "<p>A specialized drag proxy that supports a drop status icon, <a href=\"#/api/Ext.Layer\" rel=\"Ext.Layer\" class=\"docClass\">Ext.Layer</a> styles and auto-repair.  This is the\ndefault drag proxy used by all Ext.dd components.</p>\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "dropAllowed",
  21       "member": "Ext.dd.StatusProxy",
  22       "type": "String",
  23       "doc": "<p>The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
  26       "linenr": 32,
  27       "html_filename": "StatusProxy.html",
  28       "href": "StatusProxy.html#Ext-dd-StatusProxy-cfg-dropAllowed"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "dropNotAllowed",
  33       "member": "Ext.dd.StatusProxy",
  34       "type": "String",
  35       "doc": "<p>The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").</p>\n",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
  38       "linenr": 37,
  39       "html_filename": "StatusProxy.html",
  40       "href": "StatusProxy.html#Ext-dd-StatusProxy-cfg-dropNotAllowed"
  41     }
  42   ],
  43   "method": [
  44     {
  45       "tagname": "method",
  46       "name": "StatusProxy",
  47       "member": "Ext.dd.StatusProxy",
  48       "doc": "\n",
  49       "params": [
  50         {
  51           "type": "Object",
  52           "name": "config",
  53           "doc": "\n",
  54           "optional": false
  55         }
  56       ],
  57       "return": {
  58         "type": "void",
  59         "doc": "\n"
  60       },
  61       "private": false,
  62       "static": false,
  63       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
  64       "linenr": 1,
  65       "html_filename": "StatusProxy.html",
  66       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-constructor",
  67       "shortDoc": "\n"
  68     },
  69     {
  70       "tagname": "method",
  71       "name": "getEl",
  72       "member": "Ext.dd.StatusProxy",
  73       "doc": "<p>Returns the underlying proxy <a href=\"#/api/Ext.Layer\" rel=\"Ext.Layer\" class=\"docClass\">Ext.Layer</a></p>\n",
  74       "params": [
  75
  76       ],
  77       "return": {
  78         "type": "Ext.Layer",
  79         "doc": "<p>el</p>\n"
  80       },
  81       "private": false,
  82       "static": false,
  83       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
  84       "linenr": 87,
  85       "html_filename": "StatusProxy.html",
  86       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-getEl",
  87       "shortDoc": "<p>Returns the underlying proxy <a href=\"#/api/Ext.Layer\" rel=\"Ext.Layer\" class=\"docClass\">Ext.Layer</a></p>\n"
  88     },
  89     {
  90       "tagname": "method",
  91       "name": "getGhost",
  92       "member": "Ext.dd.StatusProxy",
  93       "doc": "<p>Returns the ghost element</p>\n",
  94       "params": [
  95
  96       ],
  97       "return": {
  98         "type": "Ext.core.Element",
  99         "doc": "<p>el</p>\n"
 100       },
 101       "private": false,
 102       "static": false,
 103       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 104       "linenr": 95,
 105       "html_filename": "StatusProxy.html",
 106       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-getGhost",
 107       "shortDoc": "<p>Returns the ghost element</p>\n"
 108     },
 109     {
 110       "tagname": "method",
 111       "name": "hide",
 112       "member": "Ext.dd.StatusProxy",
 113       "doc": "<p>Hides the proxy</p>\n",
 114       "params": [
 115         {
 116           "type": "Boolean",
 117           "name": "clear",
 118           "doc": "<p>True to reset the status and clear the ghost contents, false to preserve them</p>\n",
 119           "optional": false
 120         }
 121       ],
 122       "return": {
 123         "type": "void",
 124         "doc": "\n"
 125       },
 126       "private": false,
 127       "static": false,
 128       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 129       "linenr": 103,
 130       "html_filename": "StatusProxy.html",
 131       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-hide",
 132       "shortDoc": "<p>Hides the proxy</p>\n"
 133     },
 134     {
 135       "tagname": "method",
 136       "name": "repair",
 137       "member": "Ext.dd.StatusProxy",
 138       "doc": "<p>Causes the proxy to return to its position of origin via an animation.  Should be called after an\ninvalid drop operation by the item being dragged.</p>\n",
 139       "params": [
 140         {
 141           "type": "Array",
 142           "name": "xy",
 143           "doc": "<p>The XY position of the element ([x, y])</p>\n",
 144           "optional": false
 145         },
 146         {
 147           "type": "Function",
 148           "name": "callback",
 149           "doc": "<p>The function to call after the repair is complete.</p>\n",
 150           "optional": false
 151         },
 152         {
 153           "type": "Object",
 154           "name": "scope",
 155           "doc": "<p>The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the browser window.</p>\n",
 156           "optional": false
 157         }
 158       ],
 159       "return": {
 160         "type": "void",
 161         "doc": "\n"
 162       },
 163       "private": false,
 164       "static": false,
 165       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 166       "linenr": 138,
 167       "html_filename": "StatusProxy.html",
 168       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-repair",
 169       "shortDoc": "Causes the proxy to return to its position of origin via an animation.  Should be called after an\ninvalid drop operat..."
 170     },
 171     {
 172       "tagname": "method",
 173       "name": "reset",
 174       "member": "Ext.dd.StatusProxy",
 175       "doc": "<p>Resets the status indicator to the default dropNotAllowed value</p>\n",
 176       "params": [
 177         {
 178           "type": "Boolean",
 179           "name": "clearGhost",
 180           "doc": "<p>True to also remove all content from the ghost, false to preserve it</p>\n",
 181           "optional": false
 182         }
 183       ],
 184       "return": {
 185         "type": "void",
 186         "doc": "\n"
 187       },
 188       "private": false,
 189       "static": false,
 190       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 191       "linenr": 56,
 192       "html_filename": "StatusProxy.html",
 193       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-reset",
 194       "shortDoc": "<p>Resets the status indicator to the default dropNotAllowed value</p>\n"
 195     },
 196     {
 197       "tagname": "method",
 198       "name": "setStatus",
 199       "member": "Ext.dd.StatusProxy",
 200       "doc": "<p>Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.</p>\n",
 201       "params": [
 202         {
 203           "type": "String",
 204           "name": "cssClass",
 205           "doc": "<p>The css class for the new drop status indicator image</p>\n",
 206           "optional": false
 207         }
 208       ],
 209       "return": {
 210         "type": "void",
 211         "doc": "\n"
 212       },
 213       "private": false,
 214       "static": false,
 215       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 216       "linenr": 43,
 217       "html_filename": "StatusProxy.html",
 218       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-setStatus",
 219       "shortDoc": "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target e..."
 220     },
 221     {
 222       "tagname": "method",
 223       "name": "show",
 224       "member": "Ext.dd.StatusProxy",
 225       "doc": "<p>Displays this proxy</p>\n",
 226       "params": [
 227
 228       ],
 229       "return": {
 230         "type": "void",
 231         "doc": "\n"
 232       },
 233       "private": false,
 234       "static": false,
 235       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 236       "linenr": 123,
 237       "html_filename": "StatusProxy.html",
 238       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-show",
 239       "shortDoc": "<p>Displays this proxy</p>\n"
 240     },
 241     {
 242       "tagname": "method",
 243       "name": "stop",
 244       "member": "Ext.dd.StatusProxy",
 245       "doc": "<p>Stops the repair animation if it's currently running</p>\n",
 246       "params": [
 247
 248       ],
 249       "return": {
 250         "type": "void",
 251         "doc": "\n"
 252       },
 253       "private": false,
 254       "static": false,
 255       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 256       "linenr": 114,
 257       "html_filename": "StatusProxy.html",
 258       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-stop",
 259       "shortDoc": "<p>Stops the repair animation if it's currently running</p>\n"
 260     },
 261     {
 262       "tagname": "method",
 263       "name": "sync",
 264       "member": "Ext.dd.StatusProxy",
 265       "doc": "<p>Force the Layer to sync its shadow and shim positions to the element</p>\n",
 266       "params": [
 267
 268       ],
 269       "return": {
 270         "type": "void",
 271         "doc": "\n"
 272       },
 273       "private": false,
 274       "static": false,
 275       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 276       "linenr": 131,
 277       "html_filename": "StatusProxy.html",
 278       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-sync",
 279       "shortDoc": "<p>Force the Layer to sync its shadow and shim positions to the element</p>\n"
 280     },
 281     {
 282       "tagname": "method",
 283       "name": "update",
 284       "member": "Ext.dd.StatusProxy",
 285       "doc": "<p>Updates the contents of the ghost element</p>\n",
 286       "params": [
 287         {
 288           "type": "String/HTMLElement",
 289           "name": "html",
 290           "doc": "<p>The html that will replace the current innerHTML of the ghost element, or a\nDOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first).</p>\n",
 291           "optional": false
 292         }
 293       ],
 294       "return": {
 295         "type": "void",
 296         "doc": "\n"
 297       },
 298       "private": false,
 299       "static": false,
 300       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 301       "linenr": 68,
 302       "html_filename": "StatusProxy.html",
 303       "href": "StatusProxy.html#Ext-dd-StatusProxy-method-update",
 304       "shortDoc": "<p>Updates the contents of the ghost element</p>\n"
 305     }
 306   ],
 307   "property": [
 308
 309   ],
 310   "event": [
 311
 312   ],
 313   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js",
 314   "linenr": 1,
 315   "html_filename": "StatusProxy.html",
 316   "href": "StatusProxy.html#Ext-dd-StatusProxy",
 317   "cssVar": [
 318
 319   ],
 320   "cssMixin": [
 321
 322   ],
 323   "component": false,
 324   "superclasses": [
 325
 326   ],
 327   "subclasses": [
 328
 329   ],
 330   "mixedInto": [
 331
 332   ],
 333   "allMixins": [
 334
 335   ]
 336 });