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

   1 {
   2   "name" : "Roo.DatePicker",
   3   "augments" : [
   4     "Roo.Component",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {  },
   8   "tree_children" : [],
   9   "tree_parent" : [],
  10   "desc" : "Simple date picker class.",
  11   "isSingleton" : false,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "isAbstract" : false,
  15   "isBuilderTop" : false,
  16   "memberOf" : "DatePicker",
  17   "example" : "",
  18   "deprecated" : "",
  19   "since" : "",
  20   "see" : "",
  21   "params" : [
  22     {
  23       "name" : "config",
  24       "type" : "Object",
  25       "desc" : "The config object",
  26       "isOptional" : false
  27     }
  28   ],
  29   "returns" : [],
  30   "throws" : "",
  31   "requires" : "",
  32   "config" : [
  33     {
  34       "name" : "startDay",
  35       "type" : "Number",
  36       "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
  37       "memberOf" : "",
  38       "isOptional" : false,
  39       "optvalues" : []
  40     },
  41     {
  42       "name" : "monthYearText",
  43       "type" : "String",
  44       "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')",
  45       "memberOf" : "",
  46       "isOptional" : false,
  47       "optvalues" : []
  48     },
  49     {
  50       "name" : "monthNames",
  51       "type" : "Array",
  52       "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)",
  53       "memberOf" : "",
  54       "isOptional" : false,
  55       "optvalues" : []
  56     },
  57     {
  58       "name" : "listeners",
  59       "type" : "Object",
  60       "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>",
  61       "memberOf" : "Roo.util.Observable",
  62       "isOptional" : false,
  63       "optvalues" : []
  64     },
  65     {
  66       "name" : "format",
  67       "type" : "String",
  68       "desc" : "The default date format string which can be overriden for localization support.  The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
  69       "memberOf" : "",
  70       "isOptional" : false,
  71       "optvalues" : []
  72     },
  73     {
  74       "name" : "nextText",
  75       "type" : "String",
  76       "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')",
  77       "memberOf" : "",
  78       "isOptional" : false,
  79       "optvalues" : []
  80     },
  81     {
  82       "name" : "maxText",
  83       "type" : "String",
  84       "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")",
  85       "memberOf" : "",
  86       "isOptional" : false,
  87       "optvalues" : []
  88     },
  89     {
  90       "name" : "constrainToViewport",
  91       "type" : "Boolean",
  92       "desc" : "True to constrain the date picker to the viewport (defaults to true)",
  93       "memberOf" : "",
  94       "isOptional" : false,
  95       "optvalues" : []
  96     },
  97     {
  98       "name" : "minText",
  99       "type" : "String",
 100       "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")",
 101       "memberOf" : "",
 102       "isOptional" : false,
 103       "optvalues" : []
 104     },
 105     {
 106       "name" : "disabledDatesText",
 107       "type" : "String",
 108       "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")",
 109       "memberOf" : "",
 110       "isOptional" : false,
 111       "optvalues" : []
 112     },
 113     {
 114       "name" : "todayTip",
 115       "type" : "String",
 116       "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")",
 117       "memberOf" : "",
 118       "isOptional" : false,
 119       "optvalues" : []
 120     },
 121     {
 122       "name" : "hideMode",
 123       "type" : "String",
 124       "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",
 125       "memberOf" : "Roo.Component",
 126       "isOptional" : false,
 127       "optvalues" : [
 128         "display",
 129         "visibility"
 130       ]
 131     },
 132     {
 133       "name" : "todayText",
 134       "type" : "String",
 135       "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")",
 136       "memberOf" : "",
 137       "isOptional" : false,
 138       "optvalues" : []
 139     },
 140     {
 141       "name" : "cancelText",
 142       "type" : "String",
 143       "desc" : "The text to display on the cancel button",
 144       "memberOf" : "",
 145       "isOptional" : false,
 146       "optvalues" : []
 147     },
 148     {
 149       "name" : "allowDomMove",
 150       "type" : "Boolean",
 151       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 152       "memberOf" : "Roo.Component",
 153       "isOptional" : false,
 154       "optvalues" : []
 155     },
 156     {
 157       "name" : "showClear",
 158       "type" : "Bool",
 159       "desc" : "Show a clear button (usefull for date form elements that can be blank.)",
 160       "memberOf" : "",
 161       "isOptional" : false,
 162       "optvalues" : []
 163     },
 164     {
 165       "name" : "prevText",
 166       "type" : "String",
 167       "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')",
 168       "memberOf" : "",
 169       "isOptional" : false,
 170       "optvalues" : []
 171     },
 172     {
 173       "name" : "dayNames",
 174       "type" : "Array",
 175       "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)",
 176       "memberOf" : "",
 177       "isOptional" : false,
 178       "optvalues" : []
 179     },
 180     {
 181       "name" : "actionMode",
 182       "type" : "String",
 183       "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",
 184       "memberOf" : "Roo.Component",
 185       "isOptional" : false,
 186       "optvalues" : []
 187     },
 188     {
 189       "name" : "disabledDaysText",
 190       "type" : "String",
 191       "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")",
 192       "memberOf" : "",
 193       "isOptional" : false,
 194       "optvalues" : []
 195     },
 196     {
 197       "name" : "disabledDatesRE",
 198       "type" : "RegExp",
 199       "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)",
 200       "memberOf" : "",
 201       "isOptional" : false,
 202       "optvalues" : []
 203     },
 204     {
 205       "name" : "minDate",
 206       "type" : "Date",
 207       "desc" : "Minimum allowable date (JavaScript date object, defaults to null)",
 208       "memberOf" : "",
 209       "isOptional" : false,
 210       "optvalues" : []
 211     },
 212     {
 213       "name" : "disabledDays",
 214       "type" : "Array",
 215       "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
 216       "memberOf" : "",
 217       "isOptional" : false,
 218       "optvalues" : []
 219     },
 220     {
 221       "name" : "okText",
 222       "type" : "String",
 223       "desc" : "The text to display on the ok button",
 224       "memberOf" : "",
 225       "isOptional" : false,
 226       "optvalues" : []
 227     },
 228     {
 229       "name" : "maxDate",
 230       "type" : "Date",
 231       "desc" : "Maximum allowable date (JavaScript date object, defaults to null)",
 232       "memberOf" : "",
 233       "isOptional" : false,
 234       "optvalues" : []
 235     },
 236     {
 237       "name" : "disableClass",
 238       "type" : "String",
 239       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 240       "memberOf" : "Roo.Component",
 241       "isOptional" : false,
 242       "optvalues" : []
 243     }
 244   ],
 245   "methods" : [
 246     {
 247       "name" : "getValue",
 248       "type" : "function",
 249       "desc" : "Gets the current selected value of the date field",
 250       "sig" : "()\n{\n\n}",
 251       "static" : false,
 252       "memberOf" : "",
 253       "isStatic" : false,
 254       "isConstructor" : false,
 255       "isPrivate" : false,
 256       "example" : "",
 257       "deprecated" : "",
 258       "since" : "",
 259       "see" : "",
 260       "exceptions" : "",
 261       "requires" : "",
 262       "params" : [],
 263       "returns" : [
 264         {
 265           "name" : "",
 266           "type" : "Date",
 267           "desc" : "The selected date"
 268         }
 269       ]
 270     },
 271     {
 272       "name" : "setValue",
 273       "type" : "function",
 274       "desc" : "Sets the value of the date field",
 275       "sig" : "(value)",
 276       "static" : false,
 277       "memberOf" : "",
 278       "isStatic" : false,
 279       "isConstructor" : false,
 280       "isPrivate" : false,
 281       "example" : "",
 282       "deprecated" : "",
 283       "since" : "",
 284       "see" : "",
 285       "exceptions" : "",
 286       "requires" : "",
 287       "params" : [
 288         {
 289           "name" : "value",
 290           "type" : "Date",
 291           "desc" : "The date to set",
 292           "isOptional" : false
 293         }
 294       ],
 295       "returns" : []
 296     },
 297     {
 298       "name" : "getId",
 299       "type" : "function",
 300       "desc" : "Returns the id of this component.",
 301       "sig" : "()\n{\n\n}",
 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       "returns" : [
 315         {
 316           "name" : "",
 317           "type" : "String",
 318           "desc" : ""
 319         }
 320       ]
 321     },
 322     {
 323       "name" : "render",
 324       "type" : "function",
 325       "desc" : "If this is a lazy rendering component, render it to its container element.",
 326       "sig" : "(container)",
 327       "static" : false,
 328       "memberOf" : "Roo.Component",
 329       "isStatic" : false,
 330       "isConstructor" : false,
 331       "isPrivate" : false,
 332       "example" : "",
 333       "deprecated" : "",
 334       "since" : "",
 335       "see" : "",
 336       "exceptions" : "",
 337       "requires" : "",
 338       "params" : [
 339         {
 340           "name" : "container",
 341           "type" : "String/HTMLElement/Element",
 342           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 343           "isOptional" : false
 344         }
 345       ],
 346       "returns" : []
 347     },
 348     {
 349       "name" : "destroy",
 350       "type" : "function",
 351       "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}.",
 352       "sig" : "()\n{\n\n}",
 353       "static" : false,
 354       "memberOf" : "Roo.Component",
 355       "isStatic" : false,
 356       "isConstructor" : false,
 357       "isPrivate" : false,
 358       "example" : "",
 359       "deprecated" : "",
 360       "since" : "",
 361       "see" : "",
 362       "exceptions" : "",
 363       "requires" : "",
 364       "params" : [],
 365       "returns" : []
 366     },
 367     {
 368       "name" : "isVisible",
 369       "type" : "function",
 370       "desc" : "Returns true if this component is visible.",
 371       "sig" : "()\n{\n\n}",
 372       "static" : false,
 373       "memberOf" : "Roo.Component",
 374       "isStatic" : false,
 375       "isConstructor" : false,
 376       "isPrivate" : false,
 377       "example" : "",
 378       "deprecated" : "",
 379       "since" : "",
 380       "see" : "",
 381       "exceptions" : "",
 382       "requires" : "",
 383       "params" : [],
 384       "returns" : []
 385     },
 386     {
 387       "name" : "setDisabled",
 388       "type" : "function",
 389       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 390       "sig" : "(disabled)",
 391       "static" : false,
 392       "memberOf" : "Roo.Component",
 393       "isStatic" : false,
 394       "isConstructor" : false,
 395       "isPrivate" : false,
 396       "example" : "",
 397       "deprecated" : "",
 398       "since" : "",
 399       "see" : "",
 400       "exceptions" : "",
 401       "requires" : "",
 402       "params" : [
 403         {
 404           "name" : "disabled",
 405           "type" : "Boolean",
 406           "desc" : "",
 407           "isOptional" : false
 408         }
 409       ],
 410       "returns" : []
 411     },
 412     {
 413       "name" : "hide",
 414       "type" : "function",
 415       "desc" : "Hide this component.",
 416       "sig" : "()\n{\n\n}",
 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       "returns" : [
 430         {
 431           "name" : "",
 432           "type" : "Roo.Component",
 433           "desc" : "this"
 434         }
 435       ]
 436     },
 437     {
 438       "name" : "focus",
 439       "type" : "function",
 440       "desc" : "Try to focus this component.",
 441       "sig" : "(selectText)",
 442       "static" : false,
 443       "memberOf" : "Roo.Component",
 444       "isStatic" : false,
 445       "isConstructor" : false,
 446       "isPrivate" : false,
 447       "example" : "",
 448       "deprecated" : "",
 449       "since" : "",
 450       "see" : "",
 451       "exceptions" : "",
 452       "requires" : "",
 453       "params" : [
 454         {
 455           "name" : "selectText",
 456           "type" : "Boolean",
 457           "desc" : "True to also select the text in this component (if applicable)",
 458           "isOptional" : false
 459         }
 460       ],
 461       "returns" : [
 462         {
 463           "name" : "",
 464           "type" : "Roo.Component",
 465           "desc" : "this"
 466         }
 467       ]
 468     },
 469     {
 470       "name" : "show",
 471       "type" : "function",
 472       "desc" : "Show 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" : "enable",
 496       "type" : "function",
 497       "desc" : "Enable this component.",
 498       "sig" : "()\n{\n\n}",
 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       "returns" : [
 512         {
 513           "name" : "",
 514           "type" : "Roo.Component",
 515           "desc" : "this"
 516         }
 517       ]
 518     },
 519     {
 520       "name" : "setVisible",
 521       "type" : "function",
 522       "desc" : "Convenience function to hide or show this component by boolean.",
 523       "sig" : "(visible)",
 524       "static" : false,
 525       "memberOf" : "Roo.Component",
 526       "isStatic" : false,
 527       "isConstructor" : false,
 528       "isPrivate" : false,
 529       "example" : "",
 530       "deprecated" : "",
 531       "since" : "",
 532       "see" : "",
 533       "exceptions" : "",
 534       "requires" : "",
 535       "params" : [
 536         {
 537           "name" : "visible",
 538           "type" : "Boolean",
 539           "desc" : "True to show, false to hide",
 540           "isOptional" : false
 541         }
 542       ],
 543       "returns" : [
 544         {
 545           "name" : "",
 546           "type" : "Roo.Component",
 547           "desc" : "this"
 548         }
 549       ]
 550     },
 551     {
 552       "name" : "disable",
 553       "type" : "function",
 554       "desc" : "Disable this component.",
 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.Component",
 572           "desc" : "this"
 573         }
 574       ]
 575     },
 576     {
 577       "name" : "getEl",
 578       "type" : "function",
 579       "desc" : "Returns the underlying {@link Roo.Element}.",
 580       "sig" : "()\n{\n\n}",
 581       "static" : false,
 582       "memberOf" : "Roo.Component",
 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           "name" : "",
 596           "type" : "Roo.Element",
 597           "desc" : "The element"
 598         }
 599       ]
 600     },
 601     {
 602       "name" : "purgeListeners",
 603       "type" : "function",
 604       "desc" : "Removes all listeners for this object",
 605       "sig" : "()\n{\n\n}",
 606       "static" : false,
 607       "memberOf" : "Roo.util.Observable",
 608       "isStatic" : false,
 609       "isConstructor" : false,
 610       "isPrivate" : false,
 611       "example" : "",
 612       "deprecated" : "",
 613       "since" : "",
 614       "see" : "",
 615       "exceptions" : "",
 616       "requires" : "",
 617       "params" : [],
 618       "returns" : []
 619     },
 620     {
 621       "name" : "on",
 622       "type" : "function",
 623       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 624       "sig" : "(eventName, handler, scope, options)",
 625       "static" : false,
 626       "memberOf" : "Roo.util.Observable",
 627       "isStatic" : false,
 628       "isConstructor" : false,
 629       "isPrivate" : false,
 630       "example" : "",
 631       "deprecated" : "",
 632       "since" : "",
 633       "see" : "",
 634       "exceptions" : "",
 635       "requires" : "",
 636       "params" : [
 637         {
 638           "name" : "eventName",
 639           "type" : "String",
 640           "desc" : "The type of event to listen for",
 641           "isOptional" : false
 642         },
 643         {
 644           "name" : "handler",
 645           "type" : "Function",
 646           "desc" : "The method the event invokes",
 647           "isOptional" : false
 648         },
 649         {
 650           "name" : "scope",
 651           "type" : "Object",
 652           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 653           "isOptional" : false
 654         },
 655         {
 656           "name" : "options",
 657           "type" : "Object",
 658           "desc" : "(optional)",
 659           "isOptional" : false
 660         }
 661       ],
 662       "returns" : []
 663     },
 664     {
 665       "name" : "un",
 666       "type" : "function",
 667       "desc" : "Removes a listener (shorthand for removeListener)",
 668       "sig" : "(eventName, handler, scope)",
 669       "static" : false,
 670       "memberOf" : "Roo.util.Observable",
 671       "isStatic" : false,
 672       "isConstructor" : false,
 673       "isPrivate" : false,
 674       "example" : "",
 675       "deprecated" : "",
 676       "since" : "",
 677       "see" : "",
 678       "exceptions" : "",
 679       "requires" : "",
 680       "params" : [
 681         {
 682           "name" : "eventName",
 683           "type" : "String",
 684           "desc" : "The type of event to listen for",
 685           "isOptional" : false
 686         },
 687         {
 688           "name" : "handler",
 689           "type" : "Function",
 690           "desc" : "The handler to remove",
 691           "isOptional" : false
 692         },
 693         {
 694           "name" : "scope",
 695           "type" : "Object",
 696           "desc" : "(optional) The scope (this object) for the handler",
 697           "isOptional" : false
 698         }
 699       ],
 700       "returns" : []
 701     },
 702     {
 703       "name" : "addEvents",
 704       "type" : "function",
 705       "desc" : "Used to define events on this Observable",
 706       "sig" : "(object)",
 707       "static" : false,
 708       "memberOf" : "Roo.util.Observable",
 709       "isStatic" : false,
 710       "isConstructor" : false,
 711       "isPrivate" : false,
 712       "example" : "",
 713       "deprecated" : "",
 714       "since" : "",
 715       "see" : "",
 716       "exceptions" : "",
 717       "requires" : "",
 718       "params" : [
 719         {
 720           "name" : "object",
 721           "type" : "Object",
 722           "desc" : "The object with the events defined",
 723           "isOptional" : false
 724         }
 725       ],
 726       "returns" : []
 727     },
 728     {
 729       "name" : "releaseCapture",
 730       "type" : "function",
 731       "desc" : "Removes <b>all</b> added captures from the Observable.",
 732       "sig" : "(o)",
 733       "static" : true,
 734       "memberOf" : "Roo.util.Observable",
 735       "isStatic" : true,
 736       "isConstructor" : false,
 737       "isPrivate" : false,
 738       "example" : "",
 739       "deprecated" : "",
 740       "since" : "",
 741       "see" : "",
 742       "exceptions" : "",
 743       "requires" : "",
 744       "params" : [
 745         {
 746           "name" : "o",
 747           "type" : "Observable",
 748           "desc" : "The Observable to release",
 749           "isOptional" : false
 750         }
 751       ],
 752       "returns" : []
 753     },
 754     {
 755       "name" : "removeListener",
 756       "type" : "function",
 757       "desc" : "Removes a listener",
 758       "sig" : "(eventName, handler, scope)",
 759       "static" : false,
 760       "memberOf" : "Roo.util.Observable",
 761       "isStatic" : false,
 762       "isConstructor" : false,
 763       "isPrivate" : false,
 764       "example" : "",
 765       "deprecated" : "",
 766       "since" : "",
 767       "see" : "",
 768       "exceptions" : "",
 769       "requires" : "",
 770       "params" : [
 771         {
 772           "name" : "eventName",
 773           "type" : "String",
 774           "desc" : "The type of event to listen for",
 775           "isOptional" : false
 776         },
 777         {
 778           "name" : "handler",
 779           "type" : "Function",
 780           "desc" : "The handler to remove",
 781           "isOptional" : false
 782         },
 783         {
 784           "name" : "scope",
 785           "type" : "Object",
 786           "desc" : "(optional) The scope (this object) for the handler",
 787           "isOptional" : false
 788         }
 789       ],
 790       "returns" : []
 791     },
 792     {
 793       "name" : "fireEvent",
 794       "type" : "function",
 795       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 796       "sig" : "(eventName, args)",
 797       "static" : false,
 798       "memberOf" : "Roo.util.Observable",
 799       "isStatic" : false,
 800       "isConstructor" : false,
 801       "isPrivate" : false,
 802       "example" : "",
 803       "deprecated" : "",
 804       "since" : "",
 805       "see" : "",
 806       "exceptions" : "",
 807       "requires" : "",
 808       "params" : [
 809         {
 810           "name" : "eventName",
 811           "type" : "String",
 812           "desc" : "",
 813           "isOptional" : false
 814         },
 815         {
 816           "name" : "args",
 817           "type" : "Object...",
 818           "desc" : "Variable number of parameters are passed to handlers",
 819           "isOptional" : false
 820         }
 821       ],
 822       "returns" : [
 823         {
 824           "name" : "",
 825           "type" : "Boolean",
 826           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 827         }
 828       ]
 829     },
 830     {
 831       "name" : "hasListener",
 832       "type" : "function",
 833       "desc" : "Checks to see if this object has any listeners for a specified event",
 834       "sig" : "(eventName)",
 835       "static" : false,
 836       "memberOf" : "Roo.util.Observable",
 837       "isStatic" : false,
 838       "isConstructor" : false,
 839       "isPrivate" : false,
 840       "example" : "",
 841       "deprecated" : "",
 842       "since" : "",
 843       "see" : "",
 844       "exceptions" : "",
 845       "requires" : "",
 846       "params" : [
 847         {
 848           "name" : "eventName",
 849           "type" : "String",
 850           "desc" : "The name of the event to check for",
 851           "isOptional" : false
 852         }
 853       ],
 854       "returns" : [
 855         {
 856           "name" : "",
 857           "type" : "Boolean",
 858           "desc" : "True if the event is being listened for, else false"
 859         }
 860       ]
 861     },
 862     {
 863       "name" : "capture",
 864       "type" : "function",
 865       "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.",
 866       "sig" : "(o, fn, scope)",
 867       "static" : true,
 868       "memberOf" : "Roo.util.Observable",
 869       "isStatic" : true,
 870       "isConstructor" : false,
 871       "isPrivate" : false,
 872       "example" : "",
 873       "deprecated" : "",
 874       "since" : "",
 875       "see" : "",
 876       "exceptions" : "",
 877       "requires" : "",
 878       "params" : [
 879         {
 880           "name" : "o",
 881           "type" : "Observable",
 882           "desc" : "The Observable to capture",
 883           "isOptional" : false
 884         },
 885         {
 886           "name" : "fn",
 887           "type" : "Function",
 888           "desc" : "The function to call",
 889           "isOptional" : false
 890         },
 891         {
 892           "name" : "scope",
 893           "type" : "Object",
 894           "desc" : "(optional) The scope (this object) for the fn",
 895           "isOptional" : false
 896         }
 897       ],
 898       "returns" : []
 899     },
 900     {
 901       "name" : "addListener",
 902       "type" : "function",
 903       "desc" : "Appends an event handler to this component",
 904       "sig" : "(eventName, handler, scope, options)",
 905       "static" : false,
 906       "memberOf" : "Roo.util.Observable",
 907       "isStatic" : false,
 908       "isConstructor" : false,
 909       "isPrivate" : false,
 910       "example" : "",
 911       "deprecated" : "",
 912       "since" : "",
 913       "see" : "",
 914       "exceptions" : "",
 915       "requires" : "",
 916       "params" : [
 917         {
 918           "name" : "eventName",
 919           "type" : "String",
 920           "desc" : "The type of event to listen for",
 921           "isOptional" : false
 922         },
 923         {
 924           "name" : "handler",
 925           "type" : "Function",
 926           "desc" : "The method the event invokes",
 927           "isOptional" : false
 928         },
 929         {
 930           "name" : "scope",
 931           "type" : "Object",
 932           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 933           "isOptional" : false
 934         },
 935         {
 936           "name" : "options",
 937           "type" : "Object",
 938           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
 939           "isOptional" : false
 940         }
 941       ],
 942       "returns" : []
 943     }
 944   ],
 945   "events" : [
 946     {
 947       "name" : "select",
 948       "type" : "function",
 949       "desc" : "Fires when a date is selected",
 950       "sig" : "function (_self, date)\n{\n\n}",
 951       "memberOf" : "",
 952       "example" : "",
 953       "deprecated" : "",
 954       "since" : "",
 955       "see" : "",
 956       "params" : [
 957         {
 958           "name" : "this",
 959           "type" : "DatePicker",
 960           "desc" : "",
 961           "isOptional" : false
 962         },
 963         {
 964           "name" : "date",
 965           "type" : "Date",
 966           "desc" : "The selected date",
 967           "isOptional" : false
 968         }
 969       ],
 970       "returns" : []
 971     },
 972     {
 973       "name" : "monthchange",
 974       "type" : "function",
 975       "desc" : "Fires when the displayed month changes",
 976       "sig" : "function (_self, date)\n{\n\n}",
 977       "memberOf" : "",
 978       "example" : "",
 979       "deprecated" : "",
 980       "since" : "",
 981       "see" : "",
 982       "params" : [
 983         {
 984           "name" : "this",
 985           "type" : "DatePicker",
 986           "desc" : "",
 987           "isOptional" : false
 988         },
 989         {
 990           "name" : "date",
 991           "type" : "Date",
 992           "desc" : "The selected month",
 993           "isOptional" : false
 994         }
 995       ],
 996       "returns" : []
 997     },
 998     {
 999       "name" : "beforerender",
1000       "type" : "function",
1001       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1002       "sig" : "function (_self)\n{\n\n}",
1003       "memberOf" : "Roo.Component",
1004       "example" : "",
1005       "deprecated" : "",
1006       "since" : "",
1007       "see" : "",
1008       "params" : [
1009         {
1010           "name" : "this",
1011           "type" : "Roo.Component",
1012           "desc" : "",
1013           "isOptional" : false
1014         }
1015       ],
1016       "returns" : []
1017     },
1018     {
1019       "name" : "disable",
1020       "type" : "function",
1021       "desc" : "Fires after the component is disabled.",
1022       "sig" : "function (_self)\n{\n\n}",
1023       "memberOf" : "Roo.Component",
1024       "example" : "",
1025       "deprecated" : "",
1026       "since" : "",
1027       "see" : "",
1028       "params" : [
1029         {
1030           "name" : "this",
1031           "type" : "Roo.Component",
1032           "desc" : "",
1033           "isOptional" : false
1034         }
1035       ],
1036       "returns" : []
1037     },
1038     {
1039       "name" : "render",
1040       "type" : "function",
1041       "desc" : "Fires after the component is rendered.",
1042       "sig" : "function (_self)\n{\n\n}",
1043       "memberOf" : "Roo.Component",
1044       "example" : "",
1045       "deprecated" : "",
1046       "since" : "",
1047       "see" : "",
1048       "params" : [
1049         {
1050           "name" : "this",
1051           "type" : "Roo.Component",
1052           "desc" : "",
1053           "isOptional" : false
1054         }
1055       ],
1056       "returns" : []
1057     },
1058     {
1059       "name" : "destroy",
1060       "type" : "function",
1061       "desc" : "Fires after the component is destroyed.",
1062       "sig" : "function (_self)\n{\n\n}",
1063       "memberOf" : "Roo.Component",
1064       "example" : "",
1065       "deprecated" : "",
1066       "since" : "",
1067       "see" : "",
1068       "params" : [
1069         {
1070           "name" : "this",
1071           "type" : "Roo.Component",
1072           "desc" : "",
1073           "isOptional" : false
1074         }
1075       ],
1076       "returns" : []
1077     },
1078     {
1079       "name" : "hide",
1080       "type" : "function",
1081       "desc" : "Fires after the component is hidden.",
1082       "sig" : "function (_self)\n{\n\n}",
1083       "memberOf" : "Roo.Component",
1084       "example" : "",
1085       "deprecated" : "",
1086       "since" : "",
1087       "see" : "",
1088       "params" : [
1089         {
1090           "name" : "this",
1091           "type" : "Roo.Component",
1092           "desc" : "",
1093           "isOptional" : false
1094         }
1095       ],
1096       "returns" : []
1097     },
1098     {
1099       "name" : "beforehide",
1100       "type" : "function",
1101       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1102       "sig" : "function (_self)\n{\n\n}",
1103       "memberOf" : "Roo.Component",
1104       "example" : "",
1105       "deprecated" : "",
1106       "since" : "",
1107       "see" : "",
1108       "params" : [
1109         {
1110           "name" : "this",
1111           "type" : "Roo.Component",
1112           "desc" : "",
1113           "isOptional" : false
1114         }
1115       ],
1116       "returns" : []
1117     },
1118     {
1119       "name" : "show",
1120       "type" : "function",
1121       "desc" : "Fires after the component is shown.",
1122       "sig" : "function (_self)\n{\n\n}",
1123       "memberOf" : "Roo.Component",
1124       "example" : "",
1125       "deprecated" : "",
1126       "since" : "",
1127       "see" : "",
1128       "params" : [
1129         {
1130           "name" : "this",
1131           "type" : "Roo.Component",
1132           "desc" : "",
1133           "isOptional" : false
1134         }
1135       ],
1136       "returns" : []
1137     },
1138     {
1139       "name" : "beforeshow",
1140       "type" : "function",
1141       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1142       "sig" : "function (_self)\n{\n\n}",
1143       "memberOf" : "Roo.Component",
1144       "example" : "",
1145       "deprecated" : "",
1146       "since" : "",
1147       "see" : "",
1148       "params" : [
1149         {
1150           "name" : "this",
1151           "type" : "Roo.Component",
1152           "desc" : "",
1153           "isOptional" : false
1154         }
1155       ],
1156       "returns" : []
1157     },
1158     {
1159       "name" : "enable",
1160       "type" : "function",
1161       "desc" : "Fires after the component is enabled.",
1162       "sig" : "function (_self)\n{\n\n}",
1163       "memberOf" : "Roo.Component",
1164       "example" : "",
1165       "deprecated" : "",
1166       "since" : "",
1167       "see" : "",
1168       "params" : [
1169         {
1170           "name" : "this",
1171           "type" : "Roo.Component",
1172           "desc" : "",
1173           "isOptional" : false
1174         }
1175       ],
1176       "returns" : []
1177     },
1178     {
1179       "name" : "beforedestroy",
1180       "type" : "function",
1181       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1182       "sig" : "function (_self)\n{\n\n}",
1183       "memberOf" : "Roo.Component",
1184       "example" : "",
1185       "deprecated" : "",
1186       "since" : "",
1187       "see" : "",
1188       "params" : [
1189         {
1190           "name" : "this",
1191           "type" : "Roo.Component",
1192           "desc" : "",
1193           "isOptional" : false
1194         }
1195       ],
1196       "returns" : []
1197     }
1198   ]
1199 }