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