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