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