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