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