Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / DateMenu.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js"><div id="cls-Ext.menu.DateMenu"></div>/**\r
10  * @class Ext.menu.DateMenu\r
11  * @extends Ext.menu.Menu\r
12  * <p>A menu containing an {@link Ext.DatePicker} Component.</p>\r
13  * <p>Notes:</p><div class="mdetail-params"><ul>\r
14  * <li>Although not listed here, the <b>constructor</b> for this class\r
15  * accepts all of the configuration options of <b>{@link Ext.DatePicker}</b>.</li>\r
16  * <li>If subclassing DateMenu, any configuration options for the DatePicker must be\r
17  * applied to the <tt><b>initialConfig</b></tt> property of the DateMenu.\r
18  * Applying {@link Ext.DatePicker DatePicker} configuration settings to\r
19  * <b><tt>this</tt></b> will <b>not</b> affect the DatePicker's configuration.</li>\r
20  * </ul></div>\r
21  * @xtype datemenu\r
22  */\r
23  Ext.menu.DateMenu = Ext.extend(Ext.menu.Menu, {\r
24     <div id="cfg-Ext.menu.DateMenu-enableScrolling"></div>/** \r
25      * @cfg {Boolean} enableScrolling\r
26      * @hide \r
27      */\r
28     enableScrolling : false,\r
29     <div id="cfg-Ext.menu.DateMenu-handler"></div>/**\r
30      * @cfg {Function} handler\r
31      * Optional. A function that will handle the select event of this menu.\r
32      * The handler is passed the following parameters:<div class="mdetail-params"><ul>\r
33      * <li><code>picker</code> : DatePicker<div class="sub-desc">The Ext.DatePicker.</div></li>\r
34      * <li><code>date</code> : Date<div class="sub-desc">The selected date.</div></li>\r
35      * </ul></div>\r
36      */\r
37     <div id="cfg-Ext.menu.DateMenu-scope"></div>/**\r
38      * @cfg {Object} scope\r
39      * The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>\r
40      * function will be called.  Defaults to this DateMenu instance.\r
41      */    \r
42     <div id="cfg-Ext.menu.DateMenu-hideOnClick"></div>/** \r
43      * @cfg {Boolean} hideOnClick\r
44      * False to continue showing the menu after a date is selected, defaults to true.\r
45      */\r
46     hideOnClick : true,\r
47     \r
48     <div id="cfg-Ext.menu.DateMenu-pickerId"></div>/** \r
49      * @cfg {String} pickerId\r
50      * An id to assign to the underlying date picker. Defaults to <tt>null</tt>.\r
51      */\r
52     pickerId : null,\r
53     \r
54     <div id="cfg-Ext.menu.DateMenu-maxHeight"></div>/** \r
55      * @cfg {Number} maxHeight\r
56      * @hide \r
57      */\r
58     <div id="cfg-Ext.menu.DateMenu-scrollIncrement"></div>/** \r
59      * @cfg {Number} scrollIncrement\r
60      * @hide \r
61      */\r
62     <div id="prop-Ext.menu.DateMenu-picker"></div>/**\r
63      * The {@link Ext.DatePicker} instance for this DateMenu\r
64      * @property picker\r
65      * @type DatePicker\r
66      */\r
67     cls : 'x-date-menu',\r
68     \r
69     <div id="event-Ext.menu.DateMenu-click"></div>/**\r
70      * @event click\r
71      * @hide\r
72      */\r
73     \r
74     <div id="event-Ext.menu.DateMenu-itemclick"></div>/**\r
75      * @event itemclick\r
76      * @hide\r
77      */\r
78 \r
79     initComponent : function(){\r
80         this.on('beforeshow', this.onBeforeShow, this);\r
81         if(this.strict = (Ext.isIE7 && Ext.isStrict)){\r
82             this.on('show', this.onShow, this, {single: true, delay: 20});\r
83         }\r
84         Ext.apply(this, {\r
85             plain: true,\r
86             showSeparator: false,\r
87             items: this.picker = new Ext.DatePicker(Ext.applyIf({\r
88                 internalRender: this.strict || !Ext.isIE,\r
89                 ctCls: 'x-menu-date-item',\r
90                 id: this.pickerId\r
91             }, this.initialConfig))\r
92         });\r
93         this.picker.purgeListeners();\r
94         Ext.menu.DateMenu.superclass.initComponent.call(this);\r
95         <div id="event-Ext.menu.DateMenu-select"></div>/**\r
96          * @event select\r
97          * Fires when a date is selected from the {@link #picker Ext.DatePicker}\r
98          * @param {DatePicker} picker The {@link #picker Ext.DatePicker}\r
99          * @param {Date} date The selected date\r
100          */\r
101         this.relayEvents(this.picker, ['select']);\r
102         this.on('show', this.picker.focus, this.picker);\r
103         this.on('select', this.menuHide, this);\r
104         if(this.handler){\r
105             this.on('select', this.handler, this.scope || this);\r
106         }\r
107     },\r
108 \r
109     menuHide : function() {\r
110         if(this.hideOnClick){\r
111             this.hide(true);\r
112         }\r
113     },\r
114 \r
115     onBeforeShow : function(){\r
116         if(this.picker){\r
117             this.picker.hideMonthPicker(true);\r
118         }\r
119     },\r
120 \r
121     onShow : function(){\r
122         var el = this.picker.getEl();\r
123         el.setWidth(el.getWidth()); //nasty hack for IE7 strict mode\r
124     }\r
125  });\r
126  Ext.reg('datemenu', Ext.menu.DateMenu);\r
127  </pre>    \r
128 </body>\r
129 </html>