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