Upgrade to ExtJS 4.0.7 - Released 10/19/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="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../resources/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> * A menu containing an Ext.picker.Date Component.
20  *
21  * Notes:
22  *
23  * - Although not listed here, the **constructor** for this class accepts all of the
24  *   configuration options of **{@link Ext.picker.Date}**.
25  * - If subclassing DateMenu, any configuration options for the DatePicker must be applied
26  *   to the **initialConfig** property of the DateMenu. Applying {@link Ext.picker.Date Date Picker}
27  *   configuration settings to **this** will **not** affect the Date Picker's configuration.
28  *
29  * Example:
30  *
31  *     @example
32  *     var dateMenu = Ext.create('Ext.menu.DatePicker', {
33  *         handler: function(dp, date){
34  *             Ext.Msg.alert('Date Selected', 'You selected ' + Ext.Date.format(date, 'M j, Y'));
35  *         }
36  *     });
37  *
38  *     Ext.create('Ext.menu.Menu', {
39  *         width: 100,
40  *         height: 90,
41  *         floating: false,  // usually you want this set to True (default)
42  *         renderTo: Ext.getBody(),  // usually rendered by it's containing component
43  *         items: [{
44  *             text: 'choose a date',
45  *             menu: dateMenu
46  *         },{
47  *             iconCls: 'add16',
48  *             text: 'icon item'
49  *         },{
50  *             text: 'regular item'
51  *         }]
52  *     });
53  */
54  Ext.define('Ext.menu.DatePicker', {
55      extend: 'Ext.menu.Menu',
56
57      alias: 'widget.datemenu',
58
59      requires: [
60         'Ext.picker.Date'
61      ],
62
63 <span id='Ext-menu-DatePicker-cfg-hideOnClick'>    /**
64 </span>     * @cfg {Boolean} hideOnClick
65      * False to continue showing the menu after a date is selected.
66      */
67     hideOnClick : true,
68
69 <span id='Ext-menu-DatePicker-cfg-pickerId'>    /**
70 </span>     * @cfg {String} pickerId
71      * An id to assign to the underlying date picker.
72      */
73     pickerId : null,
74
75 <span id='Ext-menu-DatePicker-cfg-maxHeight'>    /**
76 </span>     * @cfg {Number} maxHeight
77      * @hide
78      */
79
80 <span id='Ext-menu-DatePicker-property-picker'>    /**
81 </span>     * @property {Ext.picker.Date} picker
82      * The {@link Ext.picker.Date} instance for this DateMenu
83      */
84
85 <span id='Ext-menu-DatePicker-event-click'>    /**
86 </span>     * @event click
87      * @hide
88      */
89
90 <span id='Ext-menu-DatePicker-event-itemclick'>    /**
91 </span>     * @event itemclick
92      * @hide
93      */
94
95     initComponent : function(){
96         var me = this;
97
98         Ext.apply(me, {
99             showSeparator: false,
100             plain: true,
101             border: false,
102             bodyPadding: 0, // remove the body padding from the datepicker menu item so it looks like 3.3
103             items: Ext.applyIf({
104                 cls: Ext.baseCSSPrefix + 'menu-date-item',
105                 id: me.pickerId,
106                 xtype: 'datepicker'
107             }, me.initialConfig)
108         });
109
110         me.callParent(arguments);
111
112         me.picker = me.down('datepicker');
113 <span id='Ext-menu-DatePicker-event-select'>        /**
114 </span>         * @event select
115          * @alias Ext.picker.Date#select
116          */
117         me.relayEvents(me.picker, ['select']);
118
119         if (me.hideOnClick) {
120             me.on('select', me.hidePickerOnSelect, me);
121         }
122     },
123
124     hidePickerOnSelect: function() {
125         Ext.menu.Manager.hideAll();
126     }
127  });</pre>
128 </body>
129 </html>