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

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