Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / DatePicker.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5   <title>The source code</title>
6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../prettify/prettify.js"></script>
8   <style type="text/css">
9     .highlight { display: block; background-color: #ddd; }
10   </style>
11   <script type="text/javascript">
12     function highlight() {
13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
14     }
15   </script>
16 </head>
17 <body onload="prettyPrint(); highlight();">
18   <pre class="prettyprint lang-js"><span id='Ext-menu-DatePicker'>/**
19 </span> * @class Ext.menu.DatePicker
20  * @extends Ext.menu.Menu
21  * &lt;p&gt;A menu containing an {@link Ext.picker.Date} Component.&lt;/p&gt;
22  * &lt;p&gt;Notes:&lt;/p&gt;&lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
23  * &lt;li&gt;Although not listed here, the &lt;b&gt;constructor&lt;/b&gt; for this class
24  * accepts all of the configuration options of &lt;b&gt;{@link Ext.picker.Date}&lt;/b&gt;.&lt;/li&gt;
25  * &lt;li&gt;If subclassing DateMenu, any configuration options for the DatePicker must be
26  * applied to the &lt;tt&gt;&lt;b&gt;initialConfig&lt;/b&gt;&lt;/tt&gt; property of the DateMenu.
27  * Applying {@link Ext.picker.Date DatePicker} configuration settings to
28  * &lt;b&gt;&lt;tt&gt;this&lt;/tt&gt;&lt;/b&gt; will &lt;b&gt;not&lt;/b&gt; affect the DatePicker's configuration.&lt;/li&gt;
29  * &lt;/ul&gt;&lt;/div&gt;
30  *
31  * {@img Ext.menu.DatePicker/Ext.menu.DatePicker.png Ext.menu.DatePicker component}
32  *
33  * __Example Usage__
34  *
35  *     var dateMenu = Ext.create('Ext.menu.DatePicker', {
36  *         handler: function(dp, date){
37  *             Ext.Msg.alert('Date Selected', 'You choose {0}.', Ext.Date.format(date, 'M j, Y'));
38  *         }
39  *     });
40  *  
41  *     Ext.create('Ext.menu.Menu', {
42  *         width: 100,
43  *         height: 90,
44  *         floating: false,  // usually you want this set to True (default)
45  *         renderTo: Ext.getBody(),  // usually rendered by it's containing component
46  *         items: [{
47  *             text: 'choose a date',
48  *             menu: dateMenu
49  *         },{
50  *             iconCls: 'add16',
51  *             text: 'icon item'
52  *         },{
53  *             text: 'regular item'
54  *         }]
55  *     });
56  *
57  * @author Nicolas Ferrero
58  */
59  Ext.define('Ext.menu.DatePicker', {
60      extend: 'Ext.menu.Menu',
61
62      alias: 'widget.datemenu',
63
64      requires: [
65         'Ext.picker.Date'
66      ],
67
68 <span id='Ext-menu-DatePicker-cfg-hideOnClick'>    /**
69 </span>     * @cfg {Boolean} hideOnClick
70      * False to continue showing the menu after a date is selected, defaults to true.
71      */
72     hideOnClick : true,
73
74 <span id='Ext-menu-DatePicker-cfg-pickerId'>    /**
75 </span>     * @cfg {String} pickerId
76      * An id to assign to the underlying date picker. Defaults to &lt;tt&gt;null&lt;/tt&gt;.
77      */
78     pickerId : null,
79
80 <span id='Ext-menu-DatePicker-cfg-maxHeight'>    /**
81 </span>     * @cfg {Number} maxHeight
82      * @hide
83      */
84
85 <span id='Ext-menu-DatePicker-property-picker'>    /**
86 </span>     * The {@link Ext.picker.Date} instance for this DateMenu
87      * @property picker
88      * @type Ext.picker.Date
89      */
90
91 <span id='Ext-menu-DatePicker-event-click'>    /**
92 </span>     * @event click
93      * @hide
94      */
95
96 <span id='Ext-menu-DatePicker-event-itemclick'>    /**
97 </span>     * @event itemclick
98      * @hide
99      */
100
101     initComponent : function(){
102         var me = this;
103
104         Ext.apply(me, {
105             showSeparator: false,
106             plain: true,
107             border: false,
108             bodyPadding: 0, // remove the body padding from the datepicker menu item so it looks like 3.3
109             items: Ext.applyIf({
110                 cls: Ext.baseCSSPrefix + 'menu-date-item',
111                 id: me.pickerId,
112                 xtype: 'datepicker'
113             }, me.initialConfig)
114         });
115
116         me.callParent(arguments);
117
118         me.picker = me.down('datepicker');
119 <span id='Ext-menu-DatePicker-event-select'>        /**
120 </span>         * @event select
121          * Fires when a date is selected from the {@link #picker Ext.picker.Date}
122          * @param {Ext.picker.Date} picker The {@link #picker Ext.picker.Date}
123          * @param {Date} date The selected date
124          */
125         me.relayEvents(me.picker, ['select']);
126
127         if (me.hideOnClick) {
128             me.on('select', me.hidePickerOnSelect, me);
129         }
130     },
131
132     hidePickerOnSelect: function() {
133         Ext.menu.Manager.hideAll();
134     }
135  });</pre>
136 </body>
137 </html>