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

   1 {
   2   "name" : "Roo.BoxComponent",
   3   "augments" : [
   4     "Roo.Component",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {
   8     "Roo.form.Field" : [
   9       "Roo.form.Checkbox",
  10       "Roo.form.DayPicker",
  11       "Roo.form.DisplayField",
  12       "Roo.form.GridField",
  13       "Roo.form.HtmlEditor",
  14       "Roo.form.Signature",
  15       "Roo.form.TextField"
  16     ],
  17     "Roo.form.TextArea" : [
  18       "Roo.form.FCKeditor"
  19     ],
  20     "Roo.BoxComponent" : [
  21       "Roo.form.ComboBoxArray.Item",
  22       "Roo.form.Field",
  23       "Roo.form.TextItem"
  24     ],
  25     "Roo.form.Checkbox" : [
  26       "Roo.form.Radio"
  27     ],
  28     "Roo.form.TextField" : [
  29       "Roo.form.ComboBoxArray",
  30       "Roo.form.Hidden",
  31       "Roo.form.NumberField",
  32       "Roo.form.TextArea",
  33       "Roo.form.TriggerField"
  34     ],
  35     "Roo.form.TriggerField" : [
  36       "Roo.form.ComboBox",
  37       "Roo.form.DateField",
  38       "Roo.form.MonthField",
  39       "Roo.form.Select"
  40     ],
  41     "Roo.form.ComboBox" : [
  42       "Roo.form.ComboCheck",
  43       "Roo.form.ComboNested"
  44     ]
  45   },
  46   "tree_children" : [],
  47   "tree_parent" : [],
  48   "desc" : "Base class for any visual {@link Roo.Component} that uses a box container.  BoxComponent provides automatic box\nmodel adjustments for sizing and positioning and will work correctly withnin the Component rendering model.  All\ncontainer classes should subclass BoxComponent so that they will work consistently when nested within other Roo\nlayout containers.",
  49   "isSingleton" : false,
  50   "isStatic" : false,
  51   "isBuiltin" : false,
  52   "isAbstract" : false,
  53   "isBuilderTop" : false,
  54   "memberOf" : "BoxComponent",
  55   "example" : "",
  56   "deprecated" : "",
  57   "since" : "",
  58   "see" : "",
  59   "params" : [
  60     {
  61       "name" : "config",
  62       "type" : "Roo.Element/String/Object",
  63       "desc" : "The configuration options.",
  64       "isOptional" : false
  65     }
  66   ],
  67   "returns" : [],
  68   "throws" : "",
  69   "requires" : "",
  70   "config" : [
  71     {
  72       "name" : "listeners",
  73       "type" : "Object",
  74       "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>",
  75       "memberOf" : "Roo.util.Observable"
  76     },
  77     {
  78       "name" : "hideMode",
  79       "type" : "String",
  80       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
  81       "memberOf" : "Roo.Component"
  82     },
  83     {
  84       "name" : "allowDomMove",
  85       "type" : "Boolean",
  86       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
  87       "memberOf" : "Roo.Component"
  88     },
  89     {
  90       "name" : "actionMode",
  91       "type" : "String",
  92       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
  93       "memberOf" : "Roo.Component"
  94     },
  95     {
  96       "name" : "width",
  97       "type" : "Number",
  98       "desc" : "width (optional) size of component",
  99       "memberOf" : "Roo.BoxComponent"
 100     },
 101     {
 102       "name" : "height",
 103       "type" : "Number",
 104       "desc" : "height (optional) size of component",
 105       "memberOf" : "Roo.BoxComponent"
 106     },
 107     {
 108       "name" : "disableClass",
 109       "type" : "String",
 110       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 111       "memberOf" : "Roo.Component"
 112     }
 113   ],
 114   "methods" : [
 115     {
 116       "name" : "updateBox",
 117       "type" : "function",
 118       "desc" : "Sets the current box measurements of the component's underlying element.",
 119       "sig" : "(box)",
 120       "static" : false,
 121       "memberOf" : "",
 122       "isStatic" : false,
 123       "isConstructor" : false,
 124       "isPrivate" : false,
 125       "example" : "",
 126       "deprecated" : "",
 127       "since" : "",
 128       "see" : "",
 129       "exceptions" : "",
 130       "requires" : "",
 131       "params" : [
 132         {
 133           "name" : "box",
 134           "type" : "Object",
 135           "desc" : "An object in the format {x, y, width, height}",
 136           "isOptional" : false
 137         }
 138       ],
 139       "returns" : []
 140     },
 141     {
 142       "name" : "setPagePosition",
 143       "type" : "function",
 144       "desc" : "Sets the page XY position of the component.  To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
 145       "sig" : "(x, y)",
 146       "static" : false,
 147       "memberOf" : "",
 148       "isStatic" : false,
 149       "isConstructor" : false,
 150       "isPrivate" : false,
 151       "example" : "",
 152       "deprecated" : "",
 153       "since" : "",
 154       "see" : "",
 155       "exceptions" : "",
 156       "requires" : "",
 157       "params" : [
 158         {
 159           "name" : "x",
 160           "type" : "Number",
 161           "desc" : "The new x position",
 162           "isOptional" : false
 163         },
 164         {
 165           "name" : "y",
 166           "type" : "Number",
 167           "desc" : "The new y position",
 168           "isOptional" : false
 169         }
 170       ],
 171       "returns" : []
 172     },
 173     {
 174       "name" : "syncSize",
 175       "type" : "function",
 176       "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
 177       "sig" : "()\n{\n\n}",
 178       "static" : false,
 179       "memberOf" : "",
 180       "isStatic" : false,
 181       "isConstructor" : false,
 182       "isPrivate" : false,
 183       "example" : "",
 184       "deprecated" : "",
 185       "since" : "",
 186       "see" : "",
 187       "exceptions" : "",
 188       "requires" : "",
 189       "params" : [],
 190       "returns" : []
 191     },
 192     {
 193       "name" : "setSize",
 194       "type" : "function",
 195       "desc" : "Sets the width and height of the component.  This method fires the resize event.  This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
 196       "sig" : "(width, height)",
 197       "static" : false,
 198       "memberOf" : "",
 199       "isStatic" : false,
 200       "isConstructor" : false,
 201       "isPrivate" : false,
 202       "example" : "",
 203       "deprecated" : "",
 204       "since" : "",
 205       "see" : "",
 206       "exceptions" : "",
 207       "requires" : "",
 208       "params" : [
 209         {
 210           "name" : "width",
 211           "type" : "Number/Object",
 212           "desc" : "The new width to set, or a size object in the format {width, height}",
 213           "isOptional" : false
 214         },
 215         {
 216           "name" : "height",
 217           "type" : "Number",
 218           "desc" : "The new height to set (not required if a size object is passed as the first arg)",
 219           "isOptional" : false
 220         }
 221       ],
 222       "returns" : [
 223         {
 224           "name" : "",
 225           "type" : "Roo.BoxComponent",
 226           "desc" : "this"
 227         }
 228       ]
 229     },
 230     {
 231       "name" : "getPosition",
 232       "type" : "function",
 233       "desc" : "Gets the current XY position of the component's underlying element.",
 234       "sig" : "(local)",
 235       "static" : false,
 236       "memberOf" : "",
 237       "isStatic" : false,
 238       "isConstructor" : false,
 239       "isPrivate" : false,
 240       "example" : "",
 241       "deprecated" : "",
 242       "since" : "",
 243       "see" : "",
 244       "exceptions" : "",
 245       "requires" : "",
 246       "params" : [
 247         {
 248           "name" : "local",
 249           "type" : "Boolean",
 250           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
 251           "isOptional" : false
 252         }
 253       ],
 254       "returns" : [
 255         {
 256           "name" : "",
 257           "type" : "Array",
 258           "desc" : "The XY position of the element (e.g., [100, 200])"
 259         }
 260       ]
 261     },
 262     {
 263       "name" : "onResize",
 264       "type" : "function",
 265       "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
 266       "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
 267       "static" : false,
 268       "memberOf" : "",
 269       "isStatic" : false,
 270       "isConstructor" : false,
 271       "isPrivate" : false,
 272       "example" : "",
 273       "deprecated" : "",
 274       "since" : "",
 275       "see" : "",
 276       "exceptions" : "",
 277       "requires" : "",
 278       "params" : [
 279         {
 280           "name" : "adjWidth",
 281           "type" : "Number",
 282           "desc" : "The box-adjusted width that was set",
 283           "isOptional" : false
 284         },
 285         {
 286           "name" : "adjHeight",
 287           "type" : "Number",
 288           "desc" : "The box-adjusted height that was set",
 289           "isOptional" : false
 290         },
 291         {
 292           "name" : "rawWidth",
 293           "type" : "Number",
 294           "desc" : "The width that was originally specified",
 295           "isOptional" : false
 296         },
 297         {
 298           "name" : "rawHeight",
 299           "type" : "Number",
 300           "desc" : "The height that was originally specified",
 301           "isOptional" : false
 302         }
 303       ],
 304       "returns" : []
 305     },
 306     {
 307       "name" : "getBox",
 308       "type" : "function",
 309       "desc" : "Gets the current box measurements of the component's underlying element.",
 310       "sig" : "(local)",
 311       "static" : false,
 312       "memberOf" : "",
 313       "isStatic" : false,
 314       "isConstructor" : false,
 315       "isPrivate" : false,
 316       "example" : "",
 317       "deprecated" : "",
 318       "since" : "",
 319       "see" : "",
 320       "exceptions" : "",
 321       "requires" : "",
 322       "params" : [
 323         {
 324           "name" : "local",
 325           "type" : "Boolean",
 326           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
 327           "isOptional" : false
 328         }
 329       ],
 330       "returns" : []
 331     },
 332     {
 333       "name" : "getSize",
 334       "type" : "function",
 335       "desc" : "Gets the current size of the component's underlying element.",
 336       "sig" : "()\n{\n\n}",
 337       "static" : false,
 338       "memberOf" : "",
 339       "isStatic" : false,
 340       "isConstructor" : false,
 341       "isPrivate" : false,
 342       "example" : "",
 343       "deprecated" : "",
 344       "since" : "",
 345       "see" : "",
 346       "exceptions" : "",
 347       "requires" : "",
 348       "params" : [],
 349       "returns" : [
 350         {
 351           "name" : "",
 352           "type" : "Object",
 353           "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
 354         }
 355       ]
 356     },
 357     {
 358       "name" : "onPosition",
 359       "type" : "function",
 360       "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
 361       "sig" : "(x, y)",
 362       "static" : false,
 363       "memberOf" : "",
 364       "isStatic" : false,
 365       "isConstructor" : false,
 366       "isPrivate" : false,
 367       "example" : "",
 368       "deprecated" : "",
 369       "since" : "",
 370       "see" : "",
 371       "exceptions" : "",
 372       "requires" : "",
 373       "params" : [
 374         {
 375           "name" : "x",
 376           "type" : "Number",
 377           "desc" : "The new x position",
 378           "isOptional" : false
 379         },
 380         {
 381           "name" : "y",
 382           "type" : "Number",
 383           "desc" : "The new y position",
 384           "isOptional" : false
 385         }
 386       ],
 387       "returns" : []
 388     },
 389     {
 390       "name" : "setPosition",
 391       "type" : "function",
 392       "desc" : "Sets the left and top of the component.  To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
 393       "sig" : "(left, top)",
 394       "static" : false,
 395       "memberOf" : "",
 396       "isStatic" : false,
 397       "isConstructor" : false,
 398       "isPrivate" : false,
 399       "example" : "",
 400       "deprecated" : "",
 401       "since" : "",
 402       "see" : "",
 403       "exceptions" : "",
 404       "requires" : "",
 405       "params" : [
 406         {
 407           "name" : "left",
 408           "type" : "Number",
 409           "desc" : "The new left",
 410           "isOptional" : false
 411         },
 412         {
 413           "name" : "top",
 414           "type" : "Number",
 415           "desc" : "The new top",
 416           "isOptional" : false
 417         }
 418       ],
 419       "returns" : []
 420     },
 421     {
 422       "name" : "getId",
 423       "type" : "function",
 424       "desc" : "Returns the id of this component.",
 425       "sig" : "()\n{\n\n}",
 426       "static" : false,
 427       "memberOf" : "Roo.Component",
 428       "isStatic" : false,
 429       "isConstructor" : false,
 430       "isPrivate" : false,
 431       "example" : "",
 432       "deprecated" : "",
 433       "since" : "",
 434       "see" : "",
 435       "exceptions" : "",
 436       "requires" : "",
 437       "params" : [],
 438       "returns" : [
 439         {
 440           "name" : "",
 441           "type" : "String",
 442           "desc" : ""
 443         }
 444       ]
 445     },
 446     {
 447       "name" : "render",
 448       "type" : "function",
 449       "desc" : "If this is a lazy rendering component, render it to its container element.",
 450       "sig" : "(container)",
 451       "static" : false,
 452       "memberOf" : "Roo.Component",
 453       "isStatic" : false,
 454       "isConstructor" : false,
 455       "isPrivate" : false,
 456       "example" : "",
 457       "deprecated" : "",
 458       "since" : "",
 459       "see" : "",
 460       "exceptions" : "",
 461       "requires" : "",
 462       "params" : [
 463         {
 464           "name" : "container",
 465           "type" : "String/HTMLElement/Element",
 466           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 467           "isOptional" : false
 468         }
 469       ],
 470       "returns" : []
 471     },
 472     {
 473       "name" : "destroy",
 474       "type" : "function",
 475       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 476       "sig" : "()\n{\n\n}",
 477       "static" : false,
 478       "memberOf" : "Roo.Component",
 479       "isStatic" : false,
 480       "isConstructor" : false,
 481       "isPrivate" : false,
 482       "example" : "",
 483       "deprecated" : "",
 484       "since" : "",
 485       "see" : "",
 486       "exceptions" : "",
 487       "requires" : "",
 488       "params" : [],
 489       "returns" : []
 490     },
 491     {
 492       "name" : "isVisible",
 493       "type" : "function",
 494       "desc" : "Returns true if this component is visible.",
 495       "sig" : "()\n{\n\n}",
 496       "static" : false,
 497       "memberOf" : "Roo.Component",
 498       "isStatic" : false,
 499       "isConstructor" : false,
 500       "isPrivate" : false,
 501       "example" : "",
 502       "deprecated" : "",
 503       "since" : "",
 504       "see" : "",
 505       "exceptions" : "",
 506       "requires" : "",
 507       "params" : [],
 508       "returns" : []
 509     },
 510     {
 511       "name" : "setDisabled",
 512       "type" : "function",
 513       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 514       "sig" : "(disabled)",
 515       "static" : false,
 516       "memberOf" : "Roo.Component",
 517       "isStatic" : false,
 518       "isConstructor" : false,
 519       "isPrivate" : false,
 520       "example" : "",
 521       "deprecated" : "",
 522       "since" : "",
 523       "see" : "",
 524       "exceptions" : "",
 525       "requires" : "",
 526       "params" : [
 527         {
 528           "name" : "disabled",
 529           "type" : "Boolean",
 530           "desc" : "",
 531           "isOptional" : false
 532         }
 533       ],
 534       "returns" : []
 535     },
 536     {
 537       "name" : "hide",
 538       "type" : "function",
 539       "desc" : "Hide this component.",
 540       "sig" : "()\n{\n\n}",
 541       "static" : false,
 542       "memberOf" : "Roo.Component",
 543       "isStatic" : false,
 544       "isConstructor" : false,
 545       "isPrivate" : false,
 546       "example" : "",
 547       "deprecated" : "",
 548       "since" : "",
 549       "see" : "",
 550       "exceptions" : "",
 551       "requires" : "",
 552       "params" : [],
 553       "returns" : [
 554         {
 555           "name" : "",
 556           "type" : "Roo.Component",
 557           "desc" : "this"
 558         }
 559       ]
 560     },
 561     {
 562       "name" : "focus",
 563       "type" : "function",
 564       "desc" : "Try to focus this component.",
 565       "sig" : "(selectText)",
 566       "static" : false,
 567       "memberOf" : "Roo.Component",
 568       "isStatic" : false,
 569       "isConstructor" : false,
 570       "isPrivate" : false,
 571       "example" : "",
 572       "deprecated" : "",
 573       "since" : "",
 574       "see" : "",
 575       "exceptions" : "",
 576       "requires" : "",
 577       "params" : [
 578         {
 579           "name" : "selectText",
 580           "type" : "Boolean",
 581           "desc" : "True to also select the text in this component (if applicable)",
 582           "isOptional" : false
 583         }
 584       ],
 585       "returns" : [
 586         {
 587           "name" : "",
 588           "type" : "Roo.Component",
 589           "desc" : "this"
 590         }
 591       ]
 592     },
 593     {
 594       "name" : "show",
 595       "type" : "function",
 596       "desc" : "Show this component.",
 597       "sig" : "()\n{\n\n}",
 598       "static" : false,
 599       "memberOf" : "Roo.Component",
 600       "isStatic" : false,
 601       "isConstructor" : false,
 602       "isPrivate" : false,
 603       "example" : "",
 604       "deprecated" : "",
 605       "since" : "",
 606       "see" : "",
 607       "exceptions" : "",
 608       "requires" : "",
 609       "params" : [],
 610       "returns" : [
 611         {
 612           "name" : "",
 613           "type" : "Roo.Component",
 614           "desc" : "this"
 615         }
 616       ]
 617     },
 618     {
 619       "name" : "enable",
 620       "type" : "function",
 621       "desc" : "Enable this component.",
 622       "sig" : "()\n{\n\n}",
 623       "static" : false,
 624       "memberOf" : "Roo.Component",
 625       "isStatic" : false,
 626       "isConstructor" : false,
 627       "isPrivate" : false,
 628       "example" : "",
 629       "deprecated" : "",
 630       "since" : "",
 631       "see" : "",
 632       "exceptions" : "",
 633       "requires" : "",
 634       "params" : [],
 635       "returns" : [
 636         {
 637           "name" : "",
 638           "type" : "Roo.Component",
 639           "desc" : "this"
 640         }
 641       ]
 642     },
 643     {
 644       "name" : "setVisible",
 645       "type" : "function",
 646       "desc" : "Convenience function to hide or show this component by boolean.",
 647       "sig" : "(visible)",
 648       "static" : false,
 649       "memberOf" : "Roo.Component",
 650       "isStatic" : false,
 651       "isConstructor" : false,
 652       "isPrivate" : false,
 653       "example" : "",
 654       "deprecated" : "",
 655       "since" : "",
 656       "see" : "",
 657       "exceptions" : "",
 658       "requires" : "",
 659       "params" : [
 660         {
 661           "name" : "visible",
 662           "type" : "Boolean",
 663           "desc" : "True to show, false to hide",
 664           "isOptional" : false
 665         }
 666       ],
 667       "returns" : [
 668         {
 669           "name" : "",
 670           "type" : "Roo.Component",
 671           "desc" : "this"
 672         }
 673       ]
 674     },
 675     {
 676       "name" : "disable",
 677       "type" : "function",
 678       "desc" : "Disable this component.",
 679       "sig" : "()\n{\n\n}",
 680       "static" : false,
 681       "memberOf" : "Roo.Component",
 682       "isStatic" : false,
 683       "isConstructor" : false,
 684       "isPrivate" : false,
 685       "example" : "",
 686       "deprecated" : "",
 687       "since" : "",
 688       "see" : "",
 689       "exceptions" : "",
 690       "requires" : "",
 691       "params" : [],
 692       "returns" : [
 693         {
 694           "name" : "",
 695           "type" : "Roo.Component",
 696           "desc" : "this"
 697         }
 698       ]
 699     },
 700     {
 701       "name" : "getEl",
 702       "type" : "function",
 703       "desc" : "Returns the underlying {@link Roo.Element}.",
 704       "sig" : "()\n{\n\n}",
 705       "static" : false,
 706       "memberOf" : "Roo.Component",
 707       "isStatic" : false,
 708       "isConstructor" : false,
 709       "isPrivate" : false,
 710       "example" : "",
 711       "deprecated" : "",
 712       "since" : "",
 713       "see" : "",
 714       "exceptions" : "",
 715       "requires" : "",
 716       "params" : [],
 717       "returns" : [
 718         {
 719           "name" : "",
 720           "type" : "Roo.Element",
 721           "desc" : "The element"
 722         }
 723       ]
 724     },
 725     {
 726       "name" : "purgeListeners",
 727       "type" : "function",
 728       "desc" : "Removes all listeners for this object",
 729       "sig" : "()\n{\n\n}",
 730       "static" : false,
 731       "memberOf" : "Roo.util.Observable",
 732       "isStatic" : false,
 733       "isConstructor" : false,
 734       "isPrivate" : false,
 735       "example" : "",
 736       "deprecated" : "",
 737       "since" : "",
 738       "see" : "",
 739       "exceptions" : "",
 740       "requires" : "",
 741       "params" : [],
 742       "returns" : []
 743     },
 744     {
 745       "name" : "on",
 746       "type" : "function",
 747       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 748       "sig" : "(eventName, handler, scope, options)",
 749       "static" : false,
 750       "memberOf" : "Roo.util.Observable",
 751       "isStatic" : false,
 752       "isConstructor" : false,
 753       "isPrivate" : false,
 754       "example" : "",
 755       "deprecated" : "",
 756       "since" : "",
 757       "see" : "",
 758       "exceptions" : "",
 759       "requires" : "",
 760       "params" : [
 761         {
 762           "name" : "eventName",
 763           "type" : "String",
 764           "desc" : "The type of event to listen for",
 765           "isOptional" : false
 766         },
 767         {
 768           "name" : "handler",
 769           "type" : "Function",
 770           "desc" : "The method the event invokes",
 771           "isOptional" : false
 772         },
 773         {
 774           "name" : "scope",
 775           "type" : "Object",
 776           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 777           "isOptional" : false
 778         },
 779         {
 780           "name" : "options",
 781           "type" : "Object",
 782           "desc" : "(optional)",
 783           "isOptional" : false
 784         }
 785       ],
 786       "returns" : []
 787     },
 788     {
 789       "name" : "un",
 790       "type" : "function",
 791       "desc" : "Removes a listener (shorthand for removeListener)",
 792       "sig" : "(eventName, handler, scope)",
 793       "static" : false,
 794       "memberOf" : "Roo.util.Observable",
 795       "isStatic" : false,
 796       "isConstructor" : false,
 797       "isPrivate" : false,
 798       "example" : "",
 799       "deprecated" : "",
 800       "since" : "",
 801       "see" : "",
 802       "exceptions" : "",
 803       "requires" : "",
 804       "params" : [
 805         {
 806           "name" : "eventName",
 807           "type" : "String",
 808           "desc" : "The type of event to listen for",
 809           "isOptional" : false
 810         },
 811         {
 812           "name" : "handler",
 813           "type" : "Function",
 814           "desc" : "The handler to remove",
 815           "isOptional" : false
 816         },
 817         {
 818           "name" : "scope",
 819           "type" : "Object",
 820           "desc" : "(optional) The scope (this object) for the handler",
 821           "isOptional" : false
 822         }
 823       ],
 824       "returns" : []
 825     },
 826     {
 827       "name" : "addEvents",
 828       "type" : "function",
 829       "desc" : "Used to define events on this Observable",
 830       "sig" : "(object)",
 831       "static" : false,
 832       "memberOf" : "Roo.util.Observable",
 833       "isStatic" : false,
 834       "isConstructor" : false,
 835       "isPrivate" : false,
 836       "example" : "",
 837       "deprecated" : "",
 838       "since" : "",
 839       "see" : "",
 840       "exceptions" : "",
 841       "requires" : "",
 842       "params" : [
 843         {
 844           "name" : "object",
 845           "type" : "Object",
 846           "desc" : "The object with the events defined",
 847           "isOptional" : false
 848         }
 849       ],
 850       "returns" : []
 851     },
 852     {
 853       "name" : "releaseCapture",
 854       "type" : "function",
 855       "desc" : "Removes <b>all</b> added captures from the Observable.",
 856       "sig" : "(o)",
 857       "static" : true,
 858       "memberOf" : "Roo.util.Observable",
 859       "isStatic" : true,
 860       "isConstructor" : false,
 861       "isPrivate" : false,
 862       "example" : "",
 863       "deprecated" : "",
 864       "since" : "",
 865       "see" : "",
 866       "exceptions" : "",
 867       "requires" : "",
 868       "params" : [
 869         {
 870           "name" : "o",
 871           "type" : "Observable",
 872           "desc" : "The Observable to release",
 873           "isOptional" : false
 874         }
 875       ],
 876       "returns" : []
 877     },
 878     {
 879       "name" : "removeListener",
 880       "type" : "function",
 881       "desc" : "Removes a listener",
 882       "sig" : "(eventName, handler, scope)",
 883       "static" : false,
 884       "memberOf" : "Roo.util.Observable",
 885       "isStatic" : false,
 886       "isConstructor" : false,
 887       "isPrivate" : false,
 888       "example" : "",
 889       "deprecated" : "",
 890       "since" : "",
 891       "see" : "",
 892       "exceptions" : "",
 893       "requires" : "",
 894       "params" : [
 895         {
 896           "name" : "eventName",
 897           "type" : "String",
 898           "desc" : "The type of event to listen for",
 899           "isOptional" : false
 900         },
 901         {
 902           "name" : "handler",
 903           "type" : "Function",
 904           "desc" : "The handler to remove",
 905           "isOptional" : false
 906         },
 907         {
 908           "name" : "scope",
 909           "type" : "Object",
 910           "desc" : "(optional) The scope (this object) for the handler",
 911           "isOptional" : false
 912         }
 913       ],
 914       "returns" : []
 915     },
 916     {
 917       "name" : "fireEvent",
 918       "type" : "function",
 919       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 920       "sig" : "(eventName, args)",
 921       "static" : false,
 922       "memberOf" : "Roo.util.Observable",
 923       "isStatic" : false,
 924       "isConstructor" : false,
 925       "isPrivate" : false,
 926       "example" : "",
 927       "deprecated" : "",
 928       "since" : "",
 929       "see" : "",
 930       "exceptions" : "",
 931       "requires" : "",
 932       "params" : [
 933         {
 934           "name" : "eventName",
 935           "type" : "String",
 936           "desc" : "",
 937           "isOptional" : false
 938         },
 939         {
 940           "name" : "args",
 941           "type" : "Object...",
 942           "desc" : "Variable number of parameters are passed to handlers",
 943           "isOptional" : false
 944         }
 945       ],
 946       "returns" : [
 947         {
 948           "name" : "",
 949           "type" : "Boolean",
 950           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 951         }
 952       ]
 953     },
 954     {
 955       "name" : "hasListener",
 956       "type" : "function",
 957       "desc" : "Checks to see if this object has any listeners for a specified event",
 958       "sig" : "(eventName)",
 959       "static" : false,
 960       "memberOf" : "Roo.util.Observable",
 961       "isStatic" : false,
 962       "isConstructor" : false,
 963       "isPrivate" : false,
 964       "example" : "",
 965       "deprecated" : "",
 966       "since" : "",
 967       "see" : "",
 968       "exceptions" : "",
 969       "requires" : "",
 970       "params" : [
 971         {
 972           "name" : "eventName",
 973           "type" : "String",
 974           "desc" : "The name of the event to check for",
 975           "isOptional" : false
 976         }
 977       ],
 978       "returns" : [
 979         {
 980           "name" : "",
 981           "type" : "Boolean",
 982           "desc" : "True if the event is being listened for, else false"
 983         }
 984       ]
 985     },
 986     {
 987       "name" : "capture",
 988       "type" : "function",
 989       "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.",
 990       "sig" : "(o, fn, scope)",
 991       "static" : true,
 992       "memberOf" : "Roo.util.Observable",
 993       "isStatic" : true,
 994       "isConstructor" : false,
 995       "isPrivate" : false,
 996       "example" : "",
 997       "deprecated" : "",
 998       "since" : "",
 999       "see" : "",
1000       "exceptions" : "",
1001       "requires" : "",
1002       "params" : [
1003         {
1004           "name" : "o",
1005           "type" : "Observable",
1006           "desc" : "The Observable to capture",
1007           "isOptional" : false
1008         },
1009         {
1010           "name" : "fn",
1011           "type" : "Function",
1012           "desc" : "The function to call",
1013           "isOptional" : false
1014         },
1015         {
1016           "name" : "scope",
1017           "type" : "Object",
1018           "desc" : "(optional) The scope (this object) for the fn",
1019           "isOptional" : false
1020         }
1021       ],
1022       "returns" : []
1023     },
1024     {
1025       "name" : "addListener",
1026       "type" : "function",
1027       "desc" : "Appends an event handler to this component",
1028       "sig" : "(eventName, handler, scope, options)",
1029       "static" : false,
1030       "memberOf" : "Roo.util.Observable",
1031       "isStatic" : false,
1032       "isConstructor" : false,
1033       "isPrivate" : false,
1034       "example" : "",
1035       "deprecated" : "",
1036       "since" : "",
1037       "see" : "",
1038       "exceptions" : "",
1039       "requires" : "",
1040       "params" : [
1041         {
1042           "name" : "eventName",
1043           "type" : "String",
1044           "desc" : "The type of event to listen for",
1045           "isOptional" : false
1046         },
1047         {
1048           "name" : "handler",
1049           "type" : "Function",
1050           "desc" : "The method the event invokes",
1051           "isOptional" : false
1052         },
1053         {
1054           "name" : "scope",
1055           "type" : "Object",
1056           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1057           "isOptional" : false
1058         },
1059         {
1060           "name" : "options",
1061           "type" : "Object",
1062           "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>",
1063           "isOptional" : false
1064         }
1065       ],
1066       "returns" : []
1067     }
1068   ],
1069   "events" : [
1070     {
1071       "name" : "move",
1072       "type" : "function",
1073       "desc" : "Fires after the component is moved.",
1074       "sig" : "function (_self, x, y)\n{\n\n}",
1075       "memberOf" : "",
1076       "example" : "",
1077       "deprecated" : "",
1078       "since" : "",
1079       "see" : "",
1080       "params" : [
1081         {
1082           "name" : "this",
1083           "type" : "Roo.Component",
1084           "desc" : "",
1085           "isOptional" : false
1086         },
1087         {
1088           "name" : "x",
1089           "type" : "Number",
1090           "desc" : "The new x position",
1091           "isOptional" : false
1092         },
1093         {
1094           "name" : "y",
1095           "type" : "Number",
1096           "desc" : "The new y position",
1097           "isOptional" : false
1098         }
1099       ],
1100       "returns" : []
1101     },
1102     {
1103       "name" : "resize",
1104       "type" : "function",
1105       "desc" : "Fires after the component is resized.",
1106       "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
1107       "memberOf" : "",
1108       "example" : "",
1109       "deprecated" : "",
1110       "since" : "",
1111       "see" : "",
1112       "params" : [
1113         {
1114           "name" : "this",
1115           "type" : "Roo.Component",
1116           "desc" : "",
1117           "isOptional" : false
1118         },
1119         {
1120           "name" : "adjWidth",
1121           "type" : "Number",
1122           "desc" : "The box-adjusted width that was set",
1123           "isOptional" : false
1124         },
1125         {
1126           "name" : "adjHeight",
1127           "type" : "Number",
1128           "desc" : "The box-adjusted height that was set",
1129           "isOptional" : false
1130         },
1131         {
1132           "name" : "rawWidth",
1133           "type" : "Number",
1134           "desc" : "The width that was originally specified",
1135           "isOptional" : false
1136         },
1137         {
1138           "name" : "rawHeight",
1139           "type" : "Number",
1140           "desc" : "The height that was originally specified",
1141           "isOptional" : false
1142         }
1143       ],
1144       "returns" : []
1145     },
1146     {
1147       "name" : "beforerender",
1148       "type" : "function",
1149       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1150       "sig" : "function (_self)\n{\n\n}",
1151       "memberOf" : "Roo.Component",
1152       "example" : "",
1153       "deprecated" : "",
1154       "since" : "",
1155       "see" : "",
1156       "params" : [
1157         {
1158           "name" : "this",
1159           "type" : "Roo.Component",
1160           "desc" : "",
1161           "isOptional" : false
1162         }
1163       ],
1164       "returns" : []
1165     },
1166     {
1167       "name" : "disable",
1168       "type" : "function",
1169       "desc" : "Fires after the component is disabled.",
1170       "sig" : "function (_self)\n{\n\n}",
1171       "memberOf" : "Roo.Component",
1172       "example" : "",
1173       "deprecated" : "",
1174       "since" : "",
1175       "see" : "",
1176       "params" : [
1177         {
1178           "name" : "this",
1179           "type" : "Roo.Component",
1180           "desc" : "",
1181           "isOptional" : false
1182         }
1183       ],
1184       "returns" : []
1185     },
1186     {
1187       "name" : "render",
1188       "type" : "function",
1189       "desc" : "Fires after the component is rendered.",
1190       "sig" : "function (_self)\n{\n\n}",
1191       "memberOf" : "Roo.Component",
1192       "example" : "",
1193       "deprecated" : "",
1194       "since" : "",
1195       "see" : "",
1196       "params" : [
1197         {
1198           "name" : "this",
1199           "type" : "Roo.Component",
1200           "desc" : "",
1201           "isOptional" : false
1202         }
1203       ],
1204       "returns" : []
1205     },
1206     {
1207       "name" : "destroy",
1208       "type" : "function",
1209       "desc" : "Fires after the component is destroyed.",
1210       "sig" : "function (_self)\n{\n\n}",
1211       "memberOf" : "Roo.Component",
1212       "example" : "",
1213       "deprecated" : "",
1214       "since" : "",
1215       "see" : "",
1216       "params" : [
1217         {
1218           "name" : "this",
1219           "type" : "Roo.Component",
1220           "desc" : "",
1221           "isOptional" : false
1222         }
1223       ],
1224       "returns" : []
1225     },
1226     {
1227       "name" : "hide",
1228       "type" : "function",
1229       "desc" : "Fires after the component is hidden.",
1230       "sig" : "function (_self)\n{\n\n}",
1231       "memberOf" : "Roo.Component",
1232       "example" : "",
1233       "deprecated" : "",
1234       "since" : "",
1235       "see" : "",
1236       "params" : [
1237         {
1238           "name" : "this",
1239           "type" : "Roo.Component",
1240           "desc" : "",
1241           "isOptional" : false
1242         }
1243       ],
1244       "returns" : []
1245     },
1246     {
1247       "name" : "beforehide",
1248       "type" : "function",
1249       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1250       "sig" : "function (_self)\n{\n\n}",
1251       "memberOf" : "Roo.Component",
1252       "example" : "",
1253       "deprecated" : "",
1254       "since" : "",
1255       "see" : "",
1256       "params" : [
1257         {
1258           "name" : "this",
1259           "type" : "Roo.Component",
1260           "desc" : "",
1261           "isOptional" : false
1262         }
1263       ],
1264       "returns" : []
1265     },
1266     {
1267       "name" : "show",
1268       "type" : "function",
1269       "desc" : "Fires after the component is shown.",
1270       "sig" : "function (_self)\n{\n\n}",
1271       "memberOf" : "Roo.Component",
1272       "example" : "",
1273       "deprecated" : "",
1274       "since" : "",
1275       "see" : "",
1276       "params" : [
1277         {
1278           "name" : "this",
1279           "type" : "Roo.Component",
1280           "desc" : "",
1281           "isOptional" : false
1282         }
1283       ],
1284       "returns" : []
1285     },
1286     {
1287       "name" : "beforeshow",
1288       "type" : "function",
1289       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1290       "sig" : "function (_self)\n{\n\n}",
1291       "memberOf" : "Roo.Component",
1292       "example" : "",
1293       "deprecated" : "",
1294       "since" : "",
1295       "see" : "",
1296       "params" : [
1297         {
1298           "name" : "this",
1299           "type" : "Roo.Component",
1300           "desc" : "",
1301           "isOptional" : false
1302         }
1303       ],
1304       "returns" : []
1305     },
1306     {
1307       "name" : "enable",
1308       "type" : "function",
1309       "desc" : "Fires after the component is enabled.",
1310       "sig" : "function (_self)\n{\n\n}",
1311       "memberOf" : "Roo.Component",
1312       "example" : "",
1313       "deprecated" : "",
1314       "since" : "",
1315       "see" : "",
1316       "params" : [
1317         {
1318           "name" : "this",
1319           "type" : "Roo.Component",
1320           "desc" : "",
1321           "isOptional" : false
1322         }
1323       ],
1324       "returns" : []
1325     },
1326     {
1327       "name" : "beforedestroy",
1328       "type" : "function",
1329       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1330       "sig" : "function (_self)\n{\n\n}",
1331       "memberOf" : "Roo.Component",
1332       "example" : "",
1333       "deprecated" : "",
1334       "since" : "",
1335       "see" : "",
1336       "params" : [
1337         {
1338           "name" : "this",
1339           "type" : "Roo.Component",
1340           "desc" : "",
1341           "isOptional" : false
1342         }
1343       ],
1344       "returns" : []
1345     }
1346   ]
1347 }