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