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

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