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

   1 {
   2   "name" : "Roo.Component",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : {
   7     "Roo.bootstrap.nav.Bar" : [
   8       "Roo.bootstrap.nav.Sidebar",
   9       "Roo.bootstrap.nav.Simplebar"
  10     ],
  11     "Roo.form.Field" : [
  12       "Roo.form.Checkbox",
  13       "Roo.form.DayPicker",
  14       "Roo.form.DisplayField",
  15       "Roo.form.GridField",
  16       "Roo.form.HtmlEditor",
  17       "Roo.form.Signature",
  18       "Roo.form.TextField"
  19     ],
  20     "Roo.bootstrap.nav.Simplebar" : [
  21       "Roo.bootstrap.PagingToolbar",
  22       "Roo.bootstrap.PopoverNav",
  23       "Roo.bootstrap.form.HtmlEditorToolbarStandard",
  24       "Roo.bootstrap.nav.Headerbar"
  25     ],
  26     "Roo.bootstrap.Button" : [
  27       "Roo.bootstrap.ButtonUploader",
  28       "Roo.bootstrap.form.CardUploader"
  29     ],
  30     "Roo.bootstrap.Column" : [
  31       "Roo.bootstrap.TabGroup"
  32     ],
  33     "Roo.bootstrap.form.TriggerField" : [
  34       "Roo.bootstrap.form.ComboBox",
  35       "Roo.bootstrap.form.PhoneInput"
  36     ],
  37     "Roo.bootstrap.form.TextArea" : [
  38       "Roo.bootstrap.form.HtmlEditor",
  39       "Roo.bootstrap.form.Markdown"
  40     ],
  41     "Roo.form.TextArea" : [
  42       "Roo.form.FCKeditor"
  43     ],
  44     "Roo.Component" : [
  45       "Roo.BoxComponent",
  46       "Roo.CalendarPanel",
  47       "Roo.ColorPalette",
  48       "Roo.DatePicker",
  49       "Roo.Editor",
  50       "Roo.HtmlEditorCore",
  51       "Roo.bootstrap.Component",
  52       "Roo.form.Layout",
  53       "Roo.menu.BaseItem"
  54     ],
  55     "Roo.bootstrap.layout.Manager" : [
  56       "Roo.bootstrap.layout.Border"
  57     ],
  58     "Roo.BoxComponent" : [
  59       "Roo.form.ComboBoxArray.Item",
  60       "Roo.form.Field",
  61       "Roo.form.TextItem"
  62     ],
  63     "Roo.bootstrap.Element" : [
  64       "Roo.bootstrap.CardFooter",
  65       "Roo.bootstrap.CardHeader",
  66       "Roo.bootstrap.CardImageTop",
  67       "Roo.bootstrap.DropTarget"
  68     ],
  69     "Roo.form.Checkbox" : [
  70       "Roo.form.Radio"
  71     ],
  72     "Roo.Editor" : [
  73       "Roo.grid.GridEditor",
  74       "Roo.tree.TreeEditor"
  75     ],
  76     "Roo.menu.BaseItem" : [
  77       "Roo.menu.Adapter",
  78       "Roo.menu.Item",
  79       "Roo.menu.Separator",
  80       "Roo.menu.TextItem"
  81     ],
  82     "Roo.bootstrap.nav.Item" : [
  83       "Roo.bootstrap.nav.SidebarItem"
  84     ],
  85     "Roo.form.TextField" : [
  86       "Roo.form.ComboBoxArray",
  87       "Roo.form.Hidden",
  88       "Roo.form.NumberField",
  89       "Roo.form.TextArea",
  90       "Roo.form.TriggerField"
  91     ],
  92     "Roo.form.Layout" : [
  93       "Roo.form.Column",
  94       "Roo.form.FieldSet",
  95       "Roo.form.Row"
  96     ],
  97     "Roo.menu.Item" : [
  98       "Roo.menu.CheckItem"
  99     ],
 100     "Roo.menu.Adapter" : [
 101       "Roo.menu.ColorItem",
 102       "Roo.menu.DateItem"
 103     ],
 104     "Roo.bootstrap.Component" : [
 105       "Roo.bootstrap.Alert",
 106       "Roo.bootstrap.BezierSignature",
 107       "Roo.bootstrap.Body",
 108       "Roo.bootstrap.Brick",
 109       "Roo.bootstrap.Button",
 110       "Roo.bootstrap.ButtonGroup",
 111       "Roo.bootstrap.Calendar",
 112       "Roo.bootstrap.Card",
 113       "Roo.bootstrap.Column",
 114       "Roo.bootstrap.Container",
 115       "Roo.bootstrap.DocumentManager",
 116       "Roo.bootstrap.DocumentSlider",
 117       "Roo.bootstrap.DocumentViewer",
 118       "Roo.bootstrap.Element",
 119       "Roo.bootstrap.Graph",
 120       "Roo.bootstrap.Header",
 121       "Roo.bootstrap.Img",
 122       "Roo.bootstrap.LayoutMasonry",
 123       "Roo.bootstrap.LayoutMasonryAuto",
 124       "Roo.bootstrap.Link",
 125       "Roo.bootstrap.LocationPicker",
 126       "Roo.bootstrap.MasonryBrick",
 127       "Roo.bootstrap.MessageBar",
 128       "Roo.bootstrap.Modal",
 129       "Roo.bootstrap.Pagination",
 130       "Roo.bootstrap.PaginationItem",
 131       "Roo.bootstrap.Popover",
 132       "Roo.bootstrap.Progress",
 133       "Roo.bootstrap.ProgressBar",
 134       "Roo.bootstrap.Row",
 135       "Roo.bootstrap.Slider",
 136       "Roo.bootstrap.TabPanel",
 137       "Roo.bootstrap.Table",
 138       "Roo.bootstrap.TableBody",
 139       "Roo.bootstrap.TableCell",
 140       "Roo.bootstrap.TableRow",
 141       "Roo.bootstrap.UploadCropbox",
 142       "Roo.bootstrap.breadcrumb.Item",
 143       "Roo.bootstrap.breadcrumb.Nav",
 144       "Roo.bootstrap.dash.NumberBox",
 145       "Roo.bootstrap.dash.TabBox",
 146       "Roo.bootstrap.dash.TabPane",
 147       "Roo.bootstrap.form.DateSplitField",
 148       "Roo.bootstrap.form.FieldLabel",
 149       "Roo.bootstrap.form.Form",
 150       "Roo.bootstrap.form.Input",
 151       "Roo.bootstrap.form.Radio",
 152       "Roo.bootstrap.layout.Manager",
 153       "Roo.bootstrap.menu.Item",
 154       "Roo.bootstrap.menu.Menu",
 155       "Roo.bootstrap.menu.Separator",
 156       "Roo.bootstrap.nav.Bar",
 157       "Roo.bootstrap.nav.Group",
 158       "Roo.bootstrap.nav.Item",
 159       "Roo.bootstrap.nav.ProgressBar",
 160       "Roo.bootstrap.nav.ProgressBarItem"
 161     ],
 162     "Roo.bootstrap.form.ComboBox" : [
 163       "Roo.bootstrap.form.MoneyField"
 164     ],
 165     "Roo.form.TriggerField" : [
 166       "Roo.form.ComboBox",
 167       "Roo.form.DateField",
 168       "Roo.form.MonthField",
 169       "Roo.form.Select"
 170     ],
 171     "Roo.form.ComboBox" : [
 172       "Roo.form.ComboCheck",
 173       "Roo.form.ComboNested"
 174     ],
 175     "Roo.bootstrap.form.Input" : [
 176       "Roo.bootstrap.form.CheckBox",
 177       "Roo.bootstrap.form.DateField",
 178       "Roo.bootstrap.form.MonthField",
 179       "Roo.bootstrap.form.NumberField",
 180       "Roo.bootstrap.form.RadioSet",
 181       "Roo.bootstrap.form.SecurePass",
 182       "Roo.bootstrap.form.TextArea",
 183       "Roo.bootstrap.form.TimeField",
 184       "Roo.bootstrap.form.TriggerField"
 185     ]
 186   },
 187   "tree_children" : [],
 188   "tree_parent" : [],
 189   "desc" : "Base class for all major Roo components.  All subclasses of Component can automatically participate in the standard\nRoo component lifecycle of creation, rendering and destruction.  They also have automatic support for basic hide/show\nand enable/disable behavior.  Component allows any subclass to be lazy-rendered into any {@link Roo.Container} and\nto be automatically registered with the {@link Roo.ComponentMgr} so that it can be referenced at any time via {@link Roo.getCmp}.\nAll visual components (widgets) that require rendering into a layout should subclass Component.",
 190   "isSingleton" : false,
 191   "isStatic" : false,
 192   "isBuiltin" : false,
 193   "isAbstract" : false,
 194   "isBuilderTop" : false,
 195   "memberOf" : "Component",
 196   "example" : "",
 197   "deprecated" : "",
 198   "since" : "",
 199   "see" : "",
 200   "params" : [
 201     {
 202       "name" : "config",
 203       "type" : "Roo.Element/String/Object",
 204       "desc" : "The configuration options.  If an element is passed, it is set as the internal\nelement and its id used as the component id.  If a string is passed, it is assumed to be the id of an existing element\nand is used as the component id.  Otherwise, it is assumed to be a standard config object and is applied to the component.",
 205       "isOptional" : false
 206     }
 207   ],
 208   "returns" : [],
 209   "throws" : "",
 210   "requires" : "",
 211   "config" : [
 212     {
 213       "name" : "listeners",
 214       "type" : "Object",
 215       "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>",
 216       "memberOf" : "Roo.util.Observable"
 217     },
 218     {
 219       "name" : "hideMode",
 220       "type" : "String",
 221       "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\".",
 222       "memberOf" : "Roo.Component"
 223     },
 224     {
 225       "name" : "allowDomMove",
 226       "type" : "Boolean",
 227       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 228       "memberOf" : "Roo.Component"
 229     },
 230     {
 231       "name" : "actionMode",
 232       "type" : "String",
 233       "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",
 234       "memberOf" : "Roo.Component"
 235     },
 236     {
 237       "name" : "disableClass",
 238       "type" : "String",
 239       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 240       "memberOf" : "Roo.Component"
 241     }
 242   ],
 243   "methods" : [
 244     {
 245       "name" : "getId",
 246       "type" : "function",
 247       "desc" : "Returns the id of this component.",
 248       "sig" : "()\n{\n\n}",
 249       "static" : false,
 250       "memberOf" : "",
 251       "isStatic" : false,
 252       "isConstructor" : false,
 253       "isPrivate" : false,
 254       "example" : "",
 255       "deprecated" : "",
 256       "since" : "",
 257       "see" : "",
 258       "exceptions" : "",
 259       "requires" : "",
 260       "params" : [],
 261       "returns" : [
 262         {
 263           "name" : "",
 264           "type" : "String",
 265           "desc" : ""
 266         }
 267       ]
 268     },
 269     {
 270       "name" : "render",
 271       "type" : "function",
 272       "desc" : "If this is a lazy rendering component, render it to its container element.",
 273       "sig" : "(container)",
 274       "static" : false,
 275       "memberOf" : "",
 276       "isStatic" : false,
 277       "isConstructor" : false,
 278       "isPrivate" : false,
 279       "example" : "",
 280       "deprecated" : "",
 281       "since" : "",
 282       "see" : "",
 283       "exceptions" : "",
 284       "requires" : "",
 285       "params" : [
 286         {
 287           "name" : "container",
 288           "type" : "String/HTMLElement/Element",
 289           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 290           "isOptional" : false
 291         }
 292       ],
 293       "returns" : []
 294     },
 295     {
 296       "name" : "destroy",
 297       "type" : "function",
 298       "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}.",
 299       "sig" : "()\n{\n\n}",
 300       "static" : false,
 301       "memberOf" : "",
 302       "isStatic" : false,
 303       "isConstructor" : false,
 304       "isPrivate" : false,
 305       "example" : "",
 306       "deprecated" : "",
 307       "since" : "",
 308       "see" : "",
 309       "exceptions" : "",
 310       "requires" : "",
 311       "params" : [],
 312       "returns" : []
 313     },
 314     {
 315       "name" : "isVisible",
 316       "type" : "function",
 317       "desc" : "Returns true if this component is visible.",
 318       "sig" : "()\n{\n\n}",
 319       "static" : false,
 320       "memberOf" : "",
 321       "isStatic" : false,
 322       "isConstructor" : false,
 323       "isPrivate" : false,
 324       "example" : "",
 325       "deprecated" : "",
 326       "since" : "",
 327       "see" : "",
 328       "exceptions" : "",
 329       "requires" : "",
 330       "params" : [],
 331       "returns" : []
 332     },
 333     {
 334       "name" : "setDisabled",
 335       "type" : "function",
 336       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 337       "sig" : "(disabled)",
 338       "static" : false,
 339       "memberOf" : "",
 340       "isStatic" : false,
 341       "isConstructor" : false,
 342       "isPrivate" : false,
 343       "example" : "",
 344       "deprecated" : "",
 345       "since" : "",
 346       "see" : "",
 347       "exceptions" : "",
 348       "requires" : "",
 349       "params" : [
 350         {
 351           "name" : "disabled",
 352           "type" : "Boolean",
 353           "desc" : "",
 354           "isOptional" : false
 355         }
 356       ],
 357       "returns" : []
 358     },
 359     {
 360       "name" : "hide",
 361       "type" : "function",
 362       "desc" : "Hide this component.",
 363       "sig" : "()\n{\n\n}",
 364       "static" : false,
 365       "memberOf" : "",
 366       "isStatic" : false,
 367       "isConstructor" : false,
 368       "isPrivate" : false,
 369       "example" : "",
 370       "deprecated" : "",
 371       "since" : "",
 372       "see" : "",
 373       "exceptions" : "",
 374       "requires" : "",
 375       "params" : [],
 376       "returns" : [
 377         {
 378           "name" : "",
 379           "type" : "Roo.Component",
 380           "desc" : "this"
 381         }
 382       ]
 383     },
 384     {
 385       "name" : "focus",
 386       "type" : "function",
 387       "desc" : "Try to focus this component.",
 388       "sig" : "(selectText)",
 389       "static" : false,
 390       "memberOf" : "",
 391       "isStatic" : false,
 392       "isConstructor" : false,
 393       "isPrivate" : false,
 394       "example" : "",
 395       "deprecated" : "",
 396       "since" : "",
 397       "see" : "",
 398       "exceptions" : "",
 399       "requires" : "",
 400       "params" : [
 401         {
 402           "name" : "selectText",
 403           "type" : "Boolean",
 404           "desc" : "True to also select the text in this component (if applicable)",
 405           "isOptional" : false
 406         }
 407       ],
 408       "returns" : [
 409         {
 410           "name" : "",
 411           "type" : "Roo.Component",
 412           "desc" : "this"
 413         }
 414       ]
 415     },
 416     {
 417       "name" : "show",
 418       "type" : "function",
 419       "desc" : "Show this component.",
 420       "sig" : "()\n{\n\n}",
 421       "static" : false,
 422       "memberOf" : "",
 423       "isStatic" : false,
 424       "isConstructor" : false,
 425       "isPrivate" : false,
 426       "example" : "",
 427       "deprecated" : "",
 428       "since" : "",
 429       "see" : "",
 430       "exceptions" : "",
 431       "requires" : "",
 432       "params" : [],
 433       "returns" : [
 434         {
 435           "name" : "",
 436           "type" : "Roo.Component",
 437           "desc" : "this"
 438         }
 439       ]
 440     },
 441     {
 442       "name" : "enable",
 443       "type" : "function",
 444       "desc" : "Enable this component.",
 445       "sig" : "()\n{\n\n}",
 446       "static" : false,
 447       "memberOf" : "",
 448       "isStatic" : false,
 449       "isConstructor" : false,
 450       "isPrivate" : false,
 451       "example" : "",
 452       "deprecated" : "",
 453       "since" : "",
 454       "see" : "",
 455       "exceptions" : "",
 456       "requires" : "",
 457       "params" : [],
 458       "returns" : [
 459         {
 460           "name" : "",
 461           "type" : "Roo.Component",
 462           "desc" : "this"
 463         }
 464       ]
 465     },
 466     {
 467       "name" : "setVisible",
 468       "type" : "function",
 469       "desc" : "Convenience function to hide or show this component by boolean.",
 470       "sig" : "(visible)",
 471       "static" : false,
 472       "memberOf" : "",
 473       "isStatic" : false,
 474       "isConstructor" : false,
 475       "isPrivate" : false,
 476       "example" : "",
 477       "deprecated" : "",
 478       "since" : "",
 479       "see" : "",
 480       "exceptions" : "",
 481       "requires" : "",
 482       "params" : [
 483         {
 484           "name" : "visible",
 485           "type" : "Boolean",
 486           "desc" : "True to show, false to hide",
 487           "isOptional" : false
 488         }
 489       ],
 490       "returns" : [
 491         {
 492           "name" : "",
 493           "type" : "Roo.Component",
 494           "desc" : "this"
 495         }
 496       ]
 497     },
 498     {
 499       "name" : "disable",
 500       "type" : "function",
 501       "desc" : "Disable this component.",
 502       "sig" : "()\n{\n\n}",
 503       "static" : false,
 504       "memberOf" : "",
 505       "isStatic" : false,
 506       "isConstructor" : false,
 507       "isPrivate" : false,
 508       "example" : "",
 509       "deprecated" : "",
 510       "since" : "",
 511       "see" : "",
 512       "exceptions" : "",
 513       "requires" : "",
 514       "params" : [],
 515       "returns" : [
 516         {
 517           "name" : "",
 518           "type" : "Roo.Component",
 519           "desc" : "this"
 520         }
 521       ]
 522     },
 523     {
 524       "name" : "getEl",
 525       "type" : "function",
 526       "desc" : "Returns the underlying {@link Roo.Element}.",
 527       "sig" : "()\n{\n\n}",
 528       "static" : false,
 529       "memberOf" : "",
 530       "isStatic" : false,
 531       "isConstructor" : false,
 532       "isPrivate" : false,
 533       "example" : "",
 534       "deprecated" : "",
 535       "since" : "",
 536       "see" : "",
 537       "exceptions" : "",
 538       "requires" : "",
 539       "params" : [],
 540       "returns" : [
 541         {
 542           "name" : "",
 543           "type" : "Roo.Element",
 544           "desc" : "The element"
 545         }
 546       ]
 547     },
 548     {
 549       "name" : "purgeListeners",
 550       "type" : "function",
 551       "desc" : "Removes all listeners for this object",
 552       "sig" : "()\n{\n\n}",
 553       "static" : false,
 554       "memberOf" : "Roo.util.Observable",
 555       "isStatic" : false,
 556       "isConstructor" : false,
 557       "isPrivate" : false,
 558       "example" : "",
 559       "deprecated" : "",
 560       "since" : "",
 561       "see" : "",
 562       "exceptions" : "",
 563       "requires" : "",
 564       "params" : [],
 565       "returns" : []
 566     },
 567     {
 568       "name" : "on",
 569       "type" : "function",
 570       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 571       "sig" : "(eventName, handler, scope, options)",
 572       "static" : false,
 573       "memberOf" : "Roo.util.Observable",
 574       "isStatic" : false,
 575       "isConstructor" : false,
 576       "isPrivate" : false,
 577       "example" : "",
 578       "deprecated" : "",
 579       "since" : "",
 580       "see" : "",
 581       "exceptions" : "",
 582       "requires" : "",
 583       "params" : [
 584         {
 585           "name" : "eventName",
 586           "type" : "String",
 587           "desc" : "The type of event to listen for",
 588           "isOptional" : false
 589         },
 590         {
 591           "name" : "handler",
 592           "type" : "Function",
 593           "desc" : "The method the event invokes",
 594           "isOptional" : false
 595         },
 596         {
 597           "name" : "scope",
 598           "type" : "Object",
 599           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 600           "isOptional" : false
 601         },
 602         {
 603           "name" : "options",
 604           "type" : "Object",
 605           "desc" : "(optional)",
 606           "isOptional" : false
 607         }
 608       ],
 609       "returns" : []
 610     },
 611     {
 612       "name" : "un",
 613       "type" : "function",
 614       "desc" : "Removes a listener (shorthand for removeListener)",
 615       "sig" : "(eventName, handler, scope)",
 616       "static" : false,
 617       "memberOf" : "Roo.util.Observable",
 618       "isStatic" : false,
 619       "isConstructor" : false,
 620       "isPrivate" : false,
 621       "example" : "",
 622       "deprecated" : "",
 623       "since" : "",
 624       "see" : "",
 625       "exceptions" : "",
 626       "requires" : "",
 627       "params" : [
 628         {
 629           "name" : "eventName",
 630           "type" : "String",
 631           "desc" : "The type of event to listen for",
 632           "isOptional" : false
 633         },
 634         {
 635           "name" : "handler",
 636           "type" : "Function",
 637           "desc" : "The handler to remove",
 638           "isOptional" : false
 639         },
 640         {
 641           "name" : "scope",
 642           "type" : "Object",
 643           "desc" : "(optional) The scope (this object) for the handler",
 644           "isOptional" : false
 645         }
 646       ],
 647       "returns" : []
 648     },
 649     {
 650       "name" : "addEvents",
 651       "type" : "function",
 652       "desc" : "Used to define events on this Observable",
 653       "sig" : "(object)",
 654       "static" : false,
 655       "memberOf" : "Roo.util.Observable",
 656       "isStatic" : false,
 657       "isConstructor" : false,
 658       "isPrivate" : false,
 659       "example" : "",
 660       "deprecated" : "",
 661       "since" : "",
 662       "see" : "",
 663       "exceptions" : "",
 664       "requires" : "",
 665       "params" : [
 666         {
 667           "name" : "object",
 668           "type" : "Object",
 669           "desc" : "The object with the events defined",
 670           "isOptional" : false
 671         }
 672       ],
 673       "returns" : []
 674     },
 675     {
 676       "name" : "releaseCapture",
 677       "type" : "function",
 678       "desc" : "Removes <b>all</b> added captures from the Observable.",
 679       "sig" : "(o)",
 680       "static" : true,
 681       "memberOf" : "Roo.util.Observable",
 682       "isStatic" : true,
 683       "isConstructor" : false,
 684       "isPrivate" : false,
 685       "example" : "",
 686       "deprecated" : "",
 687       "since" : "",
 688       "see" : "",
 689       "exceptions" : "",
 690       "requires" : "",
 691       "params" : [
 692         {
 693           "name" : "o",
 694           "type" : "Observable",
 695           "desc" : "The Observable to release",
 696           "isOptional" : false
 697         }
 698       ],
 699       "returns" : []
 700     },
 701     {
 702       "name" : "removeListener",
 703       "type" : "function",
 704       "desc" : "Removes a listener",
 705       "sig" : "(eventName, handler, scope)",
 706       "static" : false,
 707       "memberOf" : "Roo.util.Observable",
 708       "isStatic" : false,
 709       "isConstructor" : false,
 710       "isPrivate" : false,
 711       "example" : "",
 712       "deprecated" : "",
 713       "since" : "",
 714       "see" : "",
 715       "exceptions" : "",
 716       "requires" : "",
 717       "params" : [
 718         {
 719           "name" : "eventName",
 720           "type" : "String",
 721           "desc" : "The type of event to listen for",
 722           "isOptional" : false
 723         },
 724         {
 725           "name" : "handler",
 726           "type" : "Function",
 727           "desc" : "The handler to remove",
 728           "isOptional" : false
 729         },
 730         {
 731           "name" : "scope",
 732           "type" : "Object",
 733           "desc" : "(optional) The scope (this object) for the handler",
 734           "isOptional" : false
 735         }
 736       ],
 737       "returns" : []
 738     },
 739     {
 740       "name" : "fireEvent",
 741       "type" : "function",
 742       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 743       "sig" : "(eventName, args)",
 744       "static" : false,
 745       "memberOf" : "Roo.util.Observable",
 746       "isStatic" : false,
 747       "isConstructor" : false,
 748       "isPrivate" : false,
 749       "example" : "",
 750       "deprecated" : "",
 751       "since" : "",
 752       "see" : "",
 753       "exceptions" : "",
 754       "requires" : "",
 755       "params" : [
 756         {
 757           "name" : "eventName",
 758           "type" : "String",
 759           "desc" : "",
 760           "isOptional" : false
 761         },
 762         {
 763           "name" : "args",
 764           "type" : "Object...",
 765           "desc" : "Variable number of parameters are passed to handlers",
 766           "isOptional" : false
 767         }
 768       ],
 769       "returns" : [
 770         {
 771           "name" : "",
 772           "type" : "Boolean",
 773           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 774         }
 775       ]
 776     },
 777     {
 778       "name" : "hasListener",
 779       "type" : "function",
 780       "desc" : "Checks to see if this object has any listeners for a specified event",
 781       "sig" : "(eventName)",
 782       "static" : false,
 783       "memberOf" : "Roo.util.Observable",
 784       "isStatic" : false,
 785       "isConstructor" : false,
 786       "isPrivate" : false,
 787       "example" : "",
 788       "deprecated" : "",
 789       "since" : "",
 790       "see" : "",
 791       "exceptions" : "",
 792       "requires" : "",
 793       "params" : [
 794         {
 795           "name" : "eventName",
 796           "type" : "String",
 797           "desc" : "The name of the event to check for",
 798           "isOptional" : false
 799         }
 800       ],
 801       "returns" : [
 802         {
 803           "name" : "",
 804           "type" : "Boolean",
 805           "desc" : "True if the event is being listened for, else false"
 806         }
 807       ]
 808     },
 809     {
 810       "name" : "capture",
 811       "type" : "function",
 812       "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.",
 813       "sig" : "(o, fn, scope)",
 814       "static" : true,
 815       "memberOf" : "Roo.util.Observable",
 816       "isStatic" : true,
 817       "isConstructor" : false,
 818       "isPrivate" : false,
 819       "example" : "",
 820       "deprecated" : "",
 821       "since" : "",
 822       "see" : "",
 823       "exceptions" : "",
 824       "requires" : "",
 825       "params" : [
 826         {
 827           "name" : "o",
 828           "type" : "Observable",
 829           "desc" : "The Observable to capture",
 830           "isOptional" : false
 831         },
 832         {
 833           "name" : "fn",
 834           "type" : "Function",
 835           "desc" : "The function to call",
 836           "isOptional" : false
 837         },
 838         {
 839           "name" : "scope",
 840           "type" : "Object",
 841           "desc" : "(optional) The scope (this object) for the fn",
 842           "isOptional" : false
 843         }
 844       ],
 845       "returns" : []
 846     },
 847     {
 848       "name" : "addListener",
 849       "type" : "function",
 850       "desc" : "Appends an event handler to this component",
 851       "sig" : "(eventName, handler, scope, options)",
 852       "static" : false,
 853       "memberOf" : "Roo.util.Observable",
 854       "isStatic" : false,
 855       "isConstructor" : false,
 856       "isPrivate" : false,
 857       "example" : "",
 858       "deprecated" : "",
 859       "since" : "",
 860       "see" : "",
 861       "exceptions" : "",
 862       "requires" : "",
 863       "params" : [
 864         {
 865           "name" : "eventName",
 866           "type" : "String",
 867           "desc" : "The type of event to listen for",
 868           "isOptional" : false
 869         },
 870         {
 871           "name" : "handler",
 872           "type" : "Function",
 873           "desc" : "The method the event invokes",
 874           "isOptional" : false
 875         },
 876         {
 877           "name" : "scope",
 878           "type" : "Object",
 879           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 880           "isOptional" : false
 881         },
 882         {
 883           "name" : "options",
 884           "type" : "Object",
 885           "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>",
 886           "isOptional" : false
 887         }
 888       ],
 889       "returns" : []
 890     }
 891   ],
 892   "events" : [
 893     {
 894       "name" : "beforerender",
 895       "type" : "function",
 896       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 897       "sig" : "function (_self)\n{\n\n}",
 898       "memberOf" : "",
 899       "example" : "",
 900       "deprecated" : "",
 901       "since" : "",
 902       "see" : "",
 903       "params" : [
 904         {
 905           "name" : "this",
 906           "type" : "Roo.Component",
 907           "desc" : "",
 908           "isOptional" : false
 909         }
 910       ],
 911       "returns" : []
 912     },
 913     {
 914       "name" : "disable",
 915       "type" : "function",
 916       "desc" : "Fires after the component is disabled.",
 917       "sig" : "function (_self)\n{\n\n}",
 918       "memberOf" : "",
 919       "example" : "",
 920       "deprecated" : "",
 921       "since" : "",
 922       "see" : "",
 923       "params" : [
 924         {
 925           "name" : "this",
 926           "type" : "Roo.Component",
 927           "desc" : "",
 928           "isOptional" : false
 929         }
 930       ],
 931       "returns" : []
 932     },
 933     {
 934       "name" : "render",
 935       "type" : "function",
 936       "desc" : "Fires after the component is rendered.",
 937       "sig" : "function (_self)\n{\n\n}",
 938       "memberOf" : "",
 939       "example" : "",
 940       "deprecated" : "",
 941       "since" : "",
 942       "see" : "",
 943       "params" : [
 944         {
 945           "name" : "this",
 946           "type" : "Roo.Component",
 947           "desc" : "",
 948           "isOptional" : false
 949         }
 950       ],
 951       "returns" : []
 952     },
 953     {
 954       "name" : "destroy",
 955       "type" : "function",
 956       "desc" : "Fires after the component is destroyed.",
 957       "sig" : "function (_self)\n{\n\n}",
 958       "memberOf" : "",
 959       "example" : "",
 960       "deprecated" : "",
 961       "since" : "",
 962       "see" : "",
 963       "params" : [
 964         {
 965           "name" : "this",
 966           "type" : "Roo.Component",
 967           "desc" : "",
 968           "isOptional" : false
 969         }
 970       ],
 971       "returns" : []
 972     },
 973     {
 974       "name" : "hide",
 975       "type" : "function",
 976       "desc" : "Fires after the component is hidden.",
 977       "sig" : "function (_self)\n{\n\n}",
 978       "memberOf" : "",
 979       "example" : "",
 980       "deprecated" : "",
 981       "since" : "",
 982       "see" : "",
 983       "params" : [
 984         {
 985           "name" : "this",
 986           "type" : "Roo.Component",
 987           "desc" : "",
 988           "isOptional" : false
 989         }
 990       ],
 991       "returns" : []
 992     },
 993     {
 994       "name" : "beforehide",
 995       "type" : "function",
 996       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
 997       "sig" : "function (_self)\n{\n\n}",
 998       "memberOf" : "",
 999       "example" : "",
1000       "deprecated" : "",
1001       "since" : "",
1002       "see" : "",
1003       "params" : [
1004         {
1005           "name" : "this",
1006           "type" : "Roo.Component",
1007           "desc" : "",
1008           "isOptional" : false
1009         }
1010       ],
1011       "returns" : []
1012     },
1013     {
1014       "name" : "show",
1015       "type" : "function",
1016       "desc" : "Fires after the component is shown.",
1017       "sig" : "function (_self)\n{\n\n}",
1018       "memberOf" : "",
1019       "example" : "",
1020       "deprecated" : "",
1021       "since" : "",
1022       "see" : "",
1023       "params" : [
1024         {
1025           "name" : "this",
1026           "type" : "Roo.Component",
1027           "desc" : "",
1028           "isOptional" : false
1029         }
1030       ],
1031       "returns" : []
1032     },
1033     {
1034       "name" : "beforeshow",
1035       "type" : "function",
1036       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1037       "sig" : "function (_self)\n{\n\n}",
1038       "memberOf" : "",
1039       "example" : "",
1040       "deprecated" : "",
1041       "since" : "",
1042       "see" : "",
1043       "params" : [
1044         {
1045           "name" : "this",
1046           "type" : "Roo.Component",
1047           "desc" : "",
1048           "isOptional" : false
1049         }
1050       ],
1051       "returns" : []
1052     },
1053     {
1054       "name" : "enable",
1055       "type" : "function",
1056       "desc" : "Fires after the component is enabled.",
1057       "sig" : "function (_self)\n{\n\n}",
1058       "memberOf" : "",
1059       "example" : "",
1060       "deprecated" : "",
1061       "since" : "",
1062       "see" : "",
1063       "params" : [
1064         {
1065           "name" : "this",
1066           "type" : "Roo.Component",
1067           "desc" : "",
1068           "isOptional" : false
1069         }
1070       ],
1071       "returns" : []
1072     },
1073     {
1074       "name" : "beforedestroy",
1075       "type" : "function",
1076       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1077       "sig" : "function (_self)\n{\n\n}",
1078       "memberOf" : "",
1079       "example" : "",
1080       "deprecated" : "",
1081       "since" : "",
1082       "see" : "",
1083       "params" : [
1084         {
1085           "name" : "this",
1086           "type" : "Roo.Component",
1087           "desc" : "",
1088           "isOptional" : false
1089         }
1090       ],
1091       "returns" : []
1092     }
1093   ]
1094 }