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

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