Upgrade to ExtJS 3.3.1 - Released 11/30/2010
[extjs.git] / src / widgets / menu / DateMenu.js
index 3a879f1..290595f 100644 (file)
 /*!
 /*!
- * Ext JS Library 3.0.0
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
  */
  */
-/**\r
- * @class Ext.menu.DateMenu\r
- * @extends Ext.menu.Menu\r
- * A menu containing a {@link Ext.DatePicker} Component.\r
- * @xtype datemenu\r
- */\r
- Ext.menu.DateMenu = Ext.extend(Ext.menu.Menu, {\r
-    /** \r
-     * @cfg {Boolean} enableScrolling\r
-     * @hide \r
-     */\r
-    enableScrolling: false,\r
-    \r
-    /** \r
-     * @cfg {Boolean} hideOnClick\r
-     * False to continue showing the menu after a date is selected, defaults to true.\r
-     */\r
-    hideOnClick: true,\r
-    \r
-    /** \r
-     * @cfg {Number} maxHeight\r
-     * @hide \r
-     */\r
-    /** \r
-     * @cfg {Number} scrollIncrement\r
-     * @hide \r
-     */\r
-    /**\r
-     * @property picker\r
-     * @type DatePicker\r
-     * The {@link Ext.DatePicker} instance for this DateMenu\r
-     */\r
-    cls: 'x-date-menu',\r
-    \r
-    /**\r
-     * @event click\r
-     * @hide\r
-     */\r
-    \r
-    /**\r
-     * @event itemclick\r
-     * @hide\r
-     */\r
-\r
-    initComponent: function(){\r
-        this.on('beforeshow', this.onBeforeShow, this);\r
-        if(this.strict = (Ext.isIE7 && Ext.isStrict)){\r
-            this.on('show', this.onShow, this, {single: true, delay: 20});\r
-        }\r
-        Ext.apply(this, {\r
-            plain: true,\r
-            showSeparator: false,\r
-            items: this.picker = new Ext.DatePicker(Ext.apply({\r
-                internalRender: this.strict || !Ext.isIE,\r
-                ctCls: 'x-menu-date-item'\r
-            }, this.initialConfig))\r
-        });\r
-        this.picker.purgeListeners();\r
-        Ext.menu.DateMenu.superclass.initComponent.call(this);\r
-        this.relayEvents(this.picker, ["select"]);\r
-        this.on('select', this.menuHide, this);\r
-        if(this.handler){\r
-            this.on('select', this.handler, this.scope || this);\r
-        }\r
-    },\r
-\r
-    menuHide: function() {\r
-        if(this.hideOnClick){\r
-            this.hide(true);\r
-        }\r
-    },\r
-\r
-    onBeforeShow: function(){\r
-        if(this.picker){\r
-            this.picker.hideMonthPicker(true);\r
-        }\r
-    },\r
-\r
-    onShow: function(){\r
-        var el = this.picker.getEl();\r
-        el.setWidth(el.getWidth()); //nasty hack for IE7 strict mode\r
-    }\r
- });\r
- Ext.reg('datemenu', Ext.menu.DateMenu);
\ No newline at end of file
+/**
+ * @class Ext.menu.DateMenu
+ * @extends Ext.menu.Menu
+ * <p>A menu containing an {@link Ext.DatePicker} Component.</p>
+ * <p>Notes:</p><div class="mdetail-params"><ul>
+ * <li>Although not listed here, the <b>constructor</b> for this class
+ * accepts all of the configuration options of <b>{@link Ext.DatePicker}</b>.</li>
+ * <li>If subclassing DateMenu, any configuration options for the DatePicker must be
+ * applied to the <tt><b>initialConfig</b></tt> property of the DateMenu.
+ * Applying {@link Ext.DatePicker DatePicker} configuration settings to
+ * <b><tt>this</tt></b> will <b>not</b> affect the DatePicker's configuration.</li>
+ * </ul></div>
+ * @xtype datemenu
+ */
+ Ext.menu.DateMenu = Ext.extend(Ext.menu.Menu, {
+    /** 
+     * @cfg {Boolean} enableScrolling
+     * @hide 
+     */
+    enableScrolling : false,
+    /**
+     * @cfg {Function} handler
+     * Optional. A function that will handle the select event of this menu.
+     * The handler is passed the following parameters:<div class="mdetail-params"><ul>
+     * <li><code>picker</code> : DatePicker<div class="sub-desc">The Ext.DatePicker.</div></li>
+     * <li><code>date</code> : Date<div class="sub-desc">The selected date.</div></li>
+     * </ul></div>
+     */
+    /**
+     * @cfg {Object} scope
+     * The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>
+     * function will be called.  Defaults to this DateMenu instance.
+     */    
+    /** 
+     * @cfg {Boolean} hideOnClick
+     * False to continue showing the menu after a date is selected, defaults to true.
+     */
+    hideOnClick : true,
+    
+    /** 
+     * @cfg {String} pickerId
+     * An id to assign to the underlying date picker. Defaults to <tt>null</tt>.
+     */
+    pickerId : null,
+    
+    /** 
+     * @cfg {Number} maxHeight
+     * @hide 
+     */
+    /** 
+     * @cfg {Number} scrollIncrement
+     * @hide 
+     */
+    /**
+     * The {@link Ext.DatePicker} instance for this DateMenu
+     * @property picker
+     * @type DatePicker
+     */
+    cls : 'x-date-menu',
+    
+    /**
+     * @event click
+     * @hide
+     */
+    
+    /**
+     * @event itemclick
+     * @hide
+     */
+
+    initComponent : function(){
+        this.on('beforeshow', this.onBeforeShow, this);
+        if(this.strict = (Ext.isIE7 && Ext.isStrict)){
+            this.on('show', this.onShow, this, {single: true, delay: 20});
+        }
+        Ext.apply(this, {
+            plain: true,
+            showSeparator: false,
+            items: this.picker = new Ext.DatePicker(Ext.applyIf({
+                internalRender: this.strict || !Ext.isIE,
+                ctCls: 'x-menu-date-item',
+                id: this.pickerId
+            }, this.initialConfig))
+        });
+        this.picker.purgeListeners();
+        Ext.menu.DateMenu.superclass.initComponent.call(this);
+        /**
+         * @event select
+         * Fires when a date is selected from the {@link #picker Ext.DatePicker}
+         * @param {DatePicker} picker The {@link #picker Ext.DatePicker}
+         * @param {Date} date The selected date
+         */
+        this.relayEvents(this.picker, ['select']);
+        this.on('show', this.picker.focus, this.picker);
+        this.on('select', this.menuHide, this);
+        if(this.handler){
+            this.on('select', this.handler, this.scope || this);
+        }
+    },
+
+    menuHide : function() {
+        if(this.hideOnClick){
+            this.hide(true);
+        }
+    },
+
+    onBeforeShow : function(){
+        if(this.picker){
+            this.picker.hideMonthPicker(true);
+        }
+    },
+
+    onShow : function(){
+        var el = this.picker.getEl();
+        el.setWidth(el.getWidth()); //nasty hack for IE7 strict mode
+    }
+ });
+ Ext.reg('datemenu', Ext.menu.DateMenu);
\ No newline at end of file