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

   1 {
   2   "name" : "Roo.dd.DragDrop",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "Defines the interface and base operation of items that that can be\ndragged or can be drop targets.  It was designed to be extended, overriding\nthe event handlers for startDrag, onDrag, onDragOver and onDragOut.\nUp to three html elements can be associated with a DragDrop instance:\n<ul>\n<li>linked element: the element that is passed into the constructor.\nThis is the element which defines the boundaries for interaction with\nother DragDrop objects.</li>\n<li>handle element(s): The drag operation only occurs if the element that\nwas clicked matches a handle element.  By default this is the linked\nelement, but there are times that you will want only a portion of the\nlinked element to initiate the drag operation, and the setHandleElId()\nmethod provides a way to define this.</li>\n<li>drag element: this represents the element that would be moved along\nwith the cursor during a drag operation.  By default, this is the linked\nelement itself as in {@link Roo.dd.DD}.  setDragElId() lets you define\na separate element that would be moved, as in {@link Roo.dd.DDProxy}.\n</li>\n</ul>\nThis class should not be instantiated until the onload event to ensure that\nthe associated elements are available.\nThe following would define a DragDrop obj that would interact with any\nother DragDrop obj in the \"group1\" group:\n<pre>\n dd = new Roo.dd.DragDrop(\"div1\", \"group1\");\n</pre>\nSince none of the event handlers have been implemented, nothing would\nactually happen if you were to run the code above.  Normally you would\noverride this class or one of the default implementations, but you can\nalso override the methods you want on an instance of the class...\n<pre>\n dd.onDragDrop = function(e, id) {\n &nbsp;&nbsp;alert(\"dd was dropped on \" + id);\n }\n</pre>",
   7   "isSingleton" : false,
   8   "isStatic" : true,
   9   "isBuiltin" : false,
  10   "config" : [
  11     {
  12       "name" : "listeners",
  13       "type" : "Object",
  14       "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>",
  15       "memberOf" : "Roo.util.Observable",
  16       "values" : [
  17       ]
  18     }
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "setHandleElId",
  23       "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.",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.dd.DragDrop",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33         {
  34           "name" : "id",
  35           "type" : "",
  36           "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
  37           "isOptional" : false
  38         }
  39       ],
  40       "returns" : [
  41       ]
  42     },
  43     {
  44       "name" : "init",
  45       "desc" : "Sets up the DragDrop object.  Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
  46       "isStatic" : false,
  47       "isConstructor" : false,
  48       "isPrivate" : false,
  49       "memberOf" : "Roo.dd.DragDrop",
  50       "example" : "",
  51       "deprecated" : "",
  52       "since" : "",
  53       "see" : "",
  54       "params" : [
  55         {
  56           "name" : "id",
  57           "type" : "",
  58           "desc" : "the id of the linked element",
  59           "isOptional" : false
  60         },
  61         {
  62           "name" : "sGroup",
  63           "type" : "String",
  64           "desc" : "the group of related items",
  65           "isOptional" : false
  66         },
  67         {
  68           "name" : "config",
  69           "type" : "object",
  70           "desc" : "configuration attributes",
  71           "isOptional" : false
  72         }
  73       ],
  74       "returns" : [
  75       ]
  76     },
  77     {
  78       "name" : "removeInvalidHandleType",
  79       "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
  80       "isStatic" : false,
  81       "isConstructor" : false,
  82       "isPrivate" : false,
  83       "memberOf" : "Roo.dd.DragDrop",
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "params" : [
  89         {
  90           "name" : "tagName",
  91           "type" : "string",
  92           "desc" : "the type of element to unexclude",
  93           "isOptional" : false
  94         }
  95       ],
  96       "returns" : [
  97       ]
  98     },
  99     {
 100       "name" : "unreg",
 101       "desc" : "Remove all drag and drop hooks for this element",
 102       "isStatic" : false,
 103       "isConstructor" : false,
 104       "isPrivate" : false,
 105       "memberOf" : "Roo.dd.DragDrop",
 106       "example" : "",
 107       "deprecated" : "",
 108       "since" : "",
 109       "see" : "",
 110       "params" : [
 111       ],
 112       "returns" : [
 113       ]
 114     },
 115     {
 116       "name" : "addInvalidHandleType",
 117       "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.",
 118       "isStatic" : false,
 119       "isConstructor" : false,
 120       "isPrivate" : false,
 121       "memberOf" : "Roo.dd.DragDrop",
 122       "example" : "",
 123       "deprecated" : "",
 124       "since" : "",
 125       "see" : "",
 126       "params" : [
 127         {
 128           "name" : "tagName",
 129           "type" : "string",
 130           "desc" : "the type of element to exclude",
 131           "isOptional" : false
 132         }
 133       ],
 134       "returns" : [
 135       ]
 136     },
 137     {
 138       "name" : "onDragDrop",
 139       "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
 140       "isStatic" : false,
 141       "isConstructor" : false,
 142       "isPrivate" : false,
 143       "memberOf" : "Roo.dd.DragDrop",
 144       "example" : "",
 145       "deprecated" : "",
 146       "since" : "",
 147       "see" : "",
 148       "params" : [
 149         {
 150           "name" : "e",
 151           "type" : "Event",
 152           "desc" : "the mouseup event",
 153           "isOptional" : false
 154         },
 155         {
 156           "name" : "id",
 157           "type" : "String|DragDrop[]",
 158           "desc" : "In POINT mode, the element\nid this was dropped on.  In INTERSECT mode, an array of dd items this\nwas dropped on.",
 159           "isOptional" : false
 160         }
 161       ],
 162       "returns" : [
 163       ]
 164     },
 165     {
 166       "name" : "removeInvalidHandleId",
 167       "desc" : "Unsets an invalid handle id",
 168       "isStatic" : false,
 169       "isConstructor" : false,
 170       "isPrivate" : false,
 171       "memberOf" : "Roo.dd.DragDrop",
 172       "example" : "",
 173       "deprecated" : "",
 174       "since" : "",
 175       "see" : "",
 176       "params" : [
 177         {
 178           "name" : "id",
 179           "type" : "string",
 180           "desc" : "the id of the element to re-enable",
 181           "isOptional" : false
 182         }
 183       ],
 184       "returns" : [
 185       ]
 186     },
 187     {
 188       "name" : "onAvailable",
 189       "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "memberOf" : "Roo.dd.DragDrop",
 194       "example" : "",
 195       "deprecated" : "",
 196       "since" : "",
 197       "see" : "",
 198       "params" : [
 199       ],
 200       "returns" : [
 201       ]
 202     },
 203     {
 204       "name" : "setOuterHandleElId",
 205       "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
 206       "isStatic" : false,
 207       "isConstructor" : false,
 208       "isPrivate" : false,
 209       "memberOf" : "Roo.dd.DragDrop",
 210       "example" : "",
 211       "deprecated" : "",
 212       "since" : "",
 213       "see" : "",
 214       "params" : [
 215         {
 216           "name" : "id",
 217           "type" : "",
 218           "desc" : "the id of the element that will be used to initiate the drag",
 219           "isOptional" : false
 220         }
 221       ],
 222       "returns" : [
 223       ]
 224     },
 225     {
 226       "name" : "onMouseUp",
 227       "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
 228       "isStatic" : false,
 229       "isConstructor" : false,
 230       "isPrivate" : false,
 231       "memberOf" : "Roo.dd.DragDrop",
 232       "example" : "",
 233       "deprecated" : "",
 234       "since" : "",
 235       "see" : "",
 236       "params" : [
 237         {
 238           "name" : "e",
 239           "type" : "Event",
 240           "desc" : "the mouseup event",
 241           "isOptional" : false
 242         }
 243       ],
 244       "returns" : [
 245       ]
 246     },
 247     {
 248       "name" : "getDragEl",
 249       "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",
 250       "isStatic" : false,
 251       "isConstructor" : false,
 252       "isPrivate" : false,
 253       "memberOf" : "Roo.dd.DragDrop",
 254       "example" : "",
 255       "deprecated" : "",
 256       "since" : "",
 257       "see" : "",
 258       "params" : [
 259       ],
 260       "returns" : [
 261         {
 262           "name" : "",
 263           "type" : "HTMLElement",
 264           "desc" : "the html element"
 265         }
 266       ]
 267     },
 268     {
 269       "name" : "setYConstraint",
 270       "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.",
 271       "isStatic" : false,
 272       "isConstructor" : false,
 273       "isPrivate" : false,
 274       "memberOf" : "Roo.dd.DragDrop",
 275       "example" : "",
 276       "deprecated" : "",
 277       "since" : "",
 278       "see" : "",
 279       "params" : [
 280         {
 281           "name" : "iUp",
 282           "type" : "int",
 283           "desc" : "the number of pixels the element can move up",
 284           "isOptional" : false
 285         },
 286         {
 287           "name" : "iDown",
 288           "type" : "int",
 289           "desc" : "the number of pixels the element can move down",
 290           "isOptional" : false
 291         },
 292         {
 293           "name" : "iTickSize",
 294           "type" : "int",
 295           "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
 296           "isOptional" : false
 297         }
 298       ],
 299       "returns" : [
 300       ]
 301     },
 302     {
 303       "name" : "clearConstraints",
 304       "desc" : "Clears any constraints applied to this instance.  Also clears ticks\nsince they can't exist independent of a constraint at this time.",
 305       "isStatic" : false,
 306       "isConstructor" : false,
 307       "isPrivate" : false,
 308       "memberOf" : "Roo.dd.DragDrop",
 309       "example" : "",
 310       "deprecated" : "",
 311       "since" : "",
 312       "see" : "",
 313       "params" : [
 314       ],
 315       "returns" : [
 316       ]
 317     },
 318     {
 319       "name" : "onInvalidDrop",
 320       "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
 321       "isStatic" : false,
 322       "isConstructor" : false,
 323       "isPrivate" : false,
 324       "memberOf" : "Roo.dd.DragDrop",
 325       "example" : "",
 326       "deprecated" : "",
 327       "since" : "",
 328       "see" : "",
 329       "params" : [
 330         {
 331           "name" : "e",
 332           "type" : "Event",
 333           "desc" : "the mouseup event",
 334           "isOptional" : false
 335         }
 336       ],
 337       "returns" : [
 338       ]
 339     },
 340     {
 341       "name" : "addInvalidHandleId",
 342       "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
 343       "isStatic" : false,
 344       "isConstructor" : false,
 345       "isPrivate" : false,
 346       "memberOf" : "Roo.dd.DragDrop",
 347       "example" : "",
 348       "deprecated" : "",
 349       "since" : "",
 350       "see" : "",
 351       "params" : [
 352         {
 353           "name" : "id",
 354           "type" : "string",
 355           "desc" : "the element id of the element you wish to ignore",
 356           "isOptional" : false
 357         }
 358       ],
 359       "returns" : [
 360       ]
 361     },
 362     {
 363       "name" : "removeInvalidHandleClass",
 364       "desc" : "Unsets an invalid css class",
 365       "isStatic" : false,
 366       "isConstructor" : false,
 367       "isPrivate" : false,
 368       "memberOf" : "Roo.dd.DragDrop",
 369       "example" : "",
 370       "deprecated" : "",
 371       "since" : "",
 372       "see" : "",
 373       "params" : [
 374         {
 375           "name" : "cssClass",
 376           "type" : "string",
 377           "desc" : "the class of the element(s) you wish to\nre-enable",
 378           "isOptional" : false
 379         }
 380       ],
 381       "returns" : [
 382       ]
 383     },
 384     {
 385       "name" : "onDragOut",
 386       "desc" : "Abstract method called when we are no longer hovering over an element",
 387       "isStatic" : false,
 388       "isConstructor" : false,
 389       "isPrivate" : false,
 390       "memberOf" : "Roo.dd.DragDrop",
 391       "example" : "",
 392       "deprecated" : "",
 393       "since" : "",
 394       "see" : "",
 395       "params" : [
 396         {
 397           "name" : "e",
 398           "type" : "Event",
 399           "desc" : "the mousemove event",
 400           "isOptional" : false
 401         },
 402         {
 403           "name" : "id",
 404           "type" : "String|DragDrop[]",
 405           "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.",
 406           "isOptional" : false
 407         }
 408       ],
 409       "returns" : [
 410       ]
 411     },
 412     {
 413       "name" : "setDragElId",
 414       "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
 415       "isStatic" : false,
 416       "isConstructor" : false,
 417       "isPrivate" : false,
 418       "memberOf" : "Roo.dd.DragDrop",
 419       "example" : "",
 420       "deprecated" : "",
 421       "since" : "",
 422       "see" : "",
 423       "params" : [
 424         {
 425           "name" : "id",
 426           "type" : "",
 427           "desc" : "{string} the id of the element that will be used to initiate the drag",
 428           "isOptional" : false
 429         }
 430       ],
 431       "returns" : [
 432       ]
 433     },
 434     {
 435       "name" : "endDrag",
 436       "desc" : "Fired when we are done dragging the object",
 437       "isStatic" : false,
 438       "isConstructor" : false,
 439       "isPrivate" : false,
 440       "memberOf" : "Roo.dd.DragDrop",
 441       "example" : "",
 442       "deprecated" : "",
 443       "since" : "",
 444       "see" : "",
 445       "params" : [
 446         {
 447           "name" : "e",
 448           "type" : "Event",
 449           "desc" : "the mouseup event",
 450           "isOptional" : false
 451         }
 452       ],
 453       "returns" : [
 454       ]
 455     },
 456     {
 457       "name" : "getEl",
 458       "desc" : "Returns a reference to the linked element",
 459       "isStatic" : false,
 460       "isConstructor" : false,
 461       "isPrivate" : false,
 462       "memberOf" : "Roo.dd.DragDrop",
 463       "example" : "",
 464       "deprecated" : "",
 465       "since" : "",
 466       "see" : "",
 467       "params" : [
 468       ],
 469       "returns" : [
 470         {
 471           "name" : "",
 472           "type" : "HTMLElement",
 473           "desc" : "the html element"
 474         }
 475       ]
 476     },
 477     {
 478       "name" : "onDrag",
 479       "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
 480       "isStatic" : false,
 481       "isConstructor" : false,
 482       "isPrivate" : false,
 483       "memberOf" : "Roo.dd.DragDrop",
 484       "example" : "",
 485       "deprecated" : "",
 486       "since" : "",
 487       "see" : "",
 488       "params" : [
 489         {
 490           "name" : "e",
 491           "type" : "Event",
 492           "desc" : "the mousemove event",
 493           "isOptional" : false
 494         }
 495       ],
 496       "returns" : [
 497       ]
 498     },
 499     {
 500       "name" : "onDragEnter",
 501       "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
 502       "isStatic" : false,
 503       "isConstructor" : false,
 504       "isPrivate" : false,
 505       "memberOf" : "Roo.dd.DragDrop",
 506       "example" : "",
 507       "deprecated" : "",
 508       "since" : "",
 509       "see" : "",
 510       "params" : [
 511         {
 512           "name" : "e",
 513           "type" : "Event",
 514           "desc" : "the mousemove event",
 515           "isOptional" : false
 516         },
 517         {
 518           "name" : "id",
 519           "type" : "String|DragDrop[]",
 520           "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.",
 521           "isOptional" : false
 522         }
 523       ],
 524       "returns" : [
 525       ]
 526     },
 527     {
 528       "name" : "lock",
 529       "desc" : "Lock this instance",
 530       "isStatic" : false,
 531       "isConstructor" : false,
 532       "isPrivate" : false,
 533       "memberOf" : "Roo.dd.DragDrop",
 534       "example" : "",
 535       "deprecated" : "",
 536       "since" : "",
 537       "see" : "",
 538       "params" : [
 539       ],
 540       "returns" : [
 541       ]
 542     },
 543     {
 544       "name" : "onMouseDown",
 545       "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
 546       "isStatic" : false,
 547       "isConstructor" : false,
 548       "isPrivate" : false,
 549       "memberOf" : "Roo.dd.DragDrop",
 550       "example" : "",
 551       "deprecated" : "",
 552       "since" : "",
 553       "see" : "",
 554       "params" : [
 555         {
 556           "name" : "e",
 557           "type" : "Event",
 558           "desc" : "the mousedown event",
 559           "isOptional" : false
 560         }
 561       ],
 562       "returns" : [
 563       ]
 564     },
 565     {
 566       "name" : "applyConfig",
 567       "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.",
 568       "isStatic" : false,
 569       "isConstructor" : false,
 570       "isPrivate" : false,
 571       "memberOf" : "Roo.dd.DragDrop",
 572       "example" : "",
 573       "deprecated" : "",
 574       "since" : "",
 575       "see" : "",
 576       "params" : [
 577       ],
 578       "returns" : [
 579       ]
 580     },
 581     {
 582       "name" : "unlock",
 583       "desc" : "Unlock this instace",
 584       "isStatic" : false,
 585       "isConstructor" : false,
 586       "isPrivate" : false,
 587       "memberOf" : "Roo.dd.DragDrop",
 588       "example" : "",
 589       "deprecated" : "",
 590       "since" : "",
 591       "see" : "",
 592       "params" : [
 593       ],
 594       "returns" : [
 595       ]
 596     },
 597     {
 598       "name" : "isTarget",
 599       "desc" : "By default, all insances can be a drop target.  This can be disabled by\nsetting isTarget to false.",
 600       "isStatic" : false,
 601       "isConstructor" : false,
 602       "isPrivate" : false,
 603       "memberOf" : "Roo.dd.DragDrop",
 604       "example" : "",
 605       "deprecated" : "",
 606       "since" : "",
 607       "see" : "",
 608       "params" : [
 609       ],
 610       "returns" : [
 611       ]
 612     },
 613     {
 614       "name" : "setInitPosition",
 615       "desc" : "Stores the initial placement of the linked element.",
 616       "isStatic" : false,
 617       "isConstructor" : false,
 618       "isPrivate" : false,
 619       "memberOf" : "Roo.dd.DragDrop",
 620       "example" : "",
 621       "deprecated" : "",
 622       "since" : "",
 623       "see" : "",
 624       "params" : [
 625         {
 626           "name" : "diffX",
 627           "type" : "int",
 628           "desc" : "the X offset, default 0",
 629           "isOptional" : false
 630         },
 631         {
 632           "name" : "diffY",
 633           "type" : "int",
 634           "desc" : "the Y offset, default 0",
 635           "isOptional" : false
 636         }
 637       ],
 638       "returns" : [
 639       ]
 640     },
 641     {
 642       "name" : "initTarget",
 643       "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "memberOf" : "Roo.dd.DragDrop",
 648       "example" : "",
 649       "deprecated" : "",
 650       "since" : "",
 651       "see" : "",
 652       "params" : [
 653         {
 654           "name" : "id",
 655           "type" : "",
 656           "desc" : "the id of the linked element",
 657           "isOptional" : false
 658         },
 659         {
 660           "name" : "sGroup",
 661           "type" : "String",
 662           "desc" : "the group of related items",
 663           "isOptional" : false
 664         },
 665         {
 666           "name" : "config",
 667           "type" : "object",
 668           "desc" : "configuration attributes",
 669           "isOptional" : false
 670         }
 671       ],
 672       "returns" : [
 673       ]
 674     },
 675     {
 676       "name" : "addToGroup",
 677       "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.",
 678       "isStatic" : false,
 679       "isConstructor" : false,
 680       "isPrivate" : false,
 681       "memberOf" : "Roo.dd.DragDrop",
 682       "example" : "",
 683       "deprecated" : "",
 684       "since" : "",
 685       "see" : "",
 686       "params" : [
 687         {
 688           "name" : "sGroup",
 689           "type" : "",
 690           "desc" : "{string} the name of the group",
 691           "isOptional" : false
 692         }
 693       ],
 694       "returns" : [
 695       ]
 696     },
 697     {
 698       "name" : "onDragOver",
 699       "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
 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" : "e",
 711           "type" : "Event",
 712           "desc" : "the mousemove event",
 713           "isOptional" : false
 714         },
 715         {
 716           "name" : "id",
 717           "type" : "String|DragDrop[]",
 718           "desc" : "In POINT mode, the element\nid this is hovering over.  In INTERSECT mode, an array of dd items\nbeing hovered over.",
 719           "isOptional" : false
 720         }
 721       ],
 722       "returns" : [
 723       ]
 724     },
 725     {
 726       "name" : "toString",
 727       "desc" : "toString method",
 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       "returns" : [
 739         {
 740           "name" : "",
 741           "type" : "string",
 742           "desc" : "string representation of the dd obj"
 743         }
 744       ]
 745     },
 746     {
 747       "name" : "setPadding",
 748       "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.",
 749       "isStatic" : false,
 750       "isConstructor" : false,
 751       "isPrivate" : false,
 752       "memberOf" : "Roo.dd.DragDrop",
 753       "example" : "",
 754       "deprecated" : "",
 755       "since" : "",
 756       "see" : "",
 757       "params" : [
 758         {
 759           "name" : "iTop",
 760           "type" : "int",
 761           "desc" : "Top pad",
 762           "isOptional" : false
 763         },
 764         {
 765           "name" : "iRight",
 766           "type" : "int",
 767           "desc" : "Right pad",
 768           "isOptional" : false
 769         },
 770         {
 771           "name" : "iBot",
 772           "type" : "int",
 773           "desc" : "Bot pad",
 774           "isOptional" : false
 775         },
 776         {
 777           "name" : "iLeft",
 778           "type" : "int",
 779           "desc" : "Left pad",
 780           "isOptional" : false
 781         }
 782       ],
 783       "returns" : [
 784       ]
 785     },
 786     {
 787       "name" : "removeFromGroup",
 788       "desc" : "Remove's this instance from the supplied interaction group",
 789       "isStatic" : false,
 790       "isConstructor" : false,
 791       "isPrivate" : false,
 792       "memberOf" : "Roo.dd.DragDrop",
 793       "example" : "",
 794       "deprecated" : "",
 795       "since" : "",
 796       "see" : "",
 797       "params" : [
 798         {
 799           "name" : "sGroup",
 800           "type" : "string",
 801           "desc" : "The group to drop",
 802           "isOptional" : false
 803         }
 804       ],
 805       "returns" : [
 806       ]
 807     },
 808     {
 809       "name" : "addInvalidHandleClass",
 810       "desc" : "Lets you specify a css class of elements that will not initiate a drag",
 811       "isStatic" : false,
 812       "isConstructor" : false,
 813       "isPrivate" : false,
 814       "memberOf" : "Roo.dd.DragDrop",
 815       "example" : "",
 816       "deprecated" : "",
 817       "since" : "",
 818       "see" : "",
 819       "params" : [
 820         {
 821           "name" : "cssClass",
 822           "type" : "string",
 823           "desc" : "the class of the elements you wish to ignore",
 824           "isOptional" : false
 825         }
 826       ],
 827       "returns" : [
 828       ]
 829     },
 830     {
 831       "name" : "startDrag",
 832       "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
 833       "isStatic" : false,
 834       "isConstructor" : false,
 835       "isPrivate" : false,
 836       "memberOf" : "Roo.dd.DragDrop",
 837       "example" : "",
 838       "deprecated" : "",
 839       "since" : "",
 840       "see" : "",
 841       "params" : [
 842         {
 843           "name" : "X",
 844           "type" : "int",
 845           "desc" : "click location",
 846           "isOptional" : false
 847         },
 848         {
 849           "name" : "Y",
 850           "type" : "int",
 851           "desc" : "click location",
 852           "isOptional" : false
 853         }
 854       ],
 855       "returns" : [
 856       ]
 857     },
 858     {
 859       "name" : "padding",
 860       "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
 861       "isStatic" : false,
 862       "isConstructor" : false,
 863       "isPrivate" : false,
 864       "memberOf" : "Roo.dd.DragDrop",
 865       "example" : "",
 866       "deprecated" : "",
 867       "since" : "",
 868       "see" : "",
 869       "params" : [
 870       ],
 871       "returns" : [
 872       ]
 873     },
 874     {
 875       "name" : "resetConstraints",
 876       "desc" : "resetConstraints must be called if you manually reposition a dd element.",
 877       "isStatic" : false,
 878       "isConstructor" : false,
 879       "isPrivate" : false,
 880       "memberOf" : "Roo.dd.DragDrop",
 881       "example" : "",
 882       "deprecated" : "",
 883       "since" : "",
 884       "see" : "",
 885       "params" : [
 886         {
 887           "name" : "maintainOffset",
 888           "type" : "boolean",
 889           "desc" : "",
 890           "isOptional" : false
 891         }
 892       ],
 893       "returns" : [
 894       ]
 895     },
 896     {
 897       "name" : "clearTicks",
 898       "desc" : "Clears any tick interval defined for this instance",
 899       "isStatic" : false,
 900       "isConstructor" : false,
 901       "isPrivate" : false,
 902       "memberOf" : "Roo.dd.DragDrop",
 903       "example" : "",
 904       "deprecated" : "",
 905       "since" : "",
 906       "see" : "",
 907       "params" : [
 908       ],
 909       "returns" : [
 910       ]
 911     },
 912     {
 913       "name" : "isLocked",
 914       "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.)",
 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           "name" : "",
 928           "type" : "boolean",
 929           "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
 930         }
 931       ]
 932     },
 933     {
 934       "name" : "setXConstraint",
 935       "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.",
 936       "isStatic" : false,
 937       "isConstructor" : false,
 938       "isPrivate" : false,
 939       "memberOf" : "Roo.dd.DragDrop",
 940       "example" : "",
 941       "deprecated" : "",
 942       "since" : "",
 943       "see" : "",
 944       "params" : [
 945         {
 946           "name" : "iLeft",
 947           "type" : "int",
 948           "desc" : "the number of pixels the element can move to the left",
 949           "isOptional" : false
 950         },
 951         {
 952           "name" : "iRight",
 953           "type" : "int",
 954           "desc" : "the number of pixels the element can move to the\nright",
 955           "isOptional" : false
 956         },
 957         {
 958           "name" : "iTickSize",
 959           "type" : "int",
 960           "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
 961           "isOptional" : false
 962         }
 963       ],
 964       "returns" : [
 965       ]
 966     },
 967     {
 968       "name" : "isValidHandleChild",
 969       "desc" : "Checks the tag exclusion list to see if this click should be ignored",
 970       "isStatic" : false,
 971       "isConstructor" : false,
 972       "isPrivate" : false,
 973       "memberOf" : "Roo.dd.DragDrop",
 974       "example" : "",
 975       "deprecated" : "",
 976       "since" : "",
 977       "see" : "",
 978       "params" : [
 979         {
 980           "name" : "node",
 981           "type" : "HTMLElement",
 982           "desc" : "the HTMLElement to evaluate",
 983           "isOptional" : false
 984         }
 985       ],
 986       "returns" : [
 987         {
 988           "name" : "",
 989           "type" : "boolean",
 990           "desc" : "true if this is a valid tag type, false if not"
 991         }
 992       ]
 993     },
 994     {
 995       "name" : "purgeListeners",
 996       "desc" : "Removes all listeners for this object",
 997       "isStatic" : false,
 998       "isConstructor" : false,
 999       "isPrivate" : false,
1000       "memberOf" : "Roo.util.Observable",
1001       "example" : "",
1002       "deprecated" : "",
1003       "since" : "",
1004       "see" : "",
1005       "params" : [
1006       ],
1007       "returns" : [
1008       ]
1009     },
1010     {
1011       "name" : "on",
1012       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1013       "isStatic" : false,
1014       "isConstructor" : false,
1015       "isPrivate" : false,
1016       "memberOf" : "Roo.util.Observable",
1017       "example" : "",
1018       "deprecated" : "",
1019       "since" : "",
1020       "see" : "",
1021       "params" : [
1022         {
1023           "name" : "eventName",
1024           "type" : "String",
1025           "desc" : "The type of event to listen for",
1026           "isOptional" : false
1027         },
1028         {
1029           "name" : "handler",
1030           "type" : "Function",
1031           "desc" : "The method the event invokes",
1032           "isOptional" : false
1033         },
1034         {
1035           "name" : "scope",
1036           "type" : "Object",
1037           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1038           "isOptional" : false
1039         },
1040         {
1041           "name" : "options",
1042           "type" : "Object",
1043           "desc" : "(optional)",
1044           "isOptional" : false
1045         }
1046       ],
1047       "returns" : [
1048       ]
1049     },
1050     {
1051       "name" : "un",
1052       "desc" : "Removes a listener (shorthand for removeListener)",
1053       "isStatic" : false,
1054       "isConstructor" : false,
1055       "isPrivate" : false,
1056       "memberOf" : "Roo.util.Observable",
1057       "example" : "",
1058       "deprecated" : "",
1059       "since" : "",
1060       "see" : "",
1061       "params" : [
1062         {
1063           "name" : "eventName",
1064           "type" : "String",
1065           "desc" : "The type of event to listen for",
1066           "isOptional" : false
1067         },
1068         {
1069           "name" : "handler",
1070           "type" : "Function",
1071           "desc" : "The handler to remove",
1072           "isOptional" : false
1073         },
1074         {
1075           "name" : "scope",
1076           "type" : "Object",
1077           "desc" : "(optional) The scope (this object) for the handler",
1078           "isOptional" : false
1079         }
1080       ],
1081       "returns" : [
1082       ]
1083     },
1084     {
1085       "name" : "addEvents",
1086       "desc" : "Used to define events on this Observable",
1087       "isStatic" : false,
1088       "isConstructor" : false,
1089       "isPrivate" : false,
1090       "memberOf" : "Roo.util.Observable",
1091       "example" : "",
1092       "deprecated" : "",
1093       "since" : "",
1094       "see" : "",
1095       "params" : [
1096         {
1097           "name" : "object",
1098           "type" : "Object",
1099           "desc" : "The object with the events defined",
1100           "isOptional" : false
1101         }
1102       ],
1103       "returns" : [
1104       ]
1105     },
1106     {
1107       "name" : "releaseCapture",
1108       "desc" : "Removes <b>all</b> added captures from the Observable.",
1109       "isStatic" : true,
1110       "isConstructor" : false,
1111       "isPrivate" : false,
1112       "memberOf" : "Roo.util.Observable",
1113       "example" : "",
1114       "deprecated" : "",
1115       "since" : "",
1116       "see" : "",
1117       "params" : [
1118         {
1119           "name" : "o",
1120           "type" : "Observable",
1121           "desc" : "The Observable to release",
1122           "isOptional" : false
1123         }
1124       ],
1125       "returns" : [
1126       ]
1127     },
1128     {
1129       "name" : "removeListener",
1130       "desc" : "Removes a listener",
1131       "isStatic" : false,
1132       "isConstructor" : false,
1133       "isPrivate" : false,
1134       "memberOf" : "Roo.util.Observable",
1135       "example" : "",
1136       "deprecated" : "",
1137       "since" : "",
1138       "see" : "",
1139       "params" : [
1140         {
1141           "name" : "eventName",
1142           "type" : "String",
1143           "desc" : "The type of event to listen for",
1144           "isOptional" : false
1145         },
1146         {
1147           "name" : "handler",
1148           "type" : "Function",
1149           "desc" : "The handler to remove",
1150           "isOptional" : false
1151         },
1152         {
1153           "name" : "scope",
1154           "type" : "Object",
1155           "desc" : "(optional) The scope (this object) for the handler",
1156           "isOptional" : false
1157         }
1158       ],
1159       "returns" : [
1160       ]
1161     },
1162     {
1163       "name" : "fireEvent",
1164       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1165       "isStatic" : false,
1166       "isConstructor" : false,
1167       "isPrivate" : false,
1168       "memberOf" : "Roo.util.Observable",
1169       "example" : "",
1170       "deprecated" : "",
1171       "since" : "",
1172       "see" : "",
1173       "params" : [
1174         {
1175           "name" : "eventName",
1176           "type" : "String",
1177           "desc" : "",
1178           "isOptional" : false
1179         },
1180         {
1181           "name" : "args",
1182           "type" : "Object...",
1183           "desc" : "Variable number of parameters are passed to handlers",
1184           "isOptional" : false
1185         }
1186       ],
1187       "returns" : [
1188         {
1189           "name" : "",
1190           "type" : "Boolean",
1191           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1192         }
1193       ]
1194     },
1195     {
1196       "name" : "hasListener",
1197       "desc" : "Checks to see if this object has any listeners for a specified event",
1198       "isStatic" : false,
1199       "isConstructor" : false,
1200       "isPrivate" : false,
1201       "memberOf" : "Roo.util.Observable",
1202       "example" : "",
1203       "deprecated" : "",
1204       "since" : "",
1205       "see" : "",
1206       "params" : [
1207         {
1208           "name" : "eventName",
1209           "type" : "String",
1210           "desc" : "The name of the event to check for",
1211           "isOptional" : false
1212         }
1213       ],
1214       "returns" : [
1215         {
1216           "name" : "",
1217           "type" : "Boolean",
1218           "desc" : "True if the event is being listened for, else false"
1219         }
1220       ]
1221     },
1222     {
1223       "name" : "capture",
1224       "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.",
1225       "isStatic" : true,
1226       "isConstructor" : false,
1227       "isPrivate" : false,
1228       "memberOf" : "Roo.util.Observable",
1229       "example" : "",
1230       "deprecated" : "",
1231       "since" : "",
1232       "see" : "",
1233       "params" : [
1234         {
1235           "name" : "o",
1236           "type" : "Observable",
1237           "desc" : "The Observable to capture",
1238           "isOptional" : false
1239         },
1240         {
1241           "name" : "fn",
1242           "type" : "Function",
1243           "desc" : "The function to call",
1244           "isOptional" : false
1245         },
1246         {
1247           "name" : "scope",
1248           "type" : "Object",
1249           "desc" : "(optional) The scope (this object) for the fn",
1250           "isOptional" : false
1251         }
1252       ],
1253       "returns" : [
1254       ]
1255     },
1256     {
1257       "name" : "addListener",
1258       "desc" : "Appends an event handler to this component",
1259       "isStatic" : false,
1260       "isConstructor" : false,
1261       "isPrivate" : false,
1262       "memberOf" : "Roo.util.Observable",
1263       "example" : "",
1264       "deprecated" : "",
1265       "since" : "",
1266       "see" : "",
1267       "params" : [
1268         {
1269           "name" : "eventName",
1270           "type" : "String",
1271           "desc" : "The type of event to listen for",
1272           "isOptional" : false
1273         },
1274         {
1275           "name" : "handler",
1276           "type" : "Function",
1277           "desc" : "The method the event invokes",
1278           "isOptional" : false
1279         },
1280         {
1281           "name" : "scope",
1282           "type" : "Object",
1283           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1284           "isOptional" : false
1285         },
1286         {
1287           "name" : "options",
1288           "type" : "Object",
1289           "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>",
1290           "isOptional" : false
1291         }
1292       ],
1293       "returns" : [
1294       ]
1295     }
1296   ],
1297   "events" : [
1298   ]
1299 }