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