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