Upgrade to ExtJS 4.0.1 - Released 05/18/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  * {@img Ext.menu.DatePicker/Ext.menu.DatePicker.png Ext.menu.DatePicker component}
31  * __Example Usage__
32      var dateMenu = Ext.create('Ext.menu.DatePicker', {
33         handler: function(dp, date){
34             Ext.Msg.alert('Date Selected', 'You choose {0}.', Ext.Date.format(date, 'M j, Y'));
35
36         }
37     });
38
39     Ext.create('Ext.menu.Menu', {
40                 width: 100,
41                 height: 90,
42                 floating: false,  // usually you want this set to True (default)
43                 renderTo: Ext.getBody(),  // usually rendered by it's containing component
44                 items: [{
45                     text: 'choose a date',
46                     menu: dateMenu
47                 },{
48             iconCls: 'add16',
49                     text: 'icon item'
50                 },{
51                     text: 'regular item'
52                 }]
53         });
54
55  * @xtype datemenu
56  * @author Nicolas Ferrero
57  */
58  Ext.define('Ext.menu.DatePicker', {
59      extend: 'Ext.menu.Menu',
60
61      alias: 'widget.datemenu',
62
63      requires: [
64         'Ext.picker.Date'
65      ],
66
67 <span id='Ext-menu-DatePicker-cfg-hideOnClick'>    /**
68 </span>     * @cfg {Boolean} hideOnClick
69      * False to continue showing the menu after a date is selected, defaults to true.
70      */
71     hideOnClick : true,
72
73 <span id='Ext-menu-DatePicker-cfg-pickerId'>    /**
74 </span>     * @cfg {String} pickerId
75      * An id to assign to the underlying date picker. Defaults to &lt;tt&gt;null&lt;/tt&gt;.
76      */
77     pickerId : null,
78
79 <span id='Ext-menu-DatePicker-cfg-maxHeight'>    /**
80 </span>     * @cfg {Number} maxHeight
81      * @hide
82      */
83
84 <span id='Ext-menu-DatePicker-property-picker'>    /**
85 </span>     * The {@link Ext.picker.Date} instance for this DateMenu
86      * @property picker
87      * @type Ext.picker.Date
88      */
89
90 <span id='Ext-menu-DatePicker-event-click'>    /**
91 </span>     * @event click
92      * @hide
93      */
94
95 <span id='Ext-menu-DatePicker-event-itemclick'>    /**
96 </span>     * @event itemclick
97      * @hide
98      */
99
100     initComponent : function(){
101         var me = this;
102
103         Ext.apply(me, {
104             showSeparator: false,
105             plain: true,
106             items: Ext.applyIf({
107                 cls: Ext.baseCSSPrefix + 'menu-date-item',
108                 id: me.pickerId,
109                 xtype: 'datepicker'
110             }, me.initialConfig)
111         });
112
113         me.callParent(arguments);
114
115         me.picker = me.down('datepicker');
116 <span id='Ext-menu-DatePicker-event-select'>        /**
117 </span>         * @event select
118          * Fires when a date is selected from the {@link #picker Ext.picker.Date}
119          * @param {Ext.picker.Date} picker The {@link #picker Ext.picker.Date}
120          * @param {Date} date The selected date
121          */
122         me.relayEvents(me.picker, ['select']);
123
124         if (me.hideOnClick) {
125             me.on('select', me.hidePickerOnSelect, me);
126         }
127     },
128
129     hidePickerOnSelect: function() {
130         Ext.menu.Manager.hideAll();
131     }
132  });</pre>
133 </body>
134 </html>