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