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

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