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