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

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