git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.StatusProxy.json

   1 {
   2   "name" : "Roo.dd.StatusProxy",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "A specialized drag proxy that supports a drop status icon, {@link Roo.Layer} styles and auto-repair.  This is the\ndefault drag proxy used by all Roo.dd components.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "StatusProxy",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "config",
  21       "type" : "Object",
  22       "desc" : "",
  23       "isOptional" : false
  24     }
  25   ],
  26   "returns" : [],
  27   "throws" : "",
  28   "requires" : "",
  29   "config" : [
  30     {
  31       "name" : "dropNotAllowed",
  32       "type" : "String",
  33       "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
  34       "memberOf" : "",
  35       "isOptional" : false,
  36       "optvalues" : []
  37     },
  38     {
  39       "name" : "dropAllowed",
  40       "type" : "String",
  41       "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
  42       "memberOf" : "",
  43       "isOptional" : false,
  44       "optvalues" : []
  45     }
  46   ],
  47   "methods" : [
  48     {
  49       "name" : "reset",
  50       "type" : "function",
  51       "desc" : "Resets the status indicator to the default dropNotAllowed value",
  52       "sig" : "(clearGhost)",
  53       "static" : false,
  54       "memberOf" : "",
  55       "isStatic" : false,
  56       "isConstructor" : false,
  57       "isPrivate" : false,
  58       "example" : "",
  59       "deprecated" : "",
  60       "since" : "",
  61       "see" : "",
  62       "exceptions" : "",
  63       "requires" : "",
  64       "params" : [
  65         {
  66           "name" : "clearGhost",
  67           "type" : "Boolean",
  68           "desc" : "True to also remove all content from the ghost, false to preserve it",
  69           "isOptional" : false
  70         }
  71       ],
  72       "returns" : []
  73     },
  74     {
  75       "name" : "getGhost",
  76       "type" : "function",
  77       "desc" : "Returns the ghost element",
  78       "sig" : "()\n{\n\n}",
  79       "static" : false,
  80       "memberOf" : "",
  81       "isStatic" : false,
  82       "isConstructor" : false,
  83       "isPrivate" : false,
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "exceptions" : "",
  89       "requires" : "",
  90       "params" : [],
  91       "returns" : [
  92         {
  93           "name" : "",
  94           "type" : "Roo.Element",
  95           "desc" : "el"
  96         }
  97       ]
  98     },
  99     {
 100       "name" : "getEl",
 101       "type" : "function",
 102       "desc" : "Returns the underlying proxy {@link Roo.Layer}",
 103       "sig" : "()\n{\n\n}",
 104       "static" : false,
 105       "memberOf" : "",
 106       "isStatic" : false,
 107       "isConstructor" : false,
 108       "isPrivate" : false,
 109       "example" : "",
 110       "deprecated" : "",
 111       "since" : "",
 112       "see" : "",
 113       "exceptions" : "",
 114       "requires" : "",
 115       "params" : [],
 116       "returns" : [
 117         {
 118           "name" : "",
 119           "type" : "Roo.Layer",
 120           "desc" : "el"
 121         }
 122       ]
 123     },
 124     {
 125       "name" : "sync",
 126       "type" : "function",
 127       "desc" : "Force the Layer to sync its shadow and shim positions to the element",
 128       "sig" : "()\n{\n\n}",
 129       "static" : false,
 130       "memberOf" : "",
 131       "isStatic" : false,
 132       "isConstructor" : false,
 133       "isPrivate" : false,
 134       "example" : "",
 135       "deprecated" : "",
 136       "since" : "",
 137       "see" : "",
 138       "exceptions" : "",
 139       "requires" : "",
 140       "params" : [],
 141       "returns" : []
 142     },
 143     {
 144       "name" : "hide",
 145       "type" : "function",
 146       "desc" : "Hides the proxy",
 147       "sig" : "(clear)",
 148       "static" : false,
 149       "memberOf" : "",
 150       "isStatic" : false,
 151       "isConstructor" : false,
 152       "isPrivate" : false,
 153       "example" : "",
 154       "deprecated" : "",
 155       "since" : "",
 156       "see" : "",
 157       "exceptions" : "",
 158       "requires" : "",
 159       "params" : [
 160         {
 161           "name" : "clear",
 162           "type" : "Boolean",
 163           "desc" : "True to reset the status and clear the ghost contents, false to preserve them",
 164           "isOptional" : false
 165         }
 166       ],
 167       "returns" : []
 168     },
 169     {
 170       "name" : "show",
 171       "type" : "function",
 172       "desc" : "Displays this proxy",
 173       "sig" : "()\n{\n\n}",
 174       "static" : false,
 175       "memberOf" : "",
 176       "isStatic" : false,
 177       "isConstructor" : false,
 178       "isPrivate" : false,
 179       "example" : "",
 180       "deprecated" : "",
 181       "since" : "",
 182       "see" : "",
 183       "exceptions" : "",
 184       "requires" : "",
 185       "params" : [],
 186       "returns" : []
 187     },
 188     {
 189       "name" : "stop",
 190       "type" : "function",
 191       "desc" : "Stops the repair animation if it's currently running",
 192       "sig" : "()\n{\n\n}",
 193       "static" : false,
 194       "memberOf" : "",
 195       "isStatic" : false,
 196       "isConstructor" : false,
 197       "isPrivate" : false,
 198       "example" : "",
 199       "deprecated" : "",
 200       "since" : "",
 201       "see" : "",
 202       "exceptions" : "",
 203       "requires" : "",
 204       "params" : [],
 205       "returns" : []
 206     },
 207     {
 208       "name" : "setStatus",
 209       "type" : "function",
 210       "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.",
 211       "sig" : "(cssClass)",
 212       "static" : false,
 213       "memberOf" : "",
 214       "isStatic" : false,
 215       "isConstructor" : false,
 216       "isPrivate" : false,
 217       "example" : "",
 218       "deprecated" : "",
 219       "since" : "",
 220       "see" : "",
 221       "exceptions" : "",
 222       "requires" : "",
 223       "params" : [
 224         {
 225           "name" : "cssClass",
 226           "type" : "String",
 227           "desc" : "The css class for the new drop status indicator image",
 228           "isOptional" : false
 229         }
 230       ],
 231       "returns" : []
 232     },
 233     {
 234       "name" : "update",
 235       "type" : "function",
 236       "desc" : "Updates the contents of the ghost element",
 237       "sig" : "(html)",
 238       "static" : false,
 239       "memberOf" : "",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "exceptions" : "",
 248       "requires" : "",
 249       "params" : [
 250         {
 251           "name" : "html",
 252           "type" : "String",
 253           "desc" : "The html that will replace the current innerHTML of the ghost element",
 254           "isOptional" : false
 255         }
 256       ],
 257       "returns" : []
 258     },
 259     {
 260       "name" : "repair",
 261       "type" : "function",
 262       "desc" : "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.",
 263       "sig" : "(xy, callback, scope)",
 264       "static" : false,
 265       "memberOf" : "",
 266       "isStatic" : false,
 267       "isConstructor" : false,
 268       "isPrivate" : false,
 269       "example" : "",
 270       "deprecated" : "",
 271       "since" : "",
 272       "see" : "",
 273       "exceptions" : "",
 274       "requires" : "",
 275       "params" : [
 276         {
 277           "name" : "xy",
 278           "type" : "Array",
 279           "desc" : "The XY position of the element ([x, y])",
 280           "isOptional" : false
 281         },
 282         {
 283           "name" : "callback",
 284           "type" : "Function",
 285           "desc" : "The function to call after the repair is complete",
 286           "isOptional" : false
 287         },
 288         {
 289           "name" : "scope",
 290           "type" : "Object",
 291           "desc" : "The scope in which to execute the callback",
 292           "isOptional" : false
 293         }
 294       ],
 295       "returns" : []
 296     }
 297   ],
 298   "events" : []
 299 }