git.roojs.org Git - roojs1/blob - docs/symbols/Roo.menu.CheckItem.json

   1 {
   2   "name" : "Roo.menu.CheckItem",
   3   "augments" : [
   4     "Roo.menu.Item",
   5     "Roo.menu.BaseItem",
   6     "Roo.Component",
   7     "Roo.util.Observable"
   8   ],
   9   "childClasses" : [],
  10   "desc" : "Adds a menu item that contains a checkbox by default, but can also be part of a radio group.",
  11   "isSingleton" : false,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "memberOf" : "CheckItem",
  15   "example" : "",
  16   "deprecated" : "",
  17   "since" : "",
  18   "see" : "",
  19   "params" : [
  20     {
  21       "name" : "config",
  22       "type" : "Object",
  23       "desc" : "Configuration options",
  24       "isOptional" : false
  25     }
  26   ],
  27   "returns" : [],
  28   "throws" : "",
  29   "requires" : "",
  30   "config" : [
  31     {
  32       "name" : "listeners",
  33       "type" : "Object",
  34       "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>",
  35       "memberOf" : "Roo.util.Observable"
  36     },
  37     {
  38       "name" : "showDelay",
  39       "type" : "Number",
  40       "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
  41       "memberOf" : "Roo.menu.Item"
  42     },
  43     {
  44       "name" : "text",
  45       "type" : "String",
  46       "desc" : "The text to show on the menu item.",
  47       "memberOf" : "Roo.menu.Item"
  48     },
  49     {
  50       "name" : "menu",
  51       "type" : "Roo.menu.Menu",
  52       "desc" : "A Sub menu",
  53       "memberOf" : "Roo.menu.Item"
  54     },
  55     {
  56       "name" : "activeClass",
  57       "type" : "String",
  58       "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
  59       "memberOf" : "Roo.menu.BaseItem"
  60     },
  61     {
  62       "name" : "hidden",
  63       "type" : "Boolean",
  64       "desc" : "True to prevent creation of this menu item (defaults to false)",
  65       "memberOf" : "Roo.menu.BaseItem"
  66     },
  67     {
  68       "name" : "hideMode",
  69       "type" : "String",
  70       "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\".",
  71       "memberOf" : "Roo.Component"
  72     },
  73     {
  74       "name" : "group",
  75       "type" : "String",
  76       "desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')",
  77       "memberOf" : ""
  78     },
  79     {
  80       "name" : "handler",
  81       "type" : "Function",
  82       "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
  83       "memberOf" : "Roo.menu.BaseItem"
  84     },
  85     {
  86       "name" : "hideDelay",
  87       "type" : "Number",
  88       "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
  89       "memberOf" : "Roo.menu.BaseItem"
  90     },
  91     {
  92       "name" : "hideOnClick",
  93       "type" : "Boolean",
  94       "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
  95       "memberOf" : "Roo.menu.BaseItem"
  96     },
  97     {
  98       "name" : "allowDomMove",
  99       "type" : "Boolean",
 100       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 101       "memberOf" : "Roo.Component"
 102     },
 103     {
 104       "name" : "itemCls",
 105       "type" : "String",
 106       "desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
 107       "memberOf" : ""
 108     },
 109     {
 110       "name" : "HTML",
 111       "type" : "String",
 112       "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
 113       "memberOf" : "Roo.menu.Item"
 114     },
 115     {
 116       "name" : "actionMode",
 117       "type" : "String",
 118       "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",
 119       "memberOf" : "Roo.Component"
 120     },
 121     {
 122       "name" : "groupClass",
 123       "type" : "String",
 124       "desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
 125       "memberOf" : ""
 126     },
 127     {
 128       "name" : "canActivate",
 129       "type" : "Boolean",
 130       "desc" : "True if this item can be visually activated (defaults to true)",
 131       "memberOf" : "Roo.menu.Item"
 132     },
 133     {
 134       "name" : "icon",
 135       "type" : "String",
 136       "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
 137       "memberOf" : "Roo.menu.Item"
 138     },
 139     {
 140       "name" : "checked",
 141       "type" : "Boolean",
 142       "desc" : "True to initialize this checkbox as checked (defaults to false).  Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.",
 143       "memberOf" : ""
 144     },
 145     {
 146       "name" : "disableClass",
 147       "type" : "String",
 148       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 149       "memberOf" : "Roo.Component"
 150     }
 151   ],
 152   "methods" : [
 153     {
 154       "name" : "setChecked",
 155       "type" : "function",
 156       "desc" : "Set the checked state of this item",
 157       "sig" : "(checked, suppressEvent)",
 158       "static" : false,
 159       "memberOf" : "",
 160       "isStatic" : false,
 161       "isConstructor" : false,
 162       "isPrivate" : false,
 163       "example" : "",
 164       "deprecated" : "",
 165       "since" : "",
 166       "see" : "",
 167       "exceptions" : "",
 168       "requires" : "",
 169       "params" : [
 170         {
 171           "name" : "checked",
 172           "type" : "Boolean",
 173           "desc" : "The new checked value",
 174           "isOptional" : false
 175         },
 176         {
 177           "name" : "suppressEvent",
 178           "type" : "Boolean",
 179           "desc" : "(optional) True to prevent the checkchange event from firing (defaults to false)",
 180           "isOptional" : false
 181         }
 182       ],
 183       "returns" : []
 184     },
 185     {
 186       "name" : "setText",
 187       "type" : "function",
 188       "desc" : "Sets the text to display in this menu item",
 189       "sig" : "(text, isHTML)",
 190       "static" : false,
 191       "memberOf" : "Roo.menu.Item",
 192       "isStatic" : false,
 193       "isConstructor" : false,
 194       "isPrivate" : false,
 195       "example" : "",
 196       "deprecated" : "",
 197       "since" : "",
 198       "see" : "",
 199       "exceptions" : "",
 200       "requires" : "",
 201       "params" : [
 202         {
 203           "name" : "text",
 204           "type" : "String",
 205           "desc" : "The text to display",
 206           "isOptional" : false
 207         },
 208         {
 209           "name" : "isHTML",
 210           "type" : "Boolean",
 211           "desc" : "true to indicate text is pure html.",
 212           "isOptional" : false
 213         }
 214       ],
 215       "returns" : []
 216     },
 217     {
 218       "name" : "getId",
 219       "type" : "function",
 220       "desc" : "Returns the id of this component.",
 221       "sig" : "()\n{\n\n}",
 222       "static" : false,
 223       "memberOf" : "Roo.Component",
 224       "isStatic" : false,
 225       "isConstructor" : false,
 226       "isPrivate" : false,
 227       "example" : "",
 228       "deprecated" : "",
 229       "since" : "",
 230       "see" : "",
 231       "exceptions" : "",
 232       "requires" : "",
 233       "params" : [],
 234       "returns" : [
 235         {
 236           "name" : "",
 237           "type" : "String",
 238           "desc" : ""
 239         }
 240       ]
 241     },
 242     {
 243       "name" : "render",
 244       "type" : "function",
 245       "desc" : "If this is a lazy rendering component, render it to its container element.",
 246       "sig" : "(container)",
 247       "static" : false,
 248       "memberOf" : "Roo.Component",
 249       "isStatic" : false,
 250       "isConstructor" : false,
 251       "isPrivate" : false,
 252       "example" : "",
 253       "deprecated" : "",
 254       "since" : "",
 255       "see" : "",
 256       "exceptions" : "",
 257       "requires" : "",
 258       "params" : [
 259         {
 260           "name" : "container",
 261           "type" : "String/HTMLElement/Element",
 262           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 263           "isOptional" : false
 264         }
 265       ],
 266       "returns" : []
 267     },
 268     {
 269       "name" : "destroy",
 270       "type" : "function",
 271       "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}.",
 272       "sig" : "()\n{\n\n}",
 273       "static" : false,
 274       "memberOf" : "Roo.Component",
 275       "isStatic" : false,
 276       "isConstructor" : false,
 277       "isPrivate" : false,
 278       "example" : "",
 279       "deprecated" : "",
 280       "since" : "",
 281       "see" : "",
 282       "exceptions" : "",
 283       "requires" : "",
 284       "params" : [],
 285       "returns" : []
 286     },
 287     {
 288       "name" : "isVisible",
 289       "type" : "function",
 290       "desc" : "Returns true if this component is visible.",
 291       "sig" : "()\n{\n\n}",
 292       "static" : false,
 293       "memberOf" : "Roo.Component",
 294       "isStatic" : false,
 295       "isConstructor" : false,
 296       "isPrivate" : false,
 297       "example" : "",
 298       "deprecated" : "",
 299       "since" : "",
 300       "see" : "",
 301       "exceptions" : "",
 302       "requires" : "",
 303       "params" : [],
 304       "returns" : []
 305     },
 306     {
 307       "name" : "setDisabled",
 308       "type" : "function",
 309       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 310       "sig" : "(disabled)",
 311       "static" : false,
 312       "memberOf" : "Roo.Component",
 313       "isStatic" : false,
 314       "isConstructor" : false,
 315       "isPrivate" : false,
 316       "example" : "",
 317       "deprecated" : "",
 318       "since" : "",
 319       "see" : "",
 320       "exceptions" : "",
 321       "requires" : "",
 322       "params" : [
 323         {
 324           "name" : "disabled",
 325           "type" : "Boolean",
 326           "desc" : "",
 327           "isOptional" : false
 328         }
 329       ],
 330       "returns" : []
 331     },
 332     {
 333       "name" : "hide",
 334       "type" : "function",
 335       "desc" : "Hide this component.",
 336       "sig" : "()\n{\n\n}",
 337       "static" : false,
 338       "memberOf" : "Roo.Component",
 339       "isStatic" : false,
 340       "isConstructor" : false,
 341       "isPrivate" : false,
 342       "example" : "",
 343       "deprecated" : "",
 344       "since" : "",
 345       "see" : "",
 346       "exceptions" : "",
 347       "requires" : "",
 348       "params" : [],
 349       "returns" : [
 350         {
 351           "name" : "",
 352           "type" : "Roo.Component",
 353           "desc" : "this"
 354         }
 355       ]
 356     },
 357     {
 358       "name" : "focus",
 359       "type" : "function",
 360       "desc" : "Try to focus this component.",
 361       "sig" : "(selectText)",
 362       "static" : false,
 363       "memberOf" : "Roo.Component",
 364       "isStatic" : false,
 365       "isConstructor" : false,
 366       "isPrivate" : false,
 367       "example" : "",
 368       "deprecated" : "",
 369       "since" : "",
 370       "see" : "",
 371       "exceptions" : "",
 372       "requires" : "",
 373       "params" : [
 374         {
 375           "name" : "selectText",
 376           "type" : "Boolean",
 377           "desc" : "True to also select the text in this component (if applicable)",
 378           "isOptional" : false
 379         }
 380       ],
 381       "returns" : [
 382         {
 383           "name" : "",
 384           "type" : "Roo.Component",
 385           "desc" : "this"
 386         }
 387       ]
 388     },
 389     {
 390       "name" : "show",
 391       "type" : "function",
 392       "desc" : "Show this component.",
 393       "sig" : "()\n{\n\n}",
 394       "static" : false,
 395       "memberOf" : "Roo.Component",
 396       "isStatic" : false,
 397       "isConstructor" : false,
 398       "isPrivate" : false,
 399       "example" : "",
 400       "deprecated" : "",
 401       "since" : "",
 402       "see" : "",
 403       "exceptions" : "",
 404       "requires" : "",
 405       "params" : [],
 406       "returns" : [
 407         {
 408           "name" : "",
 409           "type" : "Roo.Component",
 410           "desc" : "this"
 411         }
 412       ]
 413     },
 414     {
 415       "name" : "enable",
 416       "type" : "function",
 417       "desc" : "Enable this component.",
 418       "sig" : "()\n{\n\n}",
 419       "static" : false,
 420       "memberOf" : "Roo.Component",
 421       "isStatic" : false,
 422       "isConstructor" : false,
 423       "isPrivate" : false,
 424       "example" : "",
 425       "deprecated" : "",
 426       "since" : "",
 427       "see" : "",
 428       "exceptions" : "",
 429       "requires" : "",
 430       "params" : [],
 431       "returns" : [
 432         {
 433           "name" : "",
 434           "type" : "Roo.Component",
 435           "desc" : "this"
 436         }
 437       ]
 438     },
 439     {
 440       "name" : "setVisible",
 441       "type" : "function",
 442       "desc" : "Convenience function to hide or show this component by boolean.",
 443       "sig" : "(visible)",
 444       "static" : false,
 445       "memberOf" : "Roo.Component",
 446       "isStatic" : false,
 447       "isConstructor" : false,
 448       "isPrivate" : false,
 449       "example" : "",
 450       "deprecated" : "",
 451       "since" : "",
 452       "see" : "",
 453       "exceptions" : "",
 454       "requires" : "",
 455       "params" : [
 456         {
 457           "name" : "visible",
 458           "type" : "Boolean",
 459           "desc" : "True to show, false to hide",
 460           "isOptional" : false
 461         }
 462       ],
 463       "returns" : [
 464         {
 465           "name" : "",
 466           "type" : "Roo.Component",
 467           "desc" : "this"
 468         }
 469       ]
 470     },
 471     {
 472       "name" : "disable",
 473       "type" : "function",
 474       "desc" : "Disable this component.",
 475       "sig" : "()\n{\n\n}",
 476       "static" : false,
 477       "memberOf" : "Roo.Component",
 478       "isStatic" : false,
 479       "isConstructor" : false,
 480       "isPrivate" : false,
 481       "example" : "",
 482       "deprecated" : "",
 483       "since" : "",
 484       "see" : "",
 485       "exceptions" : "",
 486       "requires" : "",
 487       "params" : [],
 488       "returns" : [
 489         {
 490           "name" : "",
 491           "type" : "Roo.Component",
 492           "desc" : "this"
 493         }
 494       ]
 495     },
 496     {
 497       "name" : "getEl",
 498       "type" : "function",
 499       "desc" : "Returns the underlying {@link Roo.Element}.",
 500       "sig" : "()\n{\n\n}",
 501       "static" : false,
 502       "memberOf" : "Roo.Component",
 503       "isStatic" : false,
 504       "isConstructor" : false,
 505       "isPrivate" : false,
 506       "example" : "",
 507       "deprecated" : "",
 508       "since" : "",
 509       "see" : "",
 510       "exceptions" : "",
 511       "requires" : "",
 512       "params" : [],
 513       "returns" : [
 514         {
 515           "name" : "",
 516           "type" : "Roo.Element",
 517           "desc" : "The element"
 518         }
 519       ]
 520     },
 521     {
 522       "name" : "purgeListeners",
 523       "type" : "function",
 524       "desc" : "Removes all listeners for this object",
 525       "sig" : "()\n{\n\n}",
 526       "static" : false,
 527       "memberOf" : "Roo.util.Observable",
 528       "isStatic" : false,
 529       "isConstructor" : false,
 530       "isPrivate" : false,
 531       "example" : "",
 532       "deprecated" : "",
 533       "since" : "",
 534       "see" : "",
 535       "exceptions" : "",
 536       "requires" : "",
 537       "params" : [],
 538       "returns" : []
 539     },
 540     {
 541       "name" : "on",
 542       "type" : "function",
 543       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 544       "sig" : "(eventName, handler, scope, options)",
 545       "static" : false,
 546       "memberOf" : "Roo.util.Observable",
 547       "isStatic" : false,
 548       "isConstructor" : false,
 549       "isPrivate" : false,
 550       "example" : "",
 551       "deprecated" : "",
 552       "since" : "",
 553       "see" : "",
 554       "exceptions" : "",
 555       "requires" : "",
 556       "params" : [
 557         {
 558           "name" : "eventName",
 559           "type" : "String",
 560           "desc" : "The type of event to listen for",
 561           "isOptional" : false
 562         },
 563         {
 564           "name" : "handler",
 565           "type" : "Function",
 566           "desc" : "The method the event invokes",
 567           "isOptional" : false
 568         },
 569         {
 570           "name" : "scope",
 571           "type" : "Object",
 572           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 573           "isOptional" : false
 574         },
 575         {
 576           "name" : "options",
 577           "type" : "Object",
 578           "desc" : "(optional)",
 579           "isOptional" : false
 580         }
 581       ],
 582       "returns" : []
 583     },
 584     {
 585       "name" : "un",
 586       "type" : "function",
 587       "desc" : "Removes a listener (shorthand for removeListener)",
 588       "sig" : "(eventName, handler, scope)",
 589       "static" : false,
 590       "memberOf" : "Roo.util.Observable",
 591       "isStatic" : false,
 592       "isConstructor" : false,
 593       "isPrivate" : false,
 594       "example" : "",
 595       "deprecated" : "",
 596       "since" : "",
 597       "see" : "",
 598       "exceptions" : "",
 599       "requires" : "",
 600       "params" : [
 601         {
 602           "name" : "eventName",
 603           "type" : "String",
 604           "desc" : "The type of event to listen for",
 605           "isOptional" : false
 606         },
 607         {
 608           "name" : "handler",
 609           "type" : "Function",
 610           "desc" : "The handler to remove",
 611           "isOptional" : false
 612         },
 613         {
 614           "name" : "scope",
 615           "type" : "Object",
 616           "desc" : "(optional) The scope (this object) for the handler",
 617           "isOptional" : false
 618         }
 619       ],
 620       "returns" : []
 621     },
 622     {
 623       "name" : "addEvents",
 624       "type" : "function",
 625       "desc" : "Used to define events on this Observable",
 626       "sig" : "(object)",
 627       "static" : false,
 628       "memberOf" : "Roo.util.Observable",
 629       "isStatic" : false,
 630       "isConstructor" : false,
 631       "isPrivate" : false,
 632       "example" : "",
 633       "deprecated" : "",
 634       "since" : "",
 635       "see" : "",
 636       "exceptions" : "",
 637       "requires" : "",
 638       "params" : [
 639         {
 640           "name" : "object",
 641           "type" : "Object",
 642           "desc" : "The object with the events defined",
 643           "isOptional" : false
 644         }
 645       ],
 646       "returns" : []
 647     },
 648     {
 649       "name" : "releaseCapture",
 650       "type" : "function",
 651       "desc" : "Removes <b>all</b> added captures from the Observable.",
 652       "sig" : "(o)",
 653       "static" : true,
 654       "memberOf" : "Roo.util.Observable",
 655       "isStatic" : true,
 656       "isConstructor" : false,
 657       "isPrivate" : false,
 658       "example" : "",
 659       "deprecated" : "",
 660       "since" : "",
 661       "see" : "",
 662       "exceptions" : "",
 663       "requires" : "",
 664       "params" : [
 665         {
 666           "name" : "o",
 667           "type" : "Observable",
 668           "desc" : "The Observable to release",
 669           "isOptional" : false
 670         }
 671       ],
 672       "returns" : []
 673     },
 674     {
 675       "name" : "removeListener",
 676       "type" : "function",
 677       "desc" : "Removes a listener",
 678       "sig" : "(eventName, handler, scope)",
 679       "static" : false,
 680       "memberOf" : "Roo.util.Observable",
 681       "isStatic" : false,
 682       "isConstructor" : false,
 683       "isPrivate" : false,
 684       "example" : "",
 685       "deprecated" : "",
 686       "since" : "",
 687       "see" : "",
 688       "exceptions" : "",
 689       "requires" : "",
 690       "params" : [
 691         {
 692           "name" : "eventName",
 693           "type" : "String",
 694           "desc" : "The type of event to listen for",
 695           "isOptional" : false
 696         },
 697         {
 698           "name" : "handler",
 699           "type" : "Function",
 700           "desc" : "The handler to remove",
 701           "isOptional" : false
 702         },
 703         {
 704           "name" : "scope",
 705           "type" : "Object",
 706           "desc" : "(optional) The scope (this object) for the handler",
 707           "isOptional" : false
 708         }
 709       ],
 710       "returns" : []
 711     },
 712     {
 713       "name" : "fireEvent",
 714       "type" : "function",
 715       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 716       "sig" : "(eventName, args)",
 717       "static" : false,
 718       "memberOf" : "Roo.util.Observable",
 719       "isStatic" : false,
 720       "isConstructor" : false,
 721       "isPrivate" : false,
 722       "example" : "",
 723       "deprecated" : "",
 724       "since" : "",
 725       "see" : "",
 726       "exceptions" : "",
 727       "requires" : "",
 728       "params" : [
 729         {
 730           "name" : "eventName",
 731           "type" : "String",
 732           "desc" : "",
 733           "isOptional" : false
 734         },
 735         {
 736           "name" : "args",
 737           "type" : "Object...",
 738           "desc" : "Variable number of parameters are passed to handlers",
 739           "isOptional" : false
 740         }
 741       ],
 742       "returns" : [
 743         {
 744           "name" : "",
 745           "type" : "Boolean",
 746           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 747         }
 748       ]
 749     },
 750     {
 751       "name" : "hasListener",
 752       "type" : "function",
 753       "desc" : "Checks to see if this object has any listeners for a specified event",
 754       "sig" : "(eventName)",
 755       "static" : false,
 756       "memberOf" : "Roo.util.Observable",
 757       "isStatic" : false,
 758       "isConstructor" : false,
 759       "isPrivate" : false,
 760       "example" : "",
 761       "deprecated" : "",
 762       "since" : "",
 763       "see" : "",
 764       "exceptions" : "",
 765       "requires" : "",
 766       "params" : [
 767         {
 768           "name" : "eventName",
 769           "type" : "String",
 770           "desc" : "The name of the event to check for",
 771           "isOptional" : false
 772         }
 773       ],
 774       "returns" : [
 775         {
 776           "name" : "",
 777           "type" : "Boolean",
 778           "desc" : "True if the event is being listened for, else false"
 779         }
 780       ]
 781     },
 782     {
 783       "name" : "capture",
 784       "type" : "function",
 785       "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.",
 786       "sig" : "(o, fn, scope)",
 787       "static" : true,
 788       "memberOf" : "Roo.util.Observable",
 789       "isStatic" : true,
 790       "isConstructor" : false,
 791       "isPrivate" : false,
 792       "example" : "",
 793       "deprecated" : "",
 794       "since" : "",
 795       "see" : "",
 796       "exceptions" : "",
 797       "requires" : "",
 798       "params" : [
 799         {
 800           "name" : "o",
 801           "type" : "Observable",
 802           "desc" : "The Observable to capture",
 803           "isOptional" : false
 804         },
 805         {
 806           "name" : "fn",
 807           "type" : "Function",
 808           "desc" : "The function to call",
 809           "isOptional" : false
 810         },
 811         {
 812           "name" : "scope",
 813           "type" : "Object",
 814           "desc" : "(optional) The scope (this object) for the fn",
 815           "isOptional" : false
 816         }
 817       ],
 818       "returns" : []
 819     },
 820     {
 821       "name" : "addListener",
 822       "type" : "function",
 823       "desc" : "Appends an event handler to this component",
 824       "sig" : "(eventName, handler, scope, options)",
 825       "static" : false,
 826       "memberOf" : "Roo.util.Observable",
 827       "isStatic" : false,
 828       "isConstructor" : false,
 829       "isPrivate" : false,
 830       "example" : "",
 831       "deprecated" : "",
 832       "since" : "",
 833       "see" : "",
 834       "exceptions" : "",
 835       "requires" : "",
 836       "params" : [
 837         {
 838           "name" : "eventName",
 839           "type" : "String",
 840           "desc" : "The type of event to listen for",
 841           "isOptional" : false
 842         },
 843         {
 844           "name" : "handler",
 845           "type" : "Function",
 846           "desc" : "The method the event invokes",
 847           "isOptional" : false
 848         },
 849         {
 850           "name" : "scope",
 851           "type" : "Object",
 852           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 853           "isOptional" : false
 854         },
 855         {
 856           "name" : "options",
 857           "type" : "Object",
 858           "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>",
 859           "isOptional" : false
 860         }
 861       ],
 862       "returns" : []
 863     }
 864   ],
 865   "events" : [
 866     {
 867       "name" : "beforecheckchange",
 868       "type" : "function",
 869       "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed",
 870       "sig" : "function (_self, checked)\n{\n\n}",
 871       "memberOf" : "",
 872       "example" : "",
 873       "deprecated" : "",
 874       "since" : "",
 875       "see" : "",
 876       "params" : [
 877         {
 878           "name" : "this",
 879           "type" : "Roo.menu.CheckItem",
 880           "desc" : "",
 881           "isOptional" : false
 882         },
 883         {
 884           "name" : "checked",
 885           "type" : "Boolean",
 886           "desc" : "The new checked value that will be set",
 887           "isOptional" : false
 888         }
 889       ],
 890       "returns" : []
 891     },
 892     {
 893       "name" : "checkchange",
 894       "type" : "function",
 895       "desc" : "Fires after the checked value has been set",
 896       "sig" : "function (_self, checked)\n{\n\n}",
 897       "memberOf" : "",
 898       "example" : "",
 899       "deprecated" : "",
 900       "since" : "",
 901       "see" : "",
 902       "params" : [
 903         {
 904           "name" : "this",
 905           "type" : "Roo.menu.CheckItem",
 906           "desc" : "",
 907           "isOptional" : false
 908         },
 909         {
 910           "name" : "checked",
 911           "type" : "Boolean",
 912           "desc" : "The checked value that was set",
 913           "isOptional" : false
 914         }
 915       ],
 916       "returns" : []
 917     },
 918     {
 919       "name" : "click",
 920       "type" : "function",
 921       "desc" : "Fires when this item is clicked",
 922       "sig" : "function (_self, e)\n{\n\n}",
 923       "memberOf" : "Roo.menu.BaseItem",
 924       "example" : "",
 925       "deprecated" : "",
 926       "since" : "",
 927       "see" : "",
 928       "params" : [
 929         {
 930           "name" : "this",
 931           "type" : "Roo.menu.BaseItem",
 932           "desc" : "",
 933           "isOptional" : false
 934         },
 935         {
 936           "name" : "e",
 937           "type" : "Roo.EventObject",
 938           "desc" : "",
 939           "isOptional" : false
 940         }
 941       ],
 942       "returns" : []
 943     },
 944     {
 945       "name" : "activate",
 946       "type" : "function",
 947       "desc" : "Fires when this item is activated",
 948       "sig" : "function (_self)\n{\n\n}",
 949       "memberOf" : "Roo.menu.BaseItem",
 950       "example" : "",
 951       "deprecated" : "",
 952       "since" : "",
 953       "see" : "",
 954       "params" : [
 955         {
 956           "name" : "this",
 957           "type" : "Roo.menu.BaseItem",
 958           "desc" : "",
 959           "isOptional" : false
 960         }
 961       ],
 962       "returns" : []
 963     },
 964     {
 965       "name" : "deactivate",
 966       "type" : "function",
 967       "desc" : "Fires when this item is deactivated",
 968       "sig" : "function (_self)\n{\n\n}",
 969       "memberOf" : "Roo.menu.BaseItem",
 970       "example" : "",
 971       "deprecated" : "",
 972       "since" : "",
 973       "see" : "",
 974       "params" : [
 975         {
 976           "name" : "this",
 977           "type" : "Roo.menu.BaseItem",
 978           "desc" : "",
 979           "isOptional" : false
 980         }
 981       ],
 982       "returns" : []
 983     },
 984     {
 985       "name" : "beforerender",
 986       "type" : "function",
 987       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 988       "sig" : "function (_self)\n{\n\n}",
 989       "memberOf" : "Roo.Component",
 990       "example" : "",
 991       "deprecated" : "",
 992       "since" : "",
 993       "see" : "",
 994       "params" : [
 995         {
 996           "name" : "this",
 997           "type" : "Roo.Component",
 998           "desc" : "",
 999           "isOptional" : false
1000         }
1001       ],
1002       "returns" : []
1003     },
1004     {
1005       "name" : "disable",
1006       "type" : "function",
1007       "desc" : "Fires after the component is disabled.",
1008       "sig" : "function (_self)\n{\n\n}",
1009       "memberOf" : "Roo.Component",
1010       "example" : "",
1011       "deprecated" : "",
1012       "since" : "",
1013       "see" : "",
1014       "params" : [
1015         {
1016           "name" : "this",
1017           "type" : "Roo.Component",
1018           "desc" : "",
1019           "isOptional" : false
1020         }
1021       ],
1022       "returns" : []
1023     },
1024     {
1025       "name" : "render",
1026       "type" : "function",
1027       "desc" : "Fires after the component is rendered.",
1028       "sig" : "function (_self)\n{\n\n}",
1029       "memberOf" : "Roo.Component",
1030       "example" : "",
1031       "deprecated" : "",
1032       "since" : "",
1033       "see" : "",
1034       "params" : [
1035         {
1036           "name" : "this",
1037           "type" : "Roo.Component",
1038           "desc" : "",
1039           "isOptional" : false
1040         }
1041       ],
1042       "returns" : []
1043     },
1044     {
1045       "name" : "destroy",
1046       "type" : "function",
1047       "desc" : "Fires after the component is destroyed.",
1048       "sig" : "function (_self)\n{\n\n}",
1049       "memberOf" : "Roo.Component",
1050       "example" : "",
1051       "deprecated" : "",
1052       "since" : "",
1053       "see" : "",
1054       "params" : [
1055         {
1056           "name" : "this",
1057           "type" : "Roo.Component",
1058           "desc" : "",
1059           "isOptional" : false
1060         }
1061       ],
1062       "returns" : []
1063     },
1064     {
1065       "name" : "hide",
1066       "type" : "function",
1067       "desc" : "Fires after the component is hidden.",
1068       "sig" : "function (_self)\n{\n\n}",
1069       "memberOf" : "Roo.Component",
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "params" : [
1075         {
1076           "name" : "this",
1077           "type" : "Roo.Component",
1078           "desc" : "",
1079           "isOptional" : false
1080         }
1081       ],
1082       "returns" : []
1083     },
1084     {
1085       "name" : "beforehide",
1086       "type" : "function",
1087       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1088       "sig" : "function (_self)\n{\n\n}",
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       "name" : "show",
1106       "type" : "function",
1107       "desc" : "Fires after the component is shown.",
1108       "sig" : "function (_self)\n{\n\n}",
1109       "memberOf" : "Roo.Component",
1110       "example" : "",
1111       "deprecated" : "",
1112       "since" : "",
1113       "see" : "",
1114       "params" : [
1115         {
1116           "name" : "this",
1117           "type" : "Roo.Component",
1118           "desc" : "",
1119           "isOptional" : false
1120         }
1121       ],
1122       "returns" : []
1123     },
1124     {
1125       "name" : "beforeshow",
1126       "type" : "function",
1127       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1128       "sig" : "function (_self)\n{\n\n}",
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" : "enable",
1146       "type" : "function",
1147       "desc" : "Fires after the component is enabled.",
1148       "sig" : "function (_self)\n{\n\n}",
1149       "memberOf" : "Roo.Component",
1150       "example" : "",
1151       "deprecated" : "",
1152       "since" : "",
1153       "see" : "",
1154       "params" : [
1155         {
1156           "name" : "this",
1157           "type" : "Roo.Component",
1158           "desc" : "",
1159           "isOptional" : false
1160         }
1161       ],
1162       "returns" : []
1163     },
1164     {
1165       "name" : "beforedestroy",
1166       "type" : "function",
1167       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1168       "sig" : "function (_self)\n{\n\n}",
1169       "memberOf" : "Roo.Component",
1170       "example" : "",
1171       "deprecated" : "",
1172       "since" : "",
1173       "see" : "",
1174       "params" : [
1175         {
1176           "name" : "this",
1177           "type" : "Roo.Component",
1178           "desc" : "",
1179           "isOptional" : false
1180         }
1181       ],
1182       "returns" : []
1183     }
1184   ]
1185 }