git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.dd.DragZone.json

   1 {
   2   "name" : "Roo.dd.DragZone",
   3   "augments" : [
   4     "Roo.dd.DragSource",
   5     "Roo.dd.DDProxy",
   6     "Roo.dd.DD",
   7     "Roo.dd.DragDrop",
   8     "Roo.util.Observable"
   9   ],
  10   "desc" : "This class provides a container DD instance that proxies for multiple child node sources.<br />\nBy default, this class requires that draggable child nodes are registered with {@link Roo.dd.Registry}.",
  11   "isSingleton" : false,
  12   "isStatic" : true,
  13   "isBuiltin" : false,
  14   "config" : [
  15     {
  16       "name" : "listeners",
  17       "type" : "Object",
  18       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  19       "memberOf" : "Roo.util.Observable",
  20       "values" : [
  21       ]
  22     },
  23     {
  24       "name" : "dropNotAllowed",
  25       "type" : "String",
  26       "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
  27       "memberOf" : "Roo.dd.DragSource",
  28       "values" : [
  29       ]
  30     },
  31     {
  32       "name" : "hlColor",
  33       "type" : "String",
  34       "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
  35       "memberOf" : "Roo.dd.DragZone",
  36       "values" : [
  37       ]
  38     },
  39     {
  40       "name" : "dropAllowed",
  41       "type" : "String",
  42       "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
  43       "memberOf" : "Roo.dd.DragSource",
  44       "values" : [
  45       ]
  46     },
  47     {
  48       "name" : "containerScroll",
  49       "type" : "Boolean",
  50       "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
  51       "memberOf" : "Roo.dd.DragZone",
  52       "values" : [
  53       ]
  54     }
  55   ],
  56   "methods" : [
  57     {
  58       "name" : "getRepairXY",
  59       "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel",
  60       "isStatic" : false,
  61       "isConstructor" : false,
  62       "isPrivate" : false,
  63       "memberOf" : "Roo.dd.DragZone",
  64       "example" : "",
  65       "deprecated" : "",
  66       "since" : "",
  67       "see" : "",
  68       "params" : [
  69         {
  70           "name" : "e",
  71           "type" : "EventObject",
  72           "desc" : "The mouse up event",
  73           "isOptional" : false
  74         }
  75       ],
  76       "returns" : [
  77         {
  78           "name" : "",
  79           "type" : "Array",
  80           "desc" : "The xy location (e.g. [100, 200])"
  81         }
  82       ]
  83     },
  84     {
  85       "name" : "afterRepair",
  86       "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
  87       "isStatic" : false,
  88       "isConstructor" : false,
  89       "isPrivate" : false,
  90       "memberOf" : "Roo.dd.DragZone",
  91       "example" : "",
  92       "deprecated" : "",
  93       "since" : "",
  94       "see" : "",
  95       "params" : [
  96       ],
  97       "returns" : [
  98       ]
  99     },
 100     {
 101       "name" : "getDragData",
 102       "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.",
 103       "isStatic" : false,
 104       "isConstructor" : false,
 105       "isPrivate" : false,
 106       "memberOf" : "Roo.dd.DragZone",
 107       "example" : "",
 108       "deprecated" : "",
 109       "since" : "",
 110       "see" : "",
 111       "params" : [
 112         {
 113           "name" : "e",
 114           "type" : "EventObject",
 115           "desc" : "The mouse down event",
 116           "isOptional" : false
 117         }
 118       ],
 119       "returns" : [
 120         {
 121           "name" : "",
 122           "type" : "Object",
 123           "desc" : "The dragData"
 124         }
 125       ]
 126     },
 127     {
 128       "name" : "onInitDrag",
 129       "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel",
 130       "isStatic" : false,
 131       "isConstructor" : false,
 132       "isPrivate" : false,
 133       "memberOf" : "Roo.dd.DragZone",
 134       "example" : "",
 135       "deprecated" : "",
 136       "since" : "",
 137       "see" : "",
 138       "params" : [
 139         {
 140           "name" : "x",
 141           "type" : "Number",
 142           "desc" : "The x position of the click on the dragged object",
 143           "isOptional" : false
 144         },
 145         {
 146           "name" : "y",
 147           "type" : "Number",
 148           "desc" : "The y position of the click on the dragged object",
 149           "isOptional" : false
 150         }
 151       ],
 152       "returns" : [
 153         {
 154           "name" : "",
 155           "type" : "Boolean",
 156           "desc" : "true to continue the drag, false to cancel"
 157         }
 158       ]
 159     },
 160     {
 161       "name" : "beforeDragEnter",
 162       "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
 163       "isStatic" : false,
 164       "isConstructor" : false,
 165       "isPrivate" : false,
 166       "memberOf" : "Roo.dd.DragSource",
 167       "example" : "",
 168       "deprecated" : "",
 169       "since" : "",
 170       "see" : "",
 171       "params" : [
 172         {
 173           "name" : "target",
 174           "type" : "Roo.dd.DragDrop",
 175           "desc" : "The drop target",
 176           "isOptional" : false
 177         },
 178         {
 179           "name" : "e",
 180           "type" : "Event",
 181           "desc" : "The event object",
 182           "isOptional" : false
 183         },
 184         {
 185           "name" : "id",
 186           "type" : "String",
 187           "desc" : "The id of the dragged element",
 188           "isOptional" : false
 189         }
 190       ],
 191       "returns" : [
 192         {
 193           "name" : "",
 194           "type" : "Boolean",
 195           "desc" : "isValid True if the drag event is valid, else false to cancel"
 196         }
 197       ]
 198     },
 199     {
 200       "name" : "hideProxy",
 201       "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
 202       "isStatic" : false,
 203       "isConstructor" : false,
 204       "isPrivate" : false,
 205       "memberOf" : "Roo.dd.DragSource",
 206       "example" : "",
 207       "deprecated" : "",
 208       "since" : "",
 209       "see" : "",
 210       "params" : [
 211       ],
 212       "returns" : [
 213       ]
 214     },
 215     {
 216       "name" : "beforeDragOut",
 217       "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
 218       "isStatic" : false,
 219       "isConstructor" : false,
 220       "isPrivate" : false,
 221       "memberOf" : "Roo.dd.DragSource",
 222       "example" : "",
 223       "deprecated" : "",
 224       "since" : "",
 225       "see" : "",
 226       "params" : [
 227         {
 228           "name" : "target",
 229           "type" : "Roo.dd.DragDrop",
 230           "desc" : "The drop target",
 231           "isOptional" : false
 232         },
 233         {
 234           "name" : "e",
 235           "type" : "Event",
 236           "desc" : "The event object",
 237           "isOptional" : false
 238         },
 239         {
 240           "name" : "id",
 241           "type" : "String",
 242           "desc" : "The id of the dragged element",
 243           "isOptional" : false
 244         }
 245       ],
 246       "returns" : [
 247         {
 248           "name" : "",
 249           "type" : "Boolean",
 250           "desc" : "isValid True if the drag event is valid, else false to cancel"
 251         }
 252       ]
 253     },
 254     {
 255       "name" : "beforeInvalidDrop",
 256       "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
 257       "isStatic" : false,
 258       "isConstructor" : false,
 259       "isPrivate" : false,
 260       "memberOf" : "Roo.dd.DragSource",
 261       "example" : "",
 262       "deprecated" : "",
 263       "since" : "",
 264       "see" : "",
 265       "params" : [
 266         {
 267           "name" : "target",
 268           "type" : "Roo.dd.DragDrop",
 269           "desc" : "The drop target",
 270           "isOptional" : false
 271         },
 272         {
 273           "name" : "e",
 274           "type" : "Event",
 275           "desc" : "The event object",
 276           "isOptional" : false
 277         },
 278         {
 279           "name" : "id",
 280           "type" : "String",
 281           "desc" : "The id of the dragged element",
 282           "isOptional" : false
 283         }
 284       ],
 285       "returns" : [
 286         {
 287           "name" : "",
 288           "type" : "Boolean",
 289           "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
 290         }
 291       ]
 292     },
 293     {
 294       "name" : "beforeDragDrop",
 295       "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
 296       "isStatic" : false,
 297       "isConstructor" : false,
 298       "isPrivate" : false,
 299       "memberOf" : "Roo.dd.DragSource",
 300       "example" : "",
 301       "deprecated" : "",
 302       "since" : "",
 303       "see" : "",
 304       "params" : [
 305         {
 306           "name" : "target",
 307           "type" : "Roo.dd.DragDrop",
 308           "desc" : "The drop target",
 309           "isOptional" : false
 310         },
 311         {
 312           "name" : "e",
 313           "type" : "Event",
 314           "desc" : "The event object",
 315           "isOptional" : false
 316         },
 317         {
 318           "name" : "id",
 319           "type" : "String",
 320           "desc" : "The id of the dragged element",
 321           "isOptional" : false
 322         }
 323       ],
 324       "returns" : [
 325         {
 326           "name" : "",
 327           "type" : "Boolean",
 328           "desc" : "isValid True if the drag drop event is valid, else false to cancel"
 329         }
 330       ]
 331     },
 332     {
 333       "name" : "getProxy",
 334       "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
 335       "isStatic" : false,
 336       "isConstructor" : false,
 337       "isPrivate" : false,
 338       "memberOf" : "Roo.dd.DragSource",
 339       "example" : "",
 340       "deprecated" : "",
 341       "since" : "",
 342       "see" : "",
 343       "params" : [
 344       ],
 345       "returns" : [
 346         {
 347           "name" : "",
 348           "type" : "Roo.dd.StatusProxy",
 349           "desc" : "proxy The StatusProxy"
 350         }
 351       ]
 352     },
 353     {
 354       "name" : "onBeforeDrag",
 355       "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
 356       "isStatic" : false,
 357       "isConstructor" : false,
 358       "isPrivate" : false,
 359       "memberOf" : "Roo.dd.DragSource",
 360       "example" : "",
 361       "deprecated" : "",
 362       "since" : "",
 363       "see" : "",
 364       "params" : [
 365         {
 366           "name" : "data",
 367           "type" : "Object",
 368           "desc" : "An object containing arbitrary data to be shared with drop targets",
 369           "isOptional" : false
 370         },
 371         {
 372           "name" : "e",
 373           "type" : "Event",
 374           "desc" : "The event object",
 375           "isOptional" : false
 376         }
 377       ],
 378       "returns" : [
 379         {
 380           "name" : "",
 381           "type" : "Boolean",
 382           "desc" : "isValid True if the drag event is valid, else false to cancel"
 383         }
 384       ]
 385     },
 386     {
 387       "name" : "onStartDrag",
 388       "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun.  The drag cannot be canceled from this function.",
 389       "isStatic" : false,
 390       "isConstructor" : false,
 391       "isPrivate" : false,
 392       "memberOf" : "Roo.dd.DragSource",
 393       "example" : "",
 394       "deprecated" : "",
 395       "since" : "",
 396       "see" : "",
 397       "params" : [
 398         {
 399           "name" : "x",
 400           "type" : "Number",
 401           "desc" : "The x position of the click on the dragged object",
 402           "isOptional" : false
 403         },
 404         {
 405           "name" : "y",
 406           "type" : "Number",
 407           "desc" : "The y position of the click on the dragged object",
 408           "isOptional" : false
 409         }
 410       ],
 411       "returns" : [
 412       ]
 413     },
 414     {
 415       "name" : "beforeDragOver",
 416       "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
 417       "isStatic" : false,
 418       "isConstructor" : false,
 419       "isPrivate" : false,
 420       "memberOf" : "Roo.dd.DragSource",
 421       "example" : "",
 422       "deprecated" : "",
 423       "since" : "",
 424       "see" : "",
 425       "params" : [
 426         {
 427           "name" : "target",
 428           "type" : "Roo.dd.DragDrop",
 429           "desc" : "The drop target",
 430           "isOptional" : false
 431         },
 432         {
 433           "name" : "e",
 434           "type" : "Event",
 435           "desc" : "The event object",
 436           "isOptional" : false
 437         },
 438         {
 439           "name" : "id",
 440           "type" : "String",
 441           "desc" : "The id of the dragged element",
 442           "isOptional" : false
 443         }
 444       ],
 445       "returns" : [
 446         {
 447           "name" : "",
 448           "type" : "Boolean",
 449           "desc" : "isValid True if the drag event is valid, else false to cancel"
 450         }
 451       ]
 452     },
 453     {
 454       "name" : "initFrame",
 455       "desc" : "Initialization for the drag frame element.  Must be called in the\nconstructor of all subclasses",
 456       "isStatic" : false,
 457       "isConstructor" : false,
 458       "isPrivate" : false,
 459       "memberOf" : "Roo.dd.DDProxy",
 460       "example" : "",
 461       "deprecated" : "",
 462       "since" : "",
 463       "see" : "",
 464       "params" : [
 465       ],
 466       "returns" : [
 467       ]
 468     },
 469     {
 470       "name" : "createFrame",
 471       "desc" : "Creates the proxy element if it does not yet exist",
 472       "isStatic" : false,
 473       "isConstructor" : false,
 474       "isPrivate" : false,
 475       "memberOf" : "Roo.dd.DDProxy",
 476       "example" : "",
 477       "deprecated" : "",
 478       "since" : "",
 479       "see" : "",
 480       "params" : [
 481       ],
 482       "returns" : [
 483       ]
 484     },
 485     {
 486       "name" : "alignElWithMouse",
 487       "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked.  Override this if you want to place the element in a\nlocation other than where the cursor is.",
 488       "isStatic" : false,
 489       "isConstructor" : false,
 490       "isPrivate" : false,
 491       "memberOf" : "Roo.dd.DD",
 492       "example" : "",
 493       "deprecated" : "",
 494       "since" : "",
 495       "see" : "",
 496       "params" : [
 497         {
 498           "name" : "el",
 499           "type" : "HTMLElement",
 500           "desc" : "the element to move",
 501           "isOptional" : false
 502         },
 503         {
 504           "name" : "iPageX",
 505           "type" : "int",
 506           "desc" : "the X coordinate of the mousedown or drag event",
 507           "isOptional" : false
 508         },
 509         {
 510           "name" : "iPageY",
 511           "type" : "int",
 512           "desc" : "the Y coordinate of the mousedown or drag event",
 513           "isOptional" : false
 514         }
 515       ],
 516       "returns" : [
 517       ]
 518     },
 519     {
 520       "name" : "setDelta",
 521       "desc" : "Sets the pointer offset.  You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
 522       "isStatic" : false,
 523       "isConstructor" : false,
 524       "isPrivate" : false,
 525       "memberOf" : "Roo.dd.DD",
 526       "example" : "",
 527       "deprecated" : "",
 528       "since" : "",
 529       "see" : "",
 530       "params" : [
 531         {
 532           "name" : "iDeltaX",
 533           "type" : "int",
 534           "desc" : "the distance from the left",
 535           "isOptional" : false
 536         },
 537         {
 538           "name" : "iDeltaY",
 539           "type" : "int",
 540           "desc" : "the distance from the top",
 541           "isOptional" : false
 542         }
 543       ],
 544       "returns" : [
 545       ]
 546     },
 547     {
 548       "name" : "autoOffset",
 549       "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
 550       "isStatic" : false,
 551       "isConstructor" : false,
 552       "isPrivate" : false,
 553       "memberOf" : "Roo.dd.DD",
 554       "example" : "",
 555       "deprecated" : "",
 556       "since" : "",
 557       "see" : "",
 558       "params" : [
 559         {
 560           "name" : "iPageX",
 561           "type" : "int",
 562           "desc" : "the X coordinate of the click",
 563           "isOptional" : false
 564         },
 565         {
 566           "name" : "iPageY",
 567           "type" : "int",
 568           "desc" : "the Y coordinate of the click",
 569           "isOptional" : false
 570         }
 571       ],
 572       "returns" : [
 573       ]
 574     },
 575     {
 576       "name" : "setDragElPos",
 577       "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked.  Override this if you want to place the element in a\nlocation other than where the cursor is.",
 578       "isStatic" : false,
 579       "isConstructor" : false,
 580       "isPrivate" : false,
 581       "memberOf" : "Roo.dd.DD",
 582       "example" : "",
 583       "deprecated" : "",
 584       "since" : "",
 585       "see" : "",
 586       "params" : [
 587         {
 588           "name" : "iPageX",
 589           "type" : "int",
 590           "desc" : "the X coordinate of the mousedown or drag event",
 591           "isOptional" : false
 592         },
 593         {
 594           "name" : "iPageY",
 595           "type" : "int",
 596           "desc" : "the Y coordinate of the mousedown or drag event",
 597           "isOptional" : false
 598         }
 599       ],
 600       "returns" : [
 601       ]
 602     },
 603     {
 604       "name" : "cachePosition",
 605       "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand.  We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
 606       "isStatic" : false,
 607       "isConstructor" : false,
 608       "isPrivate" : false,
 609       "memberOf" : "Roo.dd.DD",
 610       "example" : "",
 611       "deprecated" : "",
 612       "since" : "",
 613       "see" : "",
 614       "params" : [
 615         {
 616           "name" : "iPageX",
 617           "type" : "",
 618           "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
 619           "isOptional" : false
 620         },
 621         {
 622           "name" : "iPageY",
 623           "type" : "",
 624           "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
 625           "isOptional" : false
 626         }
 627       ],
 628       "returns" : [
 629       ]
 630     },
 631     {
 632       "name" : "setHandleElId",
 633       "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation.  An example of this would be if\nyou have a content div with text and links.  Clicking anywhere in the\ncontent area would normally start the drag operation.  Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
 634       "isStatic" : false,
 635       "isConstructor" : false,
 636       "isPrivate" : false,
 637       "memberOf" : "Roo.dd.DragDrop",
 638       "example" : "",
 639       "deprecated" : "",
 640       "since" : "",
 641       "see" : "",
 642       "params" : [
 643         {
 644           "name" : "id",
 645           "type" : "",
 646           "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
 647           "isOptional" : false
 648         }
 649       ],
 650       "returns" : [
 651       ]
 652     },
 653     {
 654       "name" : "init",
 655       "desc" : "Sets up the DragDrop object.  Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
 656       "isStatic" : false,
 657       "isConstructor" : false,
 658       "isPrivate" : false,
 659       "memberOf" : "Roo.dd.DragDrop",
 660       "example" : "",
 661       "deprecated" : "",
 662       "since" : "",
 663       "see" : "",
 664       "params" : [
 665         {
 666           "name" : "id",
 667           "type" : "",
 668           "desc" : "the id of the linked element",
 669           "isOptional" : false
 670         },
 671         {
 672           "name" : "sGroup",
 673           "type" : "String",
 674           "desc" : "the group of related items",
 675           "isOptional" : false
 676         },
 677         {
 678           "name" : "config",
 679           "type" : "object",
 680           "desc" : "configuration attributes",
 681           "isOptional" : false
 682         }
 683       ],
 684       "returns" : [
 685       ]
 686     },
 687     {
 688       "name" : "removeInvalidHandleType",
 689       "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
 690       "isStatic" : false,
 691       "isConstructor" : false,
 692       "isPrivate" : false,
 693       "memberOf" : "Roo.dd.DragDrop",
 694       "example" : "",
 695       "deprecated" : "",
 696       "since" : "",
 697       "see" : "",
 698       "params" : [
 699         {
 700           "name" : "tagName",
 701           "type" : "string",
 702           "desc" : "the type of element to unexclude",
 703           "isOptional" : false
 704         }
 705       ],
 706       "returns" : [
 707       ]
 708     },
 709     {
 710       "name" : "unreg",
 711       "desc" : "Remove all drag and drop hooks for this element",
 712       "isStatic" : false,
 713       "isConstructor" : false,
 714       "isPrivate" : false,
 715       "memberOf" : "Roo.dd.DragDrop",
 716       "example" : "",
 717       "deprecated" : "",
 718       "since" : "",
 719       "see" : "",
 720       "params" : [
 721       ],
 722       "returns" : [
 723       ]
 724     },
 725     {
 726       "name" : "addInvalidHandleType",
 727       "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked.  This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
 728       "isStatic" : false,
 729       "isConstructor" : false,
 730       "isPrivate" : false,
 731       "memberOf" : "Roo.dd.DragDrop",
 732       "example" : "",
 733       "deprecated" : "",
 734       "since" : "",
 735       "see" : "",
 736       "params" : [
 737         {
 738           "name" : "tagName",
 739           "type" : "string",
 740           "desc" : "the type of element to exclude",
 741           "isOptional" : false
 742         }
 743       ],
 744       "returns" : [
 745       ]
 746     },
 747     {
 748       "name" : "onDragDrop",
 749       "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
 750       "isStatic" : false,
 751       "isConstructor" : false,
 752       "isPrivate" : false,
 753       "memberOf" : "Roo.dd.DragDrop",
 754       "example" : "",
 755       "deprecated" : "",
 756       "since" : "",
 757       "see" : "",
 758       "params" : [
 759         {
 760           "name" : "e",
 761           "type" : "Event",
 762           "desc" : "the mouseup event",
 763           "isOptional" : false
 764         },
 765         {
 766           "name" : "id",
 767           "type" : "String|DragDrop[]",
 768           "desc" : "In POINT mode, the element\nid this was dropped on.  In INTERSECT mode, an array of dd items this\nwas dropped on.",
 769           "isOptional" : false
 770         }
 771       ],
 772       "returns" : [
 773       ]
 774     },
 775     {
 776       "name" : "removeInvalidHandleId",
 777       "desc" : "Unsets an invalid handle id",
 778       "isStatic" : false,
 779       "isConstructor" : false,
 780       "isPrivate" : false,
 781       "memberOf" : "Roo.dd.DragDrop",
 782       "example" : "",
 783       "deprecated" : "",
 784       "since" : "",
 785       "see" : "",
 786       "params" : [
 787         {
 788           "name" : "id",
 789           "type" : "string",
 790           "desc" : "the id of the element to re-enable",
 791           "isOptional" : false
 792         }
 793       ],
 794       "returns" : [
 795       ]
 796     },
 797     {
 798       "name" : "onAvailable",
 799       "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
 800       "isStatic" : false,
 801       "isConstructor" : false,
 802       "isPrivate" : false,
 803       "memberOf" : "Roo.dd.DragDrop",
 804       "example" : "",
 805       "deprecated" : "",
 806       "since" : "",
 807       "see" : "",
 808       "params" : [
 809       ],
 810       "returns" : [
 811       ]
 812     },
 813     {
 814       "name" : "setOuterHandleElId",
 815       "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
 816       "isStatic" : false,
 817       "isConstructor" : false,
 818       "isPrivate" : false,
 819       "memberOf" : "Roo.dd.DragDrop",
 820       "example" : "",
 821       "deprecated" : "",
 822       "since" : "",
 823       "see" : "",
 824       "params" : [
 825         {
 826           "name" : "id",
 827           "type" : "",
 828           "desc" : "the id of the element that will be used to initiate the drag",
 829           "isOptional" : false
 830         }
 831       ],
 832       "returns" : [
 833       ]
 834     },
 835     {
 836       "name" : "onMouseUp",
 837       "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
 838       "isStatic" : false,
 839       "isConstructor" : false,
 840       "isPrivate" : false,
 841       "memberOf" : "Roo.dd.DragDrop",
 842       "example" : "",
 843       "deprecated" : "",
 844       "since" : "",
 845       "see" : "",
 846       "params" : [
 847         {
 848           "name" : "e",
 849           "type" : "Event",
 850           "desc" : "the mouseup event",
 851           "isOptional" : false
 852         }
 853       ],
 854       "returns" : [
 855       ]
 856     },
 857     {
 858       "name" : "getDragEl",
 859       "desc" : "Returns a reference to the actual element to drag.  By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
 860       "isStatic" : false,
 861       "isConstructor" : false,
 862       "isPrivate" : false,
 863       "memberOf" : "Roo.dd.DragDrop",
 864       "example" : "",
 865       "deprecated" : "",
 866       "since" : "",
 867       "see" : "",
 868       "params" : [
 869       ],
 870       "returns" : [
 871         {
 872           "name" : "",
 873           "type" : "HTMLElement",
 874           "desc" : "the html element"
 875         }
 876       ]
 877     },
 878     {
 879       "name" : "setYConstraint",
 880       "desc" : "By default, the element can be dragged any place on the screen.  Set\nthis to limit the vertical travel of the element.  Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
 881       "isStatic" : false,
 882       "isConstructor" : false,
 883       "isPrivate" : false,
 884       "memberOf" : "Roo.dd.DragDrop",
 885       "example" : "",
 886       "deprecated" : "",
 887       "since" : "",
 888       "see" : "",
 889       "params" : [
 890         {
 891           "name" : "iUp",
 892           "type" : "int",
 893           "desc" : "the number of pixels the element can move up",
 894           "isOptional" : false
 895         },
 896         {
 897           "name" : "iDown",
 898           "type" : "int",
 899           "desc" : "the number of pixels the element can move down",
 900           "isOptional" : false
 901         },
 902         {
 903           "name" : "iTickSize",
 904           "type" : "int",
 905           "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
 906           "isOptional" : false
 907         }
 908       ],
 909       "returns" : [
 910       ]
 911     },
 912     {
 913       "name" : "clearConstraints",
 914       "desc" : "Clears any constraints applied to this instance.  Also clears ticks\nsince they can't exist independent of a constraint at this time.",
 915       "isStatic" : false,
 916       "isConstructor" : false,
 917       "isPrivate" : false,
 918       "memberOf" : "Roo.dd.DragDrop",
 919       "example" : "",
 920       "deprecated" : "",
 921       "since" : "",
 922       "see" : "",
 923       "params" : [
 924       ],
 925       "returns" : [
 926       ]
 927     },
 928     {
 929       "name" : "onInvalidDrop",
 930       "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
 931       "isStatic" : false,
 932       "isConstructor" : false,
 933       "isPrivate" : false,
 934       "memberOf" : "Roo.dd.DragDrop",
 935       "example" : "",
 936       "deprecated" : "",
 937       "since" : "",
 938       "see" : "",
 939       "params" : [
 940         {
 941           "name" : "e",
 942           "type" : "Event",
 943           "desc" : "the mouseup event",
 944           "isOptional" : false
 945         }
 946       ],
 947       "returns" : [
 948       ]
 949     },
 950     {
 951       "name" : "addInvalidHandleId",
 952       "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
 953       "isStatic" : false,
 954       "isConstructor" : false,
 955       "isPrivate" : false,
 956       "memberOf" : "Roo.dd.DragDrop",
 957       "example" : "",
 958       "deprecated" : "",
 959       "since" : "",
 960       "see" : "",
 961       "params" : [
 962         {
 963           "name" : "id",
 964           "type" : "string",
 965           "desc" : "the element id of the element you wish to ignore",
 966           "isOptional" : false
 967         }
 968       ],
 969       "returns" : [
 970       ]
 971     },
 972     {
 973       "name" : "removeInvalidHandleClass",
 974       "desc" : "Unsets an invalid css class",
 975       "isStatic" : false,
 976       "isConstructor" : false,
 977       "isPrivate" : false,
 978       "memberOf" : "Roo.dd.DragDrop",
 979       "example" : "",
 980       "deprecated" : "",
 981       "since" : "",
 982       "see" : "",
 983       "params" : [
 984         {
 985           "name" : "cssClass",
 986           "type" : "string",
 987           "desc" : "the class of the element(s) you wish to\nre-enable",
 988           "isOptional" : false
 989         }
 990       ],
 991       "returns" : [
 992       ]
 993     },
 994     {
 995       "name" : "onDragOut",
 996       "desc" : "Abstract method called when we are no longer hovering over an element",
 997       "isStatic" : false,
 998       "isConstructor" : false,
 999       "isPrivate" : false,
1000       "memberOf" : "Roo.dd.DragDrop",
1001       "example" : "",
1002       "deprecated" : "",
1003       "since" : "",
1004       "see" : "",
1005       "params" : [
1006         {
1007           "name" : "e",
1008           "type" : "Event",
1009           "desc" : "the mousemove event",
1010           "isOptional" : false
1011         },
1012         {
1013           "name" : "id",
1014           "type" : "String|DragDrop[]",
1015           "desc" : "In POINT mode, the element\nid this was hovering over.  In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
1016           "isOptional" : false
1017         }
1018       ],
1019       "returns" : [
1020       ]
1021     },
1022     {
1023       "name" : "setDragElId",
1024       "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
1025       "isStatic" : false,
1026       "isConstructor" : false,
1027       "isPrivate" : false,
1028       "memberOf" : "Roo.dd.DragDrop",
1029       "example" : "",
1030       "deprecated" : "",
1031       "since" : "",
1032       "see" : "",
1033       "params" : [
1034         {
1035           "name" : "id",
1036           "type" : "",
1037           "desc" : "{string} the id of the element that will be used to initiate the drag",
1038           "isOptional" : false
1039         }
1040       ],
1041       "returns" : [
1042       ]
1043     },
1044     {
1045       "name" : "endDrag",
1046       "desc" : "Fired when we are done dragging the object",
1047       "isStatic" : false,
1048       "isConstructor" : false,
1049       "isPrivate" : false,
1050       "memberOf" : "Roo.dd.DragDrop",
1051       "example" : "",
1052       "deprecated" : "",
1053       "since" : "",
1054       "see" : "",
1055       "params" : [
1056         {
1057           "name" : "e",
1058           "type" : "Event",
1059           "desc" : "the mouseup event",
1060           "isOptional" : false
1061         }
1062       ],
1063       "returns" : [
1064       ]
1065     },
1066     {
1067       "name" : "getEl",
1068       "desc" : "Returns a reference to the linked element",
1069       "isStatic" : false,
1070       "isConstructor" : false,
1071       "isPrivate" : false,
1072       "memberOf" : "Roo.dd.DragDrop",
1073       "example" : "",
1074       "deprecated" : "",
1075       "since" : "",
1076       "see" : "",
1077       "params" : [
1078       ],
1079       "returns" : [
1080         {
1081           "name" : "",
1082           "type" : "HTMLElement",
1083           "desc" : "the html element"
1084         }
1085       ]
1086     },
1087     {
1088       "name" : "onDrag",
1089       "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
1090       "isStatic" : false,
1091       "isConstructor" : false,
1092       "isPrivate" : false,
1093       "memberOf" : "Roo.dd.DragDrop",
1094       "example" : "",
1095       "deprecated" : "",
1096       "since" : "",
1097       "see" : "",
1098       "params" : [
1099         {
1100           "name" : "e",
1101           "type" : "Event",
1102           "desc" : "the mousemove event",
1103           "isOptional" : false
1104         }
1105       ],
1106       "returns" : [
1107       ]
1108     },
1109     {
1110       "name" : "onDragEnter",
1111       "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
1112       "isStatic" : false,
1113       "isConstructor" : false,
1114       "isPrivate" : false,
1115       "memberOf" : "Roo.dd.DragDrop",
1116       "example" : "",
1117       "deprecated" : "",
1118       "since" : "",
1119       "see" : "",
1120       "params" : [
1121         {
1122           "name" : "e",
1123           "type" : "Event",
1124           "desc" : "the mousemove event",
1125           "isOptional" : false
1126         },
1127         {
1128           "name" : "id",
1129           "type" : "String|DragDrop[]",
1130           "desc" : "In POINT mode, the element\nid this is hovering over.  In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
1131           "isOptional" : false
1132         }
1133       ],
1134       "returns" : [
1135       ]
1136     },
1137     {
1138       "name" : "lock",
1139       "desc" : "Lock this instance",
1140       "isStatic" : false,
1141       "isConstructor" : false,
1142       "isPrivate" : false,
1143       "memberOf" : "Roo.dd.DragDrop",
1144       "example" : "",
1145       "deprecated" : "",
1146       "since" : "",
1147       "see" : "",
1148       "params" : [
1149       ],
1150       "returns" : [
1151       ]
1152     },
1153     {
1154       "name" : "onMouseDown",
1155       "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
1156       "isStatic" : false,
1157       "isConstructor" : false,
1158       "isPrivate" : false,
1159       "memberOf" : "Roo.dd.DragDrop",
1160       "example" : "",
1161       "deprecated" : "",
1162       "since" : "",
1163       "see" : "",
1164       "params" : [
1165         {
1166           "name" : "e",
1167           "type" : "Event",
1168           "desc" : "the mousedown event",
1169           "isOptional" : false
1170         }
1171       ],
1172       "returns" : [
1173       ]
1174     },
1175     {
1176       "name" : "applyConfig",
1177       "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain.  So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
1178       "isStatic" : false,
1179       "isConstructor" : false,
1180       "isPrivate" : false,
1181       "memberOf" : "Roo.dd.DragDrop",
1182       "example" : "",
1183       "deprecated" : "",
1184       "since" : "",
1185       "see" : "",
1186       "params" : [
1187       ],
1188       "returns" : [
1189       ]
1190     },
1191     {
1192       "name" : "unlock",
1193       "desc" : "Unlock this instace",
1194       "isStatic" : false,
1195       "isConstructor" : false,
1196       "isPrivate" : false,
1197       "memberOf" : "Roo.dd.DragDrop",
1198       "example" : "",
1199       "deprecated" : "",
1200       "since" : "",
1201       "see" : "",
1202       "params" : [
1203       ],
1204       "returns" : [
1205       ]
1206     },
1207     {
1208       "name" : "isTarget",
1209       "desc" : "By default, all insances can be a drop target.  This can be disabled by\nsetting isTarget to false.",
1210       "isStatic" : false,
1211       "isConstructor" : false,
1212       "isPrivate" : false,
1213       "memberOf" : "Roo.dd.DragDrop",
1214       "example" : "",
1215       "deprecated" : "",
1216       "since" : "",
1217       "see" : "",
1218       "params" : [
1219       ],
1220       "returns" : [
1221       ]
1222     },
1223     {
1224       "name" : "setInitPosition",
1225       "desc" : "Stores the initial placement of the linked element.",
1226       "isStatic" : false,
1227       "isConstructor" : false,
1228       "isPrivate" : false,
1229       "memberOf" : "Roo.dd.DragDrop",
1230       "example" : "",
1231       "deprecated" : "",
1232       "since" : "",
1233       "see" : "",
1234       "params" : [
1235         {
1236           "name" : "diffX",
1237           "type" : "int",
1238           "desc" : "the X offset, default 0",
1239           "isOptional" : false
1240         },
1241         {
1242           "name" : "diffY",
1243           "type" : "int",
1244           "desc" : "the Y offset, default 0",
1245           "isOptional" : false
1246         }
1247       ],
1248       "returns" : [
1249       ]
1250     },
1251     {
1252       "name" : "initTarget",
1253       "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
1254       "isStatic" : false,
1255       "isConstructor" : false,
1256       "isPrivate" : false,
1257       "memberOf" : "Roo.dd.DragDrop",
1258       "example" : "",
1259       "deprecated" : "",
1260       "since" : "",
1261       "see" : "",
1262       "params" : [
1263         {
1264           "name" : "id",
1265           "type" : "",
1266           "desc" : "the id of the linked element",
1267           "isOptional" : false
1268         },
1269         {
1270           "name" : "sGroup",
1271           "type" : "String",
1272           "desc" : "the group of related items",
1273           "isOptional" : false
1274         },
1275         {
1276           "name" : "config",
1277           "type" : "object",
1278           "desc" : "configuration attributes",
1279           "isOptional" : false
1280         }
1281       ],
1282       "returns" : [
1283       ]
1284     },
1285     {
1286       "name" : "addToGroup",
1287       "desc" : "Add this instance to a group of related drag/drop objects.  All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
1288       "isStatic" : false,
1289       "isConstructor" : false,
1290       "isPrivate" : false,
1291       "memberOf" : "Roo.dd.DragDrop",
1292       "example" : "",
1293       "deprecated" : "",
1294       "since" : "",
1295       "see" : "",
1296       "params" : [
1297         {
1298           "name" : "sGroup",
1299           "type" : "",
1300           "desc" : "{string} the name of the group",
1301           "isOptional" : false
1302         }
1303       ],
1304       "returns" : [
1305       ]
1306     },
1307     {
1308       "name" : "onDragOver",
1309       "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
1310       "isStatic" : false,
1311       "isConstructor" : false,
1312       "isPrivate" : false,
1313       "memberOf" : "Roo.dd.DragDrop",
1314       "example" : "",
1315       "deprecated" : "",
1316       "since" : "",
1317       "see" : "",
1318       "params" : [
1319         {
1320           "name" : "e",
1321           "type" : "Event",
1322           "desc" : "the mousemove event",
1323           "isOptional" : false
1324         },
1325         {
1326           "name" : "id",
1327           "type" : "String|DragDrop[]",
1328           "desc" : "In POINT mode, the element\nid this is hovering over.  In INTERSECT mode, an array of dd items\nbeing hovered over.",
1329           "isOptional" : false
1330         }
1331       ],
1332       "returns" : [
1333       ]
1334     },
1335     {
1336       "name" : "toString",
1337       "desc" : "toString method",
1338       "isStatic" : false,
1339       "isConstructor" : false,
1340       "isPrivate" : false,
1341       "memberOf" : "Roo.dd.DragDrop",
1342       "example" : "",
1343       "deprecated" : "",
1344       "since" : "",
1345       "see" : "",
1346       "params" : [
1347       ],
1348       "returns" : [
1349         {
1350           "name" : "",
1351           "type" : "string",
1352           "desc" : "string representation of the dd obj"
1353         }
1354       ]
1355     },
1356     {
1357       "name" : "setPadding",
1358       "desc" : "Configures the padding for the target zone in px.  Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
1359       "isStatic" : false,
1360       "isConstructor" : false,
1361       "isPrivate" : false,
1362       "memberOf" : "Roo.dd.DragDrop",
1363       "example" : "",
1364       "deprecated" : "",
1365       "since" : "",
1366       "see" : "",
1367       "params" : [
1368         {
1369           "name" : "iTop",
1370           "type" : "int",
1371           "desc" : "Top pad",
1372           "isOptional" : false
1373         },
1374         {
1375           "name" : "iRight",
1376           "type" : "int",
1377           "desc" : "Right pad",
1378           "isOptional" : false
1379         },
1380         {
1381           "name" : "iBot",
1382           "type" : "int",
1383           "desc" : "Bot pad",
1384           "isOptional" : false
1385         },
1386         {
1387           "name" : "iLeft",
1388           "type" : "int",
1389           "desc" : "Left pad",
1390           "isOptional" : false
1391         }
1392       ],
1393       "returns" : [
1394       ]
1395     },
1396     {
1397       "name" : "removeFromGroup",
1398       "desc" : "Remove's this instance from the supplied interaction group",
1399       "isStatic" : false,
1400       "isConstructor" : false,
1401       "isPrivate" : false,
1402       "memberOf" : "Roo.dd.DragDrop",
1403       "example" : "",
1404       "deprecated" : "",
1405       "since" : "",
1406       "see" : "",
1407       "params" : [
1408         {
1409           "name" : "sGroup",
1410           "type" : "string",
1411           "desc" : "The group to drop",
1412           "isOptional" : false
1413         }
1414       ],
1415       "returns" : [
1416       ]
1417     },
1418     {
1419       "name" : "addInvalidHandleClass",
1420       "desc" : "Lets you specify a css class of elements that will not initiate a drag",
1421       "isStatic" : false,
1422       "isConstructor" : false,
1423       "isPrivate" : false,
1424       "memberOf" : "Roo.dd.DragDrop",
1425       "example" : "",
1426       "deprecated" : "",
1427       "since" : "",
1428       "see" : "",
1429       "params" : [
1430         {
1431           "name" : "cssClass",
1432           "type" : "string",
1433           "desc" : "the class of the elements you wish to ignore",
1434           "isOptional" : false
1435         }
1436       ],
1437       "returns" : [
1438       ]
1439     },
1440     {
1441       "name" : "startDrag",
1442       "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
1443       "isStatic" : false,
1444       "isConstructor" : false,
1445       "isPrivate" : false,
1446       "memberOf" : "Roo.dd.DragDrop",
1447       "example" : "",
1448       "deprecated" : "",
1449       "since" : "",
1450       "see" : "",
1451       "params" : [
1452         {
1453           "name" : "X",
1454           "type" : "int",
1455           "desc" : "click location",
1456           "isOptional" : false
1457         },
1458         {
1459           "name" : "Y",
1460           "type" : "int",
1461           "desc" : "click location",
1462           "isOptional" : false
1463         }
1464       ],
1465       "returns" : [
1466       ]
1467     },
1468     {
1469       "name" : "padding",
1470       "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
1471       "isStatic" : false,
1472       "isConstructor" : false,
1473       "isPrivate" : false,
1474       "memberOf" : "Roo.dd.DragDrop",
1475       "example" : "",
1476       "deprecated" : "",
1477       "since" : "",
1478       "see" : "",
1479       "params" : [
1480       ],
1481       "returns" : [
1482       ]
1483     },
1484     {
1485       "name" : "resetConstraints",
1486       "desc" : "resetConstraints must be called if you manually reposition a dd element.",
1487       "isStatic" : false,
1488       "isConstructor" : false,
1489       "isPrivate" : false,
1490       "memberOf" : "Roo.dd.DragDrop",
1491       "example" : "",
1492       "deprecated" : "",
1493       "since" : "",
1494       "see" : "",
1495       "params" : [
1496         {
1497           "name" : "maintainOffset",
1498           "type" : "boolean",
1499           "desc" : "",
1500           "isOptional" : false
1501         }
1502       ],
1503       "returns" : [
1504       ]
1505     },
1506     {
1507       "name" : "clearTicks",
1508       "desc" : "Clears any tick interval defined for this instance",
1509       "isStatic" : false,
1510       "isConstructor" : false,
1511       "isPrivate" : false,
1512       "memberOf" : "Roo.dd.DragDrop",
1513       "example" : "",
1514       "deprecated" : "",
1515       "since" : "",
1516       "see" : "",
1517       "params" : [
1518       ],
1519       "returns" : [
1520       ]
1521     },
1522     {
1523       "name" : "isLocked",
1524       "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
1525       "isStatic" : false,
1526       "isConstructor" : false,
1527       "isPrivate" : false,
1528       "memberOf" : "Roo.dd.DragDrop",
1529       "example" : "",
1530       "deprecated" : "",
1531       "since" : "",
1532       "see" : "",
1533       "params" : [
1534       ],
1535       "returns" : [
1536         {
1537           "name" : "",
1538           "type" : "boolean",
1539           "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
1540         }
1541       ]
1542     },
1543     {
1544       "name" : "setXConstraint",
1545       "desc" : "By default, the element can be dragged any place on the screen.  Use\nthis method to limit the horizontal travel of the element.  Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
1546       "isStatic" : false,
1547       "isConstructor" : false,
1548       "isPrivate" : false,
1549       "memberOf" : "Roo.dd.DragDrop",
1550       "example" : "",
1551       "deprecated" : "",
1552       "since" : "",
1553       "see" : "",
1554       "params" : [
1555         {
1556           "name" : "iLeft",
1557           "type" : "int",
1558           "desc" : "the number of pixels the element can move to the left",
1559           "isOptional" : false
1560         },
1561         {
1562           "name" : "iRight",
1563           "type" : "int",
1564           "desc" : "the number of pixels the element can move to the\nright",
1565           "isOptional" : false
1566         },
1567         {
1568           "name" : "iTickSize",
1569           "type" : "int",
1570           "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
1571           "isOptional" : false
1572         }
1573       ],
1574       "returns" : [
1575       ]
1576     },
1577     {
1578       "name" : "isValidHandleChild",
1579       "desc" : "Checks the tag exclusion list to see if this click should be ignored",
1580       "isStatic" : false,
1581       "isConstructor" : false,
1582       "isPrivate" : false,
1583       "memberOf" : "Roo.dd.DragDrop",
1584       "example" : "",
1585       "deprecated" : "",
1586       "since" : "",
1587       "see" : "",
1588       "params" : [
1589         {
1590           "name" : "node",
1591           "type" : "HTMLElement",
1592           "desc" : "the HTMLElement to evaluate",
1593           "isOptional" : false
1594         }
1595       ],
1596       "returns" : [
1597         {
1598           "name" : "",
1599           "type" : "boolean",
1600           "desc" : "true if this is a valid tag type, false if not"
1601         }
1602       ]
1603     },
1604     {
1605       "name" : "purgeListeners",
1606       "desc" : "Removes all listeners for this object",
1607       "isStatic" : false,
1608       "isConstructor" : false,
1609       "isPrivate" : false,
1610       "memberOf" : "Roo.util.Observable",
1611       "example" : "",
1612       "deprecated" : "",
1613       "since" : "",
1614       "see" : "",
1615       "params" : [
1616       ],
1617       "returns" : [
1618       ]
1619     },
1620     {
1621       "name" : "on",
1622       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1623       "isStatic" : false,
1624       "isConstructor" : false,
1625       "isPrivate" : false,
1626       "memberOf" : "Roo.util.Observable",
1627       "example" : "",
1628       "deprecated" : "",
1629       "since" : "",
1630       "see" : "",
1631       "params" : [
1632         {
1633           "name" : "eventName",
1634           "type" : "String",
1635           "desc" : "The type of event to listen for",
1636           "isOptional" : false
1637         },
1638         {
1639           "name" : "handler",
1640           "type" : "Function",
1641           "desc" : "The method the event invokes",
1642           "isOptional" : false
1643         },
1644         {
1645           "name" : "scope",
1646           "type" : "Object",
1647           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1648           "isOptional" : false
1649         },
1650         {
1651           "name" : "options",
1652           "type" : "Object",
1653           "desc" : "(optional)",
1654           "isOptional" : false
1655         }
1656       ],
1657       "returns" : [
1658       ]
1659     },
1660     {
1661       "name" : "un",
1662       "desc" : "Removes a listener (shorthand for removeListener)",
1663       "isStatic" : false,
1664       "isConstructor" : false,
1665       "isPrivate" : false,
1666       "memberOf" : "Roo.util.Observable",
1667       "example" : "",
1668       "deprecated" : "",
1669       "since" : "",
1670       "see" : "",
1671       "params" : [
1672         {
1673           "name" : "eventName",
1674           "type" : "String",
1675           "desc" : "The type of event to listen for",
1676           "isOptional" : false
1677         },
1678         {
1679           "name" : "handler",
1680           "type" : "Function",
1681           "desc" : "The handler to remove",
1682           "isOptional" : false
1683         },
1684         {
1685           "name" : "scope",
1686           "type" : "Object",
1687           "desc" : "(optional) The scope (this object) for the handler",
1688           "isOptional" : false
1689         }
1690       ],
1691       "returns" : [
1692       ]
1693     },
1694     {
1695       "name" : "addEvents",
1696       "desc" : "Used to define events on this Observable",
1697       "isStatic" : false,
1698       "isConstructor" : false,
1699       "isPrivate" : false,
1700       "memberOf" : "Roo.util.Observable",
1701       "example" : "",
1702       "deprecated" : "",
1703       "since" : "",
1704       "see" : "",
1705       "params" : [
1706         {
1707           "name" : "object",
1708           "type" : "Object",
1709           "desc" : "The object with the events defined",
1710           "isOptional" : false
1711         }
1712       ],
1713       "returns" : [
1714       ]
1715     },
1716     {
1717       "name" : "releaseCapture",
1718       "desc" : "Removes <b>all</b> added captures from the Observable.",
1719       "isStatic" : true,
1720       "isConstructor" : false,
1721       "isPrivate" : false,
1722       "memberOf" : "Roo.util.Observable",
1723       "example" : "",
1724       "deprecated" : "",
1725       "since" : "",
1726       "see" : "",
1727       "params" : [
1728         {
1729           "name" : "o",
1730           "type" : "Observable",
1731           "desc" : "The Observable to release",
1732           "isOptional" : false
1733         }
1734       ],
1735       "returns" : [
1736       ]
1737     },
1738     {
1739       "name" : "removeListener",
1740       "desc" : "Removes a listener",
1741       "isStatic" : false,
1742       "isConstructor" : false,
1743       "isPrivate" : false,
1744       "memberOf" : "Roo.util.Observable",
1745       "example" : "",
1746       "deprecated" : "",
1747       "since" : "",
1748       "see" : "",
1749       "params" : [
1750         {
1751           "name" : "eventName",
1752           "type" : "String",
1753           "desc" : "The type of event to listen for",
1754           "isOptional" : false
1755         },
1756         {
1757           "name" : "handler",
1758           "type" : "Function",
1759           "desc" : "The handler to remove",
1760           "isOptional" : false
1761         },
1762         {
1763           "name" : "scope",
1764           "type" : "Object",
1765           "desc" : "(optional) The scope (this object) for the handler",
1766           "isOptional" : false
1767         }
1768       ],
1769       "returns" : [
1770       ]
1771     },
1772     {
1773       "name" : "fireEvent",
1774       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1775       "isStatic" : false,
1776       "isConstructor" : false,
1777       "isPrivate" : false,
1778       "memberOf" : "Roo.util.Observable",
1779       "example" : "",
1780       "deprecated" : "",
1781       "since" : "",
1782       "see" : "",
1783       "params" : [
1784         {
1785           "name" : "eventName",
1786           "type" : "String",
1787           "desc" : "",
1788           "isOptional" : false
1789         },
1790         {
1791           "name" : "args",
1792           "type" : "Object...",
1793           "desc" : "Variable number of parameters are passed to handlers",
1794           "isOptional" : false
1795         }
1796       ],
1797       "returns" : [
1798         {
1799           "name" : "",
1800           "type" : "Boolean",
1801           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1802         }
1803       ]
1804     },
1805     {
1806       "name" : "hasListener",
1807       "desc" : "Checks to see if this object has any listeners for a specified event",
1808       "isStatic" : false,
1809       "isConstructor" : false,
1810       "isPrivate" : false,
1811       "memberOf" : "Roo.util.Observable",
1812       "example" : "",
1813       "deprecated" : "",
1814       "since" : "",
1815       "see" : "",
1816       "params" : [
1817         {
1818           "name" : "eventName",
1819           "type" : "String",
1820           "desc" : "The name of the event to check for",
1821           "isOptional" : false
1822         }
1823       ],
1824       "returns" : [
1825         {
1826           "name" : "",
1827           "type" : "Boolean",
1828           "desc" : "True if the event is being listened for, else false"
1829         }
1830       ]
1831     },
1832     {
1833       "name" : "capture",
1834       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
1835       "isStatic" : true,
1836       "isConstructor" : false,
1837       "isPrivate" : false,
1838       "memberOf" : "Roo.util.Observable",
1839       "example" : "",
1840       "deprecated" : "",
1841       "since" : "",
1842       "see" : "",
1843       "params" : [
1844         {
1845           "name" : "o",
1846           "type" : "Observable",
1847           "desc" : "The Observable to capture",
1848           "isOptional" : false
1849         },
1850         {
1851           "name" : "fn",
1852           "type" : "Function",
1853           "desc" : "The function to call",
1854           "isOptional" : false
1855         },
1856         {
1857           "name" : "scope",
1858           "type" : "Object",
1859           "desc" : "(optional) The scope (this object) for the fn",
1860           "isOptional" : false
1861         }
1862       ],
1863       "returns" : [
1864       ]
1865     },
1866     {
1867       "name" : "addListener",
1868       "desc" : "Appends an event handler to this component",
1869       "isStatic" : false,
1870       "isConstructor" : false,
1871       "isPrivate" : false,
1872       "memberOf" : "Roo.util.Observable",
1873       "example" : "",
1874       "deprecated" : "",
1875       "since" : "",
1876       "see" : "",
1877       "params" : [
1878         {
1879           "name" : "eventName",
1880           "type" : "String",
1881           "desc" : "The type of event to listen for",
1882           "isOptional" : false
1883         },
1884         {
1885           "name" : "handler",
1886           "type" : "Function",
1887           "desc" : "The method the event invokes",
1888           "isOptional" : false
1889         },
1890         {
1891           "name" : "scope",
1892           "type" : "Object",
1893           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1894           "isOptional" : false
1895         },
1896         {
1897           "name" : "options",
1898           "type" : "Object",
1899           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
1900           "isOptional" : false
1901         }
1902       ],
1903       "returns" : [
1904       ]
1905     }
1906   ],
1907   "events" : [
1908   ]
1909 }