git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.TextItem.json

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