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