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

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