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

   1 {
   2   "name" : "Roo.bootstrap.Component",
   3   "augments" : [
   4     "Roo.Component",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {
   8     "Roo.bootstrap.nav.Bar" : [
   9       "Roo.bootstrap.nav.Sidebar",
  10       "Roo.bootstrap.nav.Simplebar"
  11     ],
  12     "Roo.bootstrap.nav.Simplebar" : [
  13       "Roo.bootstrap.PagingToolbar",
  14       "Roo.bootstrap.PopoverNav",
  15       "Roo.bootstrap.form.HtmlEditorToolbar.Context",
  16       "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
  17       "Roo.bootstrap.nav.Headerbar"
  18     ],
  19     "Roo.bootstrap.Button" : [
  20       "Roo.bootstrap.ButtonUploader",
  21       "Roo.bootstrap.form.CardUploader"
  22     ],
  23     "Roo.bootstrap.Column" : [
  24       "Roo.bootstrap.TabGroup"
  25     ],
  26     "Roo.bootstrap.form.TriggerField" : [
  27       "Roo.bootstrap.form.ComboBox",
  28       "Roo.bootstrap.form.PhoneInput"
  29     ],
  30     "Roo.bootstrap.form.TextArea" : [
  31       "Roo.bootstrap.form.HtmlEditor",
  32       "Roo.bootstrap.form.Markdown"
  33     ],
  34     "Roo.bootstrap.layout.Manager" : [
  35       "Roo.bootstrap.layout.Border"
  36     ],
  37     "Roo.bootstrap.Element" : [
  38       "Roo.bootstrap.CardFooter",
  39       "Roo.bootstrap.CardHeader",
  40       "Roo.bootstrap.CardImageTop",
  41       "Roo.bootstrap.DropTarget"
  42     ],
  43     "Roo.bootstrap.nav.Item" : [
  44       "Roo.bootstrap.nav.SidebarItem"
  45     ],
  46     "Roo.bootstrap.Component" : [
  47       "Roo.bootstrap.Alert",
  48       "Roo.bootstrap.BezierSignature",
  49       "Roo.bootstrap.Body",
  50       "Roo.bootstrap.Brick",
  51       "Roo.bootstrap.Button",
  52       "Roo.bootstrap.ButtonGroup",
  53       "Roo.bootstrap.Calendar",
  54       "Roo.bootstrap.Card",
  55       "Roo.bootstrap.Column",
  56       "Roo.bootstrap.Container",
  57       "Roo.bootstrap.DocumentManager",
  58       "Roo.bootstrap.DocumentSlider",
  59       "Roo.bootstrap.DocumentViewer",
  60       "Roo.bootstrap.Element",
  61       "Roo.bootstrap.Graph",
  62       "Roo.bootstrap.Header",
  63       "Roo.bootstrap.Img",
  64       "Roo.bootstrap.LayoutMasonry",
  65       "Roo.bootstrap.LayoutMasonryAuto",
  66       "Roo.bootstrap.Link",
  67       "Roo.bootstrap.LocationPicker",
  68       "Roo.bootstrap.MasonryBrick",
  69       "Roo.bootstrap.MessageBar",
  70       "Roo.bootstrap.Modal",
  71       "Roo.bootstrap.Pagination",
  72       "Roo.bootstrap.PaginationItem",
  73       "Roo.bootstrap.Popover",
  74       "Roo.bootstrap.Progress",
  75       "Roo.bootstrap.ProgressBar",
  76       "Roo.bootstrap.Row",
  77       "Roo.bootstrap.Slider",
  78       "Roo.bootstrap.TabPanel",
  79       "Roo.bootstrap.Table",
  80       "Roo.bootstrap.TableBody",
  81       "Roo.bootstrap.TableCell",
  82       "Roo.bootstrap.TableRow",
  83       "Roo.bootstrap.UploadCropbox",
  84       "Roo.bootstrap.breadcrumb.Item",
  85       "Roo.bootstrap.breadcrumb.Nav",
  86       "Roo.bootstrap.dash.NumberBox",
  87       "Roo.bootstrap.dash.TabBox",
  88       "Roo.bootstrap.dash.TabPane",
  89       "Roo.bootstrap.form.DateSplitField",
  90       "Roo.bootstrap.form.FieldLabel",
  91       "Roo.bootstrap.form.Form",
  92       "Roo.bootstrap.form.Input",
  93       "Roo.bootstrap.form.Radio",
  94       "Roo.bootstrap.layout.Manager",
  95       "Roo.bootstrap.menu.Item",
  96       "Roo.bootstrap.menu.Menu",
  97       "Roo.bootstrap.menu.Separator",
  98       "Roo.bootstrap.nav.Bar",
  99       "Roo.bootstrap.nav.Group",
 100       "Roo.bootstrap.nav.Item",
 101       "Roo.bootstrap.nav.ProgressBar",
 102       "Roo.bootstrap.nav.ProgressBarItem"
 103     ],
 104     "Roo.bootstrap.form.ComboBox" : [
 105       "Roo.bootstrap.form.MoneyField"
 106     ],
 107     "Roo.bootstrap.form.Input" : [
 108       "Roo.bootstrap.form.CheckBox",
 109       "Roo.bootstrap.form.DateField",
 110       "Roo.bootstrap.form.MonthField",
 111       "Roo.bootstrap.form.NumberField",
 112       "Roo.bootstrap.form.RadioSet",
 113       "Roo.bootstrap.form.SecurePass",
 114       "Roo.bootstrap.form.TextArea",
 115       "Roo.bootstrap.form.TimeField",
 116       "Roo.bootstrap.form.TriggerField"
 117     ]
 118   },
 119   "tree_children" : [
 120     "Roo.bootstrap.Alert",
 121     "Roo.bootstrap.BezierSignature",
 122     "Roo.bootstrap.Brick",
 123     "Roo.bootstrap.Button",
 124     "Roo.bootstrap.ButtonGroup",
 125     "Roo.bootstrap.ButtonUploader",
 126     "Roo.bootstrap.Calendar",
 127     "Roo.bootstrap.Card",
 128     "Roo.bootstrap.Column",
 129     "Roo.bootstrap.DocumentManager",
 130     "Roo.bootstrap.DocumentSlider",
 131     "Roo.bootstrap.DocumentViewer",
 132     "Roo.bootstrap.DropTarget",
 133     "Roo.bootstrap.Element",
 134     "Roo.bootstrap.Graph",
 135     "Roo.bootstrap.Header",
 136     "Roo.bootstrap.Img",
 137     "Roo.bootstrap.LayoutMasonry",
 138     "Roo.bootstrap.LayoutMasonryAuto",
 139     "Roo.bootstrap.Link",
 140     "Roo.bootstrap.LocationPicker",
 141     "Roo.bootstrap.MasonryBrick",
 142     "Roo.bootstrap.MessageBar",
 143     "Roo.bootstrap.Pagination",
 144     "Roo.bootstrap.PaginationItem",
 145     "Roo.bootstrap.PagingToolbar",
 146     "Roo.bootstrap.Progress",
 147     "Roo.bootstrap.ProgressBar",
 148     "Roo.bootstrap.Row",
 149     "Roo.bootstrap.Slider",
 150     "Roo.bootstrap.TabGroup",
 151     "Roo.bootstrap.TabPanel",
 152     "Roo.bootstrap.Table",
 153     "Roo.bootstrap.UploadCropbox",
 154     "Roo.bootstrap.breadcrumb.Nav",
 155     "Roo.bootstrap.dash.NumberBox",
 156     "Roo.bootstrap.dash.TabBox",
 157     "Roo.bootstrap.dash.TabPane",
 158     "Roo.bootstrap.form.CardUploader",
 159     "Roo.bootstrap.form.CheckBox",
 160     "Roo.bootstrap.form.ComboBox",
 161     "Roo.bootstrap.form.DateField",
 162     "Roo.bootstrap.form.DateSplitField",
 163     "Roo.bootstrap.form.FieldLabel",
 164     "Roo.bootstrap.form.Form",
 165     "Roo.bootstrap.form.HtmlEditor",
 166     "Roo.bootstrap.form.Input",
 167     "Roo.bootstrap.form.Markdown",
 168     "Roo.bootstrap.form.MoneyField",
 169     "Roo.bootstrap.form.MonthField",
 170     "Roo.bootstrap.form.NumberField",
 171     "Roo.bootstrap.form.PhoneInput",
 172     "Roo.bootstrap.form.Radio",
 173     "Roo.bootstrap.form.RadioSet",
 174     "Roo.bootstrap.form.SecurePass",
 175     "Roo.bootstrap.form.TextArea",
 176     "Roo.bootstrap.form.TimeField",
 177     "Roo.bootstrap.form.TriggerField",
 178     "Roo.bootstrap.nav.Group",
 179     "Roo.bootstrap.nav.Headerbar",
 180     "Roo.bootstrap.nav.ProgressBar",
 181     "Roo.bootstrap.nav.ProgressBarItem",
 182     "Roo.bootstrap.nav.Sidebar",
 183     "Roo.bootstrap.nav.SidebarItem",
 184     "Roo.bootstrap.nav.Simplebar"
 185   ],
 186   "tree_parent" : [],
 187   "desc" : "Bootstrap Component base class",
 188   "isSingleton" : false,
 189   "isStatic" : false,
 190   "isBuiltin" : false,
 191   "isAbstract" : true,
 192   "isBuilderTop" : false,
 193   "memberOf" : "Component",
 194   "example" : "",
 195   "deprecated" : "",
 196   "since" : "",
 197   "see" : "",
 198   "params" : [
 199     {
 200       "name" : "config",
 201       "type" : "Object",
 202       "desc" : "The config object",
 203       "isOptional" : false
 204     }
 205   ],
 206   "returns" : [],
 207   "throws" : "",
 208   "requires" : "",
 209   "config" : [
 210     {
 211       "name" : "listeners",
 212       "type" : "Object",
 213       "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>",
 214       "memberOf" : "Roo.util.Observable",
 215       "isOptional" : false,
 216       "optvals" : []
 217     },
 218     {
 219       "name" : "tooltip",
 220       "type" : "string",
 221       "desc" : "Text for the tooltip",
 222       "memberOf" : "",
 223       "isOptional" : false,
 224       "optvals" : []
 225     },
 226     {
 227       "name" : "container_method",
 228       "type" : "string",
 229       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
 230       "memberOf" : "",
 231       "isOptional" : false,
 232       "optvals" : []
 233     },
 234     {
 235       "name" : "visibilityEl",
 236       "type" : "string|object",
 237       "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
 238       "memberOf" : "",
 239       "isOptional" : false,
 240       "optvals" : [
 241         "el",
 242         "parent"
 243       ]
 244     },
 245     {
 246       "name" : "can_build_overlaid",
 247       "type" : "Boolean",
 248       "desc" : "True if element can be rebuild from a HTML page",
 249       "memberOf" : "",
 250       "isOptional" : false,
 251       "optvals" : []
 252     },
 253     {
 254       "name" : "hideMode",
 255       "type" : "String",
 256       "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",
 257       "memberOf" : "Roo.Component",
 258       "isOptional" : false,
 259       "optvals" : [
 260         "display",
 261         "visibility"
 262       ]
 263     },
 264     {
 265       "name" : "style",
 266       "type" : "String",
 267       "desc" : "any extra css",
 268       "memberOf" : "",
 269       "isOptional" : false,
 270       "optvals" : []
 271     },
 272     {
 273       "name" : "allowDomMove",
 274       "type" : "Boolean",
 275       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 276       "memberOf" : "Roo.Component",
 277       "isOptional" : false,
 278       "optvals" : []
 279     },
 280     {
 281       "name" : "cls",
 282       "type" : "String",
 283       "desc" : "css class",
 284       "memberOf" : "",
 285       "isOptional" : false,
 286       "optvals" : []
 287     },
 288     {
 289       "name" : "xattr",
 290       "type" : "Object",
 291       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 292       "memberOf" : "",
 293       "isOptional" : false,
 294       "optvals" : []
 295     },
 296     {
 297       "name" : "actionMode",
 298       "type" : "String",
 299       "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",
 300       "memberOf" : "Roo.Component",
 301       "isOptional" : false,
 302       "optvals" : []
 303     },
 304     {
 305       "name" : "dataId",
 306       "type" : "string",
 307       "desc" : "cutomer id",
 308       "memberOf" : "",
 309       "isOptional" : false,
 310       "optvals" : []
 311     },
 312     {
 313       "name" : "name",
 314       "type" : "string",
 315       "desc" : "Specifies name attribute",
 316       "memberOf" : "",
 317       "isOptional" : false,
 318       "optvals" : []
 319     },
 320     {
 321       "name" : "disableClass",
 322       "type" : "String",
 323       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 324       "memberOf" : "Roo.Component",
 325       "isOptional" : false,
 326       "optvals" : []
 327     }
 328   ],
 329   "methods" : [
 330     {
 331       "name" : "tooltipEl",
 332       "type" : "function",
 333       "desc" : "Fetch the element to display the tooltip on.",
 334       "sig" : "()\n{\n\n}",
 335       "static" : false,
 336       "memberOf" : "",
 337       "isStatic" : false,
 338       "isConstructor" : false,
 339       "isPrivate" : false,
 340       "example" : "",
 341       "deprecated" : "",
 342       "since" : "",
 343       "see" : "",
 344       "exceptions" : "",
 345       "requires" : "",
 346       "params" : [],
 347       "returns" : [
 348         {
 349           "name" : "",
 350           "type" : "Roo.Element",
 351           "desc" : "defaults to this.el"
 352         }
 353       ]
 354     },
 355     {
 356       "name" : "hide",
 357       "type" : "function",
 358       "desc" : "Hide a component - adds 'hidden' class",
 359       "sig" : "()\n{\n\n}",
 360       "static" : false,
 361       "memberOf" : "",
 362       "isStatic" : false,
 363       "isConstructor" : false,
 364       "isPrivate" : false,
 365       "example" : "",
 366       "deprecated" : "",
 367       "since" : "",
 368       "see" : "",
 369       "exceptions" : "",
 370       "requires" : "",
 371       "params" : [],
 372       "returns" : []
 373     },
 374     {
 375       "name" : "show",
 376       "type" : "function",
 377       "desc" : "Show a component - removes 'hidden' class",
 378       "sig" : "()\n{\n\n}",
 379       "static" : false,
 380       "memberOf" : "",
 381       "isStatic" : false,
 382       "isConstructor" : false,
 383       "isPrivate" : false,
 384       "example" : "",
 385       "deprecated" : "",
 386       "since" : "",
 387       "see" : "",
 388       "exceptions" : "",
 389       "requires" : "",
 390       "params" : [],
 391       "returns" : []
 392     },
 393     {
 394       "name" : "setVisibilityEl",
 395       "type" : "function",
 396       "desc" : "Set the element that will be used to show or hide",
 397       "sig" : "()\n{\n\n}",
 398       "static" : false,
 399       "memberOf" : "",
 400       "isStatic" : false,
 401       "isConstructor" : false,
 402       "isPrivate" : false,
 403       "example" : "",
 404       "deprecated" : "",
 405       "since" : "",
 406       "see" : "",
 407       "exceptions" : "",
 408       "requires" : "",
 409       "params" : [],
 410       "returns" : []
 411     },
 412     {
 413       "name" : "getVisibilityEl",
 414       "type" : "function",
 415       "desc" : "Get the element that will be used to show or hide",
 416       "sig" : "()\n{\n\n}",
 417       "static" : false,
 418       "memberOf" : "",
 419       "isStatic" : false,
 420       "isConstructor" : false,
 421       "isPrivate" : false,
 422       "example" : "",
 423       "deprecated" : "",
 424       "since" : "",
 425       "see" : "",
 426       "exceptions" : "",
 427       "requires" : "",
 428       "params" : [],
 429       "returns" : []
 430     },
 431     {
 432       "name" : "initEvents",
 433       "type" : "function",
 434       "desc" : "Initialize Events for the element",
 435       "sig" : "()\n{\n\n}",
 436       "static" : false,
 437       "memberOf" : "",
 438       "isStatic" : false,
 439       "isConstructor" : false,
 440       "isPrivate" : false,
 441       "example" : "",
 442       "deprecated" : "",
 443       "since" : "",
 444       "see" : "",
 445       "exceptions" : "",
 446       "requires" : "",
 447       "params" : [],
 448       "returns" : []
 449     },
 450     {
 451       "name" : "getChildContainer",
 452       "type" : "function",
 453       "desc" : "Fetch the element to add children to",
 454       "sig" : "()\n{\n\n}",
 455       "static" : false,
 456       "memberOf" : "",
 457       "isStatic" : false,
 458       "isConstructor" : false,
 459       "isPrivate" : false,
 460       "example" : "",
 461       "deprecated" : "",
 462       "since" : "",
 463       "see" : "",
 464       "exceptions" : "",
 465       "requires" : "",
 466       "params" : [],
 467       "returns" : [
 468         {
 469           "name" : "",
 470           "type" : "Roo.Element",
 471           "desc" : "defaults to this.el"
 472         }
 473       ]
 474     },
 475     {
 476       "name" : "getId",
 477       "type" : "function",
 478       "desc" : "Returns the id of this component.",
 479       "sig" : "()\n{\n\n}",
 480       "static" : false,
 481       "memberOf" : "Roo.Component",
 482       "isStatic" : false,
 483       "isConstructor" : false,
 484       "isPrivate" : false,
 485       "example" : "",
 486       "deprecated" : "",
 487       "since" : "",
 488       "see" : "",
 489       "exceptions" : "",
 490       "requires" : "",
 491       "params" : [],
 492       "returns" : [
 493         {
 494           "name" : "",
 495           "type" : "String",
 496           "desc" : ""
 497         }
 498       ]
 499     },
 500     {
 501       "name" : "render",
 502       "type" : "function",
 503       "desc" : "If this is a lazy rendering component, render it to its container element.",
 504       "sig" : "(container)",
 505       "static" : false,
 506       "memberOf" : "Roo.Component",
 507       "isStatic" : false,
 508       "isConstructor" : false,
 509       "isPrivate" : false,
 510       "example" : "",
 511       "deprecated" : "",
 512       "since" : "",
 513       "see" : "",
 514       "exceptions" : "",
 515       "requires" : "",
 516       "params" : [
 517         {
 518           "name" : "container",
 519           "type" : "String/HTMLElement/Element",
 520           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 521           "isOptional" : false
 522         }
 523       ],
 524       "returns" : []
 525     },
 526     {
 527       "name" : "destroy",
 528       "type" : "function",
 529       "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}.",
 530       "sig" : "()\n{\n\n}",
 531       "static" : false,
 532       "memberOf" : "Roo.Component",
 533       "isStatic" : false,
 534       "isConstructor" : false,
 535       "isPrivate" : false,
 536       "example" : "",
 537       "deprecated" : "",
 538       "since" : "",
 539       "see" : "",
 540       "exceptions" : "",
 541       "requires" : "",
 542       "params" : [],
 543       "returns" : []
 544     },
 545     {
 546       "name" : "isVisible",
 547       "type" : "function",
 548       "desc" : "Returns true if this component is visible.",
 549       "sig" : "()\n{\n\n}",
 550       "static" : false,
 551       "memberOf" : "Roo.Component",
 552       "isStatic" : false,
 553       "isConstructor" : false,
 554       "isPrivate" : false,
 555       "example" : "",
 556       "deprecated" : "",
 557       "since" : "",
 558       "see" : "",
 559       "exceptions" : "",
 560       "requires" : "",
 561       "params" : [],
 562       "returns" : []
 563     },
 564     {
 565       "name" : "setDisabled",
 566       "type" : "function",
 567       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 568       "sig" : "(disabled)",
 569       "static" : false,
 570       "memberOf" : "Roo.Component",
 571       "isStatic" : false,
 572       "isConstructor" : false,
 573       "isPrivate" : false,
 574       "example" : "",
 575       "deprecated" : "",
 576       "since" : "",
 577       "see" : "",
 578       "exceptions" : "",
 579       "requires" : "",
 580       "params" : [
 581         {
 582           "name" : "disabled",
 583           "type" : "Boolean",
 584           "desc" : "",
 585           "isOptional" : false
 586         }
 587       ],
 588       "returns" : []
 589     },
 590     {
 591       "name" : "focus",
 592       "type" : "function",
 593       "desc" : "Try to focus this component.",
 594       "sig" : "(selectText)",
 595       "static" : false,
 596       "memberOf" : "Roo.Component",
 597       "isStatic" : false,
 598       "isConstructor" : false,
 599       "isPrivate" : false,
 600       "example" : "",
 601       "deprecated" : "",
 602       "since" : "",
 603       "see" : "",
 604       "exceptions" : "",
 605       "requires" : "",
 606       "params" : [
 607         {
 608           "name" : "selectText",
 609           "type" : "Boolean",
 610           "desc" : "True to also select the text in this component (if applicable)",
 611           "isOptional" : false
 612         }
 613       ],
 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" : "childrenrendered",
1076       "type" : "function",
1077       "desc" : "Fires when the children have been rendered..",
1078       "sig" : "function (_self)\n{\n\n}",
1079       "memberOf" : "",
1080       "example" : "",
1081       "deprecated" : "",
1082       "since" : "",
1083       "see" : "",
1084       "params" : [
1085         {
1086           "name" : "this",
1087           "type" : "Roo.bootstrap.Component",
1088           "desc" : "",
1089           "isOptional" : false
1090         }
1091       ],
1092       "returns" : []
1093     },
1094     {
1095       "name" : "beforerender",
1096       "type" : "function",
1097       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1098       "sig" : "function (_self)\n{\n\n}",
1099       "memberOf" : "Roo.Component",
1100       "example" : "",
1101       "deprecated" : "",
1102       "since" : "",
1103       "see" : "",
1104       "params" : [
1105         {
1106           "name" : "this",
1107           "type" : "Roo.Component",
1108           "desc" : "",
1109           "isOptional" : false
1110         }
1111       ],
1112       "returns" : []
1113     },
1114     {
1115       "name" : "disable",
1116       "type" : "function",
1117       "desc" : "Fires after the component is disabled.",
1118       "sig" : "function (_self)\n{\n\n}",
1119       "memberOf" : "Roo.Component",
1120       "example" : "",
1121       "deprecated" : "",
1122       "since" : "",
1123       "see" : "",
1124       "params" : [
1125         {
1126           "name" : "this",
1127           "type" : "Roo.Component",
1128           "desc" : "",
1129           "isOptional" : false
1130         }
1131       ],
1132       "returns" : []
1133     },
1134     {
1135       "name" : "render",
1136       "type" : "function",
1137       "desc" : "Fires after the component is rendered.",
1138       "sig" : "function (_self)\n{\n\n}",
1139       "memberOf" : "Roo.Component",
1140       "example" : "",
1141       "deprecated" : "",
1142       "since" : "",
1143       "see" : "",
1144       "params" : [
1145         {
1146           "name" : "this",
1147           "type" : "Roo.Component",
1148           "desc" : "",
1149           "isOptional" : false
1150         }
1151       ],
1152       "returns" : []
1153     },
1154     {
1155       "name" : "destroy",
1156       "type" : "function",
1157       "desc" : "Fires after the component is destroyed.",
1158       "sig" : "function (_self)\n{\n\n}",
1159       "memberOf" : "Roo.Component",
1160       "example" : "",
1161       "deprecated" : "",
1162       "since" : "",
1163       "see" : "",
1164       "params" : [
1165         {
1166           "name" : "this",
1167           "type" : "Roo.Component",
1168           "desc" : "",
1169           "isOptional" : false
1170         }
1171       ],
1172       "returns" : []
1173     },
1174     {
1175       "name" : "hide",
1176       "type" : "function",
1177       "desc" : "Fires after the component is hidden.",
1178       "sig" : "function (_self)\n{\n\n}",
1179       "memberOf" : "Roo.Component",
1180       "example" : "",
1181       "deprecated" : "",
1182       "since" : "",
1183       "see" : "",
1184       "params" : [
1185         {
1186           "name" : "this",
1187           "type" : "Roo.Component",
1188           "desc" : "",
1189           "isOptional" : false
1190         }
1191       ],
1192       "returns" : []
1193     },
1194     {
1195       "name" : "beforehide",
1196       "type" : "function",
1197       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1198       "sig" : "function (_self)\n{\n\n}",
1199       "memberOf" : "Roo.Component",
1200       "example" : "",
1201       "deprecated" : "",
1202       "since" : "",
1203       "see" : "",
1204       "params" : [
1205         {
1206           "name" : "this",
1207           "type" : "Roo.Component",
1208           "desc" : "",
1209           "isOptional" : false
1210         }
1211       ],
1212       "returns" : []
1213     },
1214     {
1215       "name" : "show",
1216       "type" : "function",
1217       "desc" : "Fires after the component is shown.",
1218       "sig" : "function (_self)\n{\n\n}",
1219       "memberOf" : "Roo.Component",
1220       "example" : "",
1221       "deprecated" : "",
1222       "since" : "",
1223       "see" : "",
1224       "params" : [
1225         {
1226           "name" : "this",
1227           "type" : "Roo.Component",
1228           "desc" : "",
1229           "isOptional" : false
1230         }
1231       ],
1232       "returns" : []
1233     },
1234     {
1235       "name" : "beforeshow",
1236       "type" : "function",
1237       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1238       "sig" : "function (_self)\n{\n\n}",
1239       "memberOf" : "Roo.Component",
1240       "example" : "",
1241       "deprecated" : "",
1242       "since" : "",
1243       "see" : "",
1244       "params" : [
1245         {
1246           "name" : "this",
1247           "type" : "Roo.Component",
1248           "desc" : "",
1249           "isOptional" : false
1250         }
1251       ],
1252       "returns" : []
1253     },
1254     {
1255       "name" : "enable",
1256       "type" : "function",
1257       "desc" : "Fires after the component is enabled.",
1258       "sig" : "function (_self)\n{\n\n}",
1259       "memberOf" : "Roo.Component",
1260       "example" : "",
1261       "deprecated" : "",
1262       "since" : "",
1263       "see" : "",
1264       "params" : [
1265         {
1266           "name" : "this",
1267           "type" : "Roo.Component",
1268           "desc" : "",
1269           "isOptional" : false
1270         }
1271       ],
1272       "returns" : []
1273     },
1274     {
1275       "name" : "beforedestroy",
1276       "type" : "function",
1277       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1278       "sig" : "function (_self)\n{\n\n}",
1279       "memberOf" : "Roo.Component",
1280       "example" : "",
1281       "deprecated" : "",
1282       "since" : "",
1283       "see" : "",
1284       "params" : [
1285         {
1286           "name" : "this",
1287           "type" : "Roo.Component",
1288           "desc" : "",
1289           "isOptional" : false
1290         }
1291       ],
1292       "returns" : []
1293     }
1294   ]
1295 }