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

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