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

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