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

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