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