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