Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / DatePicker.html
index 6bf30a8..2625854 100644 (file)
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
 </head>
 <body onload="prettyPrint(); highlight();">
   <pre class="prettyprint lang-js"><span id='Ext-menu-DatePicker'>/**
 </head>
 <body onload="prettyPrint(); highlight();">
   <pre class="prettyprint lang-js"><span id='Ext-menu-DatePicker'>/**
-</span> * @class Ext.menu.DatePicker
- * @extends Ext.menu.Menu
- * &lt;p&gt;A menu containing an {@link Ext.picker.Date} Component.&lt;/p&gt;
- * &lt;p&gt;Notes:&lt;/p&gt;&lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
- * &lt;li&gt;Although not listed here, the &lt;b&gt;constructor&lt;/b&gt; for this class
- * accepts all of the configuration options of &lt;b&gt;{@link Ext.picker.Date}&lt;/b&gt;.&lt;/li&gt;
- * &lt;li&gt;If subclassing DateMenu, any configuration options for the DatePicker must be
- * applied to the &lt;tt&gt;&lt;b&gt;initialConfig&lt;/b&gt;&lt;/tt&gt; property of the DateMenu.
- * Applying {@link Ext.picker.Date DatePicker} configuration settings to
- * &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;
- * &lt;/ul&gt;&lt;/div&gt;
- * {@img Ext.menu.DatePicker/Ext.menu.DatePicker.png Ext.menu.DatePicker component}
- * __Example Usage__
-     var dateMenu = Ext.create('Ext.menu.DatePicker', {
-        handler: function(dp, date){
-            Ext.Msg.alert('Date Selected', 'You choose {0}.', Ext.Date.format(date, 'M j, Y'));
-
-        }
-    });
-
-    Ext.create('Ext.menu.Menu', {
-               width: 100,
-               height: 90,
-               floating: false,  // usually you want this set to True (default)
-               renderTo: Ext.getBody(),  // usually rendered by it's containing component
-               items: [{
-                   text: 'choose a date',
-                   menu: dateMenu
-               },{
-            iconCls: 'add16',
-                   text: 'icon item'
-               },{
-                   text: 'regular item'
-               }]
-       });
-
- * @xtype datemenu
- * @author Nicolas Ferrero
+</span> * A menu containing an Ext.picker.Date Component.
+ *
+ * Notes:
+ *
+ * - Although not listed here, the **constructor** for this class accepts all of the
+ *   configuration options of **{@link Ext.picker.Date}**.
+ * - If subclassing DateMenu, any configuration options for the DatePicker must be applied
+ *   to the **initialConfig** property of the DateMenu. Applying {@link Ext.picker.Date Date Picker}
+ *   configuration settings to **this** will **not** affect the Date Picker's configuration.
+ *
+ * Example:
+ *
+ *     @example
+ *     var dateMenu = Ext.create('Ext.menu.DatePicker', {
+ *         handler: function(dp, date){
+ *             Ext.Msg.alert('Date Selected', 'You selected ' + Ext.Date.format(date, 'M j, Y'));
+ *         }
+ *     });
+ *
+ *     Ext.create('Ext.menu.Menu', {
+ *         width: 100,
+ *         height: 90,
+ *         floating: false,  // usually you want this set to True (default)
+ *         renderTo: Ext.getBody(),  // usually rendered by it's containing component
+ *         items: [{
+ *             text: 'choose a date',
+ *             menu: dateMenu
+ *         },{
+ *             iconCls: 'add16',
+ *             text: 'icon item'
+ *         },{
+ *             text: 'regular item'
+ *         }]
+ *     });
  */
  Ext.define('Ext.menu.DatePicker', {
      extend: 'Ext.menu.Menu',
  */
  Ext.define('Ext.menu.DatePicker', {
      extend: 'Ext.menu.Menu',
 
 <span id='Ext-menu-DatePicker-cfg-hideOnClick'>    /**
 </span>     * @cfg {Boolean} hideOnClick
 
 <span id='Ext-menu-DatePicker-cfg-hideOnClick'>    /**
 </span>     * @cfg {Boolean} hideOnClick
-     * False to continue showing the menu after a date is selected, defaults to true.
+     * False to continue showing the menu after a date is selected.
      */
     hideOnClick : true,
 
 <span id='Ext-menu-DatePicker-cfg-pickerId'>    /**
 </span>     * @cfg {String} pickerId
      */
     hideOnClick : true,
 
 <span id='Ext-menu-DatePicker-cfg-pickerId'>    /**
 </span>     * @cfg {String} pickerId
-     * An id to assign to the underlying date picker. Defaults to &lt;tt&gt;null&lt;/tt&gt;.
+     * An id to assign to the underlying date picker.
      */
     pickerId : null,
 
      */
     pickerId : null,
 
@@ -82,9 +78,8 @@
      */
 
 <span id='Ext-menu-DatePicker-property-picker'>    /**
      */
 
 <span id='Ext-menu-DatePicker-property-picker'>    /**
-</span>     * The {@link Ext.picker.Date} instance for this DateMenu
-     * @property picker
-     * @type Ext.picker.Date
+</span>     * @property {Ext.picker.Date} picker
+     * The {@link Ext.picker.Date} instance for this DateMenu
      */
 
 <span id='Ext-menu-DatePicker-event-click'>    /**
      */
 
 <span id='Ext-menu-DatePicker-event-click'>    /**
         Ext.apply(me, {
             showSeparator: false,
             plain: true,
         Ext.apply(me, {
             showSeparator: false,
             plain: true,
+            border: false,
+            bodyPadding: 0, // remove the body padding from the datepicker menu item so it looks like 3.3
             items: Ext.applyIf({
                 cls: Ext.baseCSSPrefix + 'menu-date-item',
                 id: me.pickerId,
             items: Ext.applyIf({
                 cls: Ext.baseCSSPrefix + 'menu-date-item',
                 id: me.pickerId,
         me.picker = me.down('datepicker');
 <span id='Ext-menu-DatePicker-event-select'>        /**
 </span>         * @event select
         me.picker = me.down('datepicker');
 <span id='Ext-menu-DatePicker-event-select'>        /**
 </span>         * @event select
-         * Fires when a date is selected from the {@link #picker Ext.picker.Date}
-         * @param {Ext.picker.Date} picker The {@link #picker Ext.picker.Date}
-         * @param {Date} date The selected date
+         * @alias Ext.picker.Date#select
          */
         me.relayEvents(me.picker, ['select']);
 
          */
         me.relayEvents(me.picker, ['select']);