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