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