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