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" : "tooltipEl",
 334       "desc" : "Fetch the element to display the tooltip on.",
 335       "isStatic" : false,
 336       "isConstructor" : false,
 337       "isPrivate" : false,
 338       "memberOf" : "Roo.bootstrap.Component",
 339       "example" : "",
 340       "deprecated" : "",
 341       "since" : "",
 342       "see" : "",
 343       "params" : [
 344       ],
 345       "returns" : [
 346         {
 347           "name" : "",
 348           "type" : "Roo.Element",
 349           "desc" : "defaults to this.el"
 350         }
 351       ]
 352     },
 353     {
 354       "name" : "hide",
 355       "desc" : "Hide a component - adds 'hidden' class",
 356       "isStatic" : false,
 357       "isConstructor" : false,
 358       "isPrivate" : false,
 359       "memberOf" : "Roo.bootstrap.Component",
 360       "example" : "",
 361       "deprecated" : "",
 362       "since" : "",
 363       "see" : "",
 364       "params" : [
 365       ],
 366       "returns" : [
 367       ]
 368     },
 369     {
 370       "name" : "show",
 371       "desc" : "Show a component - removes 'hidden' class",
 372       "isStatic" : false,
 373       "isConstructor" : false,
 374       "isPrivate" : false,
 375       "memberOf" : "Roo.bootstrap.Component",
 376       "example" : "",
 377       "deprecated" : "",
 378       "since" : "",
 379       "see" : "",
 380       "params" : [
 381       ],
 382       "returns" : [
 383       ]
 384     },
 385     {
 386       "name" : "setVisibilityEl",
 387       "desc" : "Set the element that will be used to show or hide",
 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" : "getVisibilityEl",
 403       "desc" : "Get the element that will be used to show or hide",
 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" : "initEvents",
 419       "desc" : "Initialize Events for the element",
 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" : "getChildContainer",
 435       "desc" : "Fetch the element to add children to",
 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           "name" : "",
 449           "type" : "Roo.Element",
 450           "desc" : "defaults to this.el"
 451         }
 452       ]
 453     },
 454     {
 455       "name" : "getId",
 456       "desc" : "Returns the id of this component.",
 457       "isStatic" : false,
 458       "isConstructor" : false,
 459       "isPrivate" : false,
 460       "memberOf" : "Roo.Component",
 461       "example" : "",
 462       "deprecated" : "",
 463       "since" : "",
 464       "see" : "",
 465       "params" : [
 466       ],
 467       "returns" : [
 468         {
 469           "name" : "",
 470           "type" : "String",
 471           "desc" : ""
 472         }
 473       ]
 474     },
 475     {
 476       "name" : "render",
 477       "desc" : "If this is a lazy rendering component, render it to its container element.",
 478       "isStatic" : false,
 479       "isConstructor" : false,
 480       "isPrivate" : false,
 481       "memberOf" : "Roo.Component",
 482       "example" : "",
 483       "deprecated" : "",
 484       "since" : "",
 485       "see" : "",
 486       "params" : [
 487         {
 488           "name" : "container",
 489           "type" : "String/HTMLElement/Element",
 490           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 491           "isOptional" : false
 492         }
 493       ],
 494       "returns" : [
 495       ]
 496     },
 497     {
 498       "name" : "destroy",
 499       "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}.",
 500       "isStatic" : false,
 501       "isConstructor" : false,
 502       "isPrivate" : false,
 503       "memberOf" : "Roo.Component",
 504       "example" : "",
 505       "deprecated" : "",
 506       "since" : "",
 507       "see" : "",
 508       "params" : [
 509       ],
 510       "returns" : [
 511       ]
 512     },
 513     {
 514       "name" : "isVisible",
 515       "desc" : "Returns true if this component is visible.",
 516       "isStatic" : false,
 517       "isConstructor" : false,
 518       "isPrivate" : false,
 519       "memberOf" : "Roo.Component",
 520       "example" : "",
 521       "deprecated" : "",
 522       "since" : "",
 523       "see" : "",
 524       "params" : [
 525       ],
 526       "returns" : [
 527       ]
 528     },
 529     {
 530       "name" : "setDisabled",
 531       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 532       "isStatic" : false,
 533       "isConstructor" : false,
 534       "isPrivate" : false,
 535       "memberOf" : "Roo.Component",
 536       "example" : "",
 537       "deprecated" : "",
 538       "since" : "",
 539       "see" : "",
 540       "params" : [
 541         {
 542           "name" : "disabled",
 543           "type" : "Boolean",
 544           "desc" : "",
 545           "isOptional" : false
 546         }
 547       ],
 548       "returns" : [
 549       ]
 550     },
 551     {
 552       "name" : "focus",
 553       "desc" : "Try to focus this component.",
 554       "isStatic" : false,
 555       "isConstructor" : false,
 556       "isPrivate" : false,
 557       "memberOf" : "Roo.Component",
 558       "example" : "",
 559       "deprecated" : "",
 560       "since" : "",
 561       "see" : "",
 562       "params" : [
 563         {
 564           "name" : "selectText",
 565           "type" : "Boolean",
 566           "desc" : "True to also select the text in this component (if applicable)",
 567           "isOptional" : false
 568         }
 569       ],
 570       "returns" : [
 571         {
 572           "name" : "",
 573           "type" : "Roo.Component",
 574           "desc" : "this"
 575         }
 576       ]
 577     },
 578     {
 579       "name" : "enable",
 580       "desc" : "Enable this component.",
 581       "isStatic" : false,
 582       "isConstructor" : false,
 583       "isPrivate" : false,
 584       "memberOf" : "Roo.Component",
 585       "example" : "",
 586       "deprecated" : "",
 587       "since" : "",
 588       "see" : "",
 589       "params" : [
 590       ],
 591       "returns" : [
 592         {
 593           "name" : "",
 594           "type" : "Roo.Component",
 595           "desc" : "this"
 596         }
 597       ]
 598     },
 599     {
 600       "name" : "setVisible",
 601       "desc" : "Convenience function to hide or show this component by boolean.",
 602       "isStatic" : false,
 603       "isConstructor" : false,
 604       "isPrivate" : false,
 605       "memberOf" : "Roo.Component",
 606       "example" : "",
 607       "deprecated" : "",
 608       "since" : "",
 609       "see" : "",
 610       "params" : [
 611         {
 612           "name" : "visible",
 613           "type" : "Boolean",
 614           "desc" : "True to show, false to hide",
 615           "isOptional" : false
 616         }
 617       ],
 618       "returns" : [
 619         {
 620           "name" : "",
 621           "type" : "Roo.Component",
 622           "desc" : "this"
 623         }
 624       ]
 625     },
 626     {
 627       "name" : "disable",
 628       "desc" : "Disable this component.",
 629       "isStatic" : false,
 630       "isConstructor" : false,
 631       "isPrivate" : false,
 632       "memberOf" : "Roo.Component",
 633       "example" : "",
 634       "deprecated" : "",
 635       "since" : "",
 636       "see" : "",
 637       "params" : [
 638       ],
 639       "returns" : [
 640         {
 641           "name" : "",
 642           "type" : "Roo.Component",
 643           "desc" : "this"
 644         }
 645       ]
 646     },
 647     {
 648       "name" : "getEl",
 649       "desc" : "Returns the underlying {@link Roo.Element}.",
 650       "isStatic" : false,
 651       "isConstructor" : false,
 652       "isPrivate" : false,
 653       "memberOf" : "Roo.Component",
 654       "example" : "",
 655       "deprecated" : "",
 656       "since" : "",
 657       "see" : "",
 658       "params" : [
 659       ],
 660       "returns" : [
 661         {
 662           "name" : "",
 663           "type" : "Roo.Element",
 664           "desc" : "The element"
 665         }
 666       ]
 667     },
 668     {
 669       "name" : "purgeListeners",
 670       "desc" : "Removes all listeners for this object",
 671       "isStatic" : false,
 672       "isConstructor" : false,
 673       "isPrivate" : false,
 674       "memberOf" : "Roo.util.Observable",
 675       "example" : "",
 676       "deprecated" : "",
 677       "since" : "",
 678       "see" : "",
 679       "params" : [
 680       ],
 681       "returns" : [
 682       ]
 683     },
 684     {
 685       "name" : "on",
 686       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 687       "isStatic" : false,
 688       "isConstructor" : false,
 689       "isPrivate" : false,
 690       "memberOf" : "Roo.util.Observable",
 691       "example" : "",
 692       "deprecated" : "",
 693       "since" : "",
 694       "see" : "",
 695       "params" : [
 696         {
 697           "name" : "eventName",
 698           "type" : "String",
 699           "desc" : "The type of event to listen for",
 700           "isOptional" : false
 701         },
 702         {
 703           "name" : "handler",
 704           "type" : "Function",
 705           "desc" : "The method the event invokes",
 706           "isOptional" : false
 707         },
 708         {
 709           "name" : "scope",
 710           "type" : "Object",
 711           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 712           "isOptional" : false
 713         },
 714         {
 715           "name" : "options",
 716           "type" : "Object",
 717           "desc" : "(optional)",
 718           "isOptional" : false
 719         }
 720       ],
 721       "returns" : [
 722       ]
 723     },
 724     {
 725       "name" : "un",
 726       "desc" : "Removes a listener (shorthand for removeListener)",
 727       "isStatic" : false,
 728       "isConstructor" : false,
 729       "isPrivate" : false,
 730       "memberOf" : "Roo.util.Observable",
 731       "example" : "",
 732       "deprecated" : "",
 733       "since" : "",
 734       "see" : "",
 735       "params" : [
 736         {
 737           "name" : "eventName",
 738           "type" : "String",
 739           "desc" : "The type of event to listen for",
 740           "isOptional" : false
 741         },
 742         {
 743           "name" : "handler",
 744           "type" : "Function",
 745           "desc" : "The handler to remove",
 746           "isOptional" : false
 747         },
 748         {
 749           "name" : "scope",
 750           "type" : "Object",
 751           "desc" : "(optional) The scope (this object) for the handler",
 752           "isOptional" : false
 753         }
 754       ],
 755       "returns" : [
 756       ]
 757     },
 758     {
 759       "name" : "addEvents",
 760       "desc" : "Used to define events on this Observable",
 761       "isStatic" : false,
 762       "isConstructor" : false,
 763       "isPrivate" : false,
 764       "memberOf" : "Roo.util.Observable",
 765       "example" : "",
 766       "deprecated" : "",
 767       "since" : "",
 768       "see" : "",
 769       "params" : [
 770         {
 771           "name" : "object",
 772           "type" : "Object",
 773           "desc" : "The object with the events defined",
 774           "isOptional" : false
 775         }
 776       ],
 777       "returns" : [
 778       ]
 779     },
 780     {
 781       "name" : "releaseCapture",
 782       "desc" : "Removes <b>all</b> added captures from the Observable.",
 783       "isStatic" : true,
 784       "isConstructor" : false,
 785       "isPrivate" : false,
 786       "memberOf" : "Roo.util.Observable",
 787       "example" : "",
 788       "deprecated" : "",
 789       "since" : "",
 790       "see" : "",
 791       "params" : [
 792         {
 793           "name" : "o",
 794           "type" : "Observable",
 795           "desc" : "The Observable to release",
 796           "isOptional" : false
 797         }
 798       ],
 799       "returns" : [
 800       ]
 801     },
 802     {
 803       "name" : "removeListener",
 804       "desc" : "Removes a listener",
 805       "isStatic" : false,
 806       "isConstructor" : false,
 807       "isPrivate" : false,
 808       "memberOf" : "Roo.util.Observable",
 809       "example" : "",
 810       "deprecated" : "",
 811       "since" : "",
 812       "see" : "",
 813       "params" : [
 814         {
 815           "name" : "eventName",
 816           "type" : "String",
 817           "desc" : "The type of event to listen for",
 818           "isOptional" : false
 819         },
 820         {
 821           "name" : "handler",
 822           "type" : "Function",
 823           "desc" : "The handler to remove",
 824           "isOptional" : false
 825         },
 826         {
 827           "name" : "scope",
 828           "type" : "Object",
 829           "desc" : "(optional) The scope (this object) for the handler",
 830           "isOptional" : false
 831         }
 832       ],
 833       "returns" : [
 834       ]
 835     },
 836     {
 837       "name" : "fireEvent",
 838       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 839       "isStatic" : false,
 840       "isConstructor" : false,
 841       "isPrivate" : false,
 842       "memberOf" : "Roo.util.Observable",
 843       "example" : "",
 844       "deprecated" : "",
 845       "since" : "",
 846       "see" : "",
 847       "params" : [
 848         {
 849           "name" : "eventName",
 850           "type" : "String",
 851           "desc" : "",
 852           "isOptional" : false
 853         },
 854         {
 855           "name" : "args",
 856           "type" : "Object...",
 857           "desc" : "Variable number of parameters are passed to handlers",
 858           "isOptional" : false
 859         }
 860       ],
 861       "returns" : [
 862         {
 863           "name" : "",
 864           "type" : "Boolean",
 865           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 866         }
 867       ]
 868     },
 869     {
 870       "name" : "hasListener",
 871       "desc" : "Checks to see if this object has any listeners for a specified event",
 872       "isStatic" : false,
 873       "isConstructor" : false,
 874       "isPrivate" : false,
 875       "memberOf" : "Roo.util.Observable",
 876       "example" : "",
 877       "deprecated" : "",
 878       "since" : "",
 879       "see" : "",
 880       "params" : [
 881         {
 882           "name" : "eventName",
 883           "type" : "String",
 884           "desc" : "The name of the event to check for",
 885           "isOptional" : false
 886         }
 887       ],
 888       "returns" : [
 889         {
 890           "name" : "",
 891           "type" : "Boolean",
 892           "desc" : "True if the event is being listened for, else false"
 893         }
 894       ]
 895     },
 896     {
 897       "name" : "capture",
 898       "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.",
 899       "isStatic" : true,
 900       "isConstructor" : false,
 901       "isPrivate" : false,
 902       "memberOf" : "Roo.util.Observable",
 903       "example" : "",
 904       "deprecated" : "",
 905       "since" : "",
 906       "see" : "",
 907       "params" : [
 908         {
 909           "name" : "o",
 910           "type" : "Observable",
 911           "desc" : "The Observable to capture",
 912           "isOptional" : false
 913         },
 914         {
 915           "name" : "fn",
 916           "type" : "Function",
 917           "desc" : "The function to call",
 918           "isOptional" : false
 919         },
 920         {
 921           "name" : "scope",
 922           "type" : "Object",
 923           "desc" : "(optional) The scope (this object) for the fn",
 924           "isOptional" : false
 925         }
 926       ],
 927       "returns" : [
 928       ]
 929     },
 930     {
 931       "name" : "addListener",
 932       "desc" : "Appends an event handler to this component",
 933       "isStatic" : false,
 934       "isConstructor" : false,
 935       "isPrivate" : false,
 936       "memberOf" : "Roo.util.Observable",
 937       "example" : "",
 938       "deprecated" : "",
 939       "since" : "",
 940       "see" : "",
 941       "params" : [
 942         {
 943           "name" : "eventName",
 944           "type" : "String",
 945           "desc" : "The type of event to listen for",
 946           "isOptional" : false
 947         },
 948         {
 949           "name" : "handler",
 950           "type" : "Function",
 951           "desc" : "The method the event invokes",
 952           "isOptional" : false
 953         },
 954         {
 955           "name" : "scope",
 956           "type" : "Object",
 957           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 958           "isOptional" : false
 959         },
 960         {
 961           "name" : "options",
 962           "type" : "Object",
 963           "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>",
 964           "isOptional" : false
 965         }
 966       ],
 967       "returns" : [
 968       ]
 969     }
 970   ],
 971   "events" : [
 972     {
 973       "name" : "beforetoggle",
 974       "desc" : "Fire before toggle the menu",
 975       "memberOf" : "Roo.bootstrap.Navbar",
 976       "example" : "",
 977       "deprecated" : "",
 978       "since" : "",
 979       "see" : "",
 980       "params" : [
 981         {
 982           "name" : "e",
 983           "type" : "Roo.EventObject",
 984           "desc" : "",
 985           "isOptional" : false
 986         }
 987       ],
 988       "returns" : [
 989       ]
 990     },
 991     {
 992       "name" : "childrenrendered",
 993       "desc" : "Fires when the children have been rendered..",
 994       "memberOf" : "Roo.bootstrap.Component",
 995       "example" : "",
 996       "deprecated" : "",
 997       "since" : "",
 998       "see" : "",
 999       "params" : [
1000         {
1001           "name" : "this",
1002           "type" : "Roo.bootstrap.Component",
1003           "desc" : "",
1004           "isOptional" : false
1005         }
1006       ],
1007       "returns" : [
1008       ]
1009     },
1010     {
1011       "name" : "beforerender",
1012       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1013       "memberOf" : "Roo.Component",
1014       "example" : "",
1015       "deprecated" : "",
1016       "since" : "",
1017       "see" : "",
1018       "params" : [
1019         {
1020           "name" : "this",
1021           "type" : "Roo.Component",
1022           "desc" : "",
1023           "isOptional" : false
1024         }
1025       ],
1026       "returns" : [
1027       ]
1028     },
1029     {
1030       "name" : "disable",
1031       "desc" : "Fires after the component is disabled.",
1032       "memberOf" : "Roo.Component",
1033       "example" : "",
1034       "deprecated" : "",
1035       "since" : "",
1036       "see" : "",
1037       "params" : [
1038         {
1039           "name" : "this",
1040           "type" : "Roo.Component",
1041           "desc" : "",
1042           "isOptional" : false
1043         }
1044       ],
1045       "returns" : [
1046       ]
1047     },
1048     {
1049       "name" : "render",
1050       "desc" : "Fires after the component is rendered.",
1051       "memberOf" : "Roo.Component",
1052       "example" : "",
1053       "deprecated" : "",
1054       "since" : "",
1055       "see" : "",
1056       "params" : [
1057         {
1058           "name" : "this",
1059           "type" : "Roo.Component",
1060           "desc" : "",
1061           "isOptional" : false
1062         }
1063       ],
1064       "returns" : [
1065       ]
1066     },
1067     {
1068       "name" : "destroy",
1069       "desc" : "Fires after the component is destroyed.",
1070       "memberOf" : "Roo.Component",
1071       "example" : "",
1072       "deprecated" : "",
1073       "since" : "",
1074       "see" : "",
1075       "params" : [
1076         {
1077           "name" : "this",
1078           "type" : "Roo.Component",
1079           "desc" : "",
1080           "isOptional" : false
1081         }
1082       ],
1083       "returns" : [
1084       ]
1085     },
1086     {
1087       "name" : "hide",
1088       "desc" : "Fires after the component is hidden.",
1089       "memberOf" : "Roo.Component",
1090       "example" : "",
1091       "deprecated" : "",
1092       "since" : "",
1093       "see" : "",
1094       "params" : [
1095         {
1096           "name" : "this",
1097           "type" : "Roo.Component",
1098           "desc" : "",
1099           "isOptional" : false
1100         }
1101       ],
1102       "returns" : [
1103       ]
1104     },
1105     {
1106       "name" : "beforehide",
1107       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1108       "memberOf" : "Roo.Component",
1109       "example" : "",
1110       "deprecated" : "",
1111       "since" : "",
1112       "see" : "",
1113       "params" : [
1114         {
1115           "name" : "this",
1116           "type" : "Roo.Component",
1117           "desc" : "",
1118           "isOptional" : false
1119         }
1120       ],
1121       "returns" : [
1122       ]
1123     },
1124     {
1125       "name" : "show",
1126       "desc" : "Fires after the component is shown.",
1127       "memberOf" : "Roo.Component",
1128       "example" : "",
1129       "deprecated" : "",
1130       "since" : "",
1131       "see" : "",
1132       "params" : [
1133         {
1134           "name" : "this",
1135           "type" : "Roo.Component",
1136           "desc" : "",
1137           "isOptional" : false
1138         }
1139       ],
1140       "returns" : [
1141       ]
1142     },
1143     {
1144       "name" : "beforeshow",
1145       "desc" : "Fires before the component is shown.  Return false to stop the show.",
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     {
1163       "name" : "enable",
1164       "desc" : "Fires after the component is enabled.",
1165       "memberOf" : "Roo.Component",
1166       "example" : "",
1167       "deprecated" : "",
1168       "since" : "",
1169       "see" : "",
1170       "params" : [
1171         {
1172           "name" : "this",
1173           "type" : "Roo.Component",
1174           "desc" : "",
1175           "isOptional" : false
1176         }
1177       ],
1178       "returns" : [
1179       ]
1180     },
1181     {
1182       "name" : "beforedestroy",
1183       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1184       "memberOf" : "Roo.Component",
1185       "example" : "",
1186       "deprecated" : "",
1187       "since" : "",
1188       "see" : "",
1189       "params" : [
1190         {
1191           "name" : "this",
1192           "type" : "Roo.Component",
1193           "desc" : "",
1194           "isOptional" : false
1195         }
1196       ],
1197       "returns" : [
1198       ]
1199     }
1200   ]
1201 }