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

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