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

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