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