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