Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Time2.html
index c12966e..fcb11d8 100644 (file)
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-picker.Time-method-constructor'><span id='Ext-picker.Time'>/**
-</span></span> * @class Ext.picker.Time
- * @extends Ext.view.BoundList
- * &lt;p&gt;A time picker which provides a list of times from which to choose. This is used by the
- * {@link Ext.form.field.Time} class to allow browsing and selection of valid times, but could also be used
- * with other components.&lt;/p&gt;
- * &lt;p&gt;By default, all times starting at midnight and incrementing every 15 minutes will be presented.
- * This list of available times can be controlled using the {@link #minValue}, {@link #maxValue}, and
- * {@link #increment} configuration properties. The format of the times presented in the list can be
- * customized with the {@link #format} config.&lt;/p&gt;
- * &lt;p&gt;To handle when the user selects a time from the list, you can subscribe to the {@link #selectionchange}
- * event.&lt;/p&gt;
- *
- * {@img Ext.picker.Time/Ext.picker.Time.png Ext.picker.Time component}
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <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>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-picker-Time'>/**
+</span> * A time picker which provides a list of times from which to choose. This is used by the Ext.form.field.Time
+ * class to allow browsing and selection of valid times, but could also be used with other components.
  *
- * ## Code
-     new Ext.create('Ext.picker.Time', {
-        width: 60,
-        minValue: Ext.Date.parse('04:30:00 AM', 'h:i:s A'),
-        maxValue: Ext.Date.parse('08:00:00 AM', 'h:i:s A'),
-        renderTo: Ext.getBody()
-    });
+ * By default, all times starting at midnight and incrementing every 15 minutes will be presented. This list of
+ * available times can be controlled using the {@link #minValue}, {@link #maxValue}, and {@link #increment}
+ * configuration properties. The format of the times presented in the list can be customized with the {@link #format}
+ * config.
  *
- * @constructor
- * Create a new TimePicker
- * @param {Object} config The config object
+ * To handle when the user selects a time from the list, you can subscribe to the {@link #selectionchange} event.
  *
- * @xtype timepicker
+ *     @example
+ *     Ext.create('Ext.picker.Time', {
+ *        width: 60,
+ *        minValue: Ext.Date.parse('04:30:00 AM', 'h:i:s A'),
+ *        maxValue: Ext.Date.parse('08:00:00 AM', 'h:i:s A'),
+ *        renderTo: Ext.getBody()
+ *     });
  */
 Ext.define('Ext.picker.Time', {
     extend: 'Ext.view.BoundList',
     alias: 'widget.timepicker',
     requires: ['Ext.data.Store', 'Ext.Date'],
 
-<span id='Ext-picker.Time-cfg-minValue'>    /**
+<span id='Ext-picker-Time-cfg-minValue'>    /**
 </span>     * @cfg {Date} minValue
-     * The minimum time to be shown in the list of times. This must be a Date object (only the time fields
-     * will be used); no parsing of String values will be done. Defaults to undefined.
+     * The minimum time to be shown in the list of times. This must be a Date object (only the time fields will be
+     * used); no parsing of String values will be done.
      */
 
-<span id='Ext-picker.Time-cfg-maxValue'>    /**
+<span id='Ext-picker-Time-cfg-maxValue'>    /**
 </span>     * @cfg {Date} maxValue
-     * The maximum time to be shown in the list of times. This must be a Date object (only the time fields
-     * will be used); no parsing of String values will be done. Defaults to undefined.
+     * The maximum time to be shown in the list of times. This must be a Date object (only the time fields will be
+     * used); no parsing of String values will be done.
      */
 
-<span id='Ext-picker.Time-cfg-increment'>    /**
+<span id='Ext-picker-Time-cfg-increment'>    /**
 </span>     * @cfg {Number} increment
-     * The number of minutes between each time value in the list (defaults to 15).
+     * The number of minutes between each time value in the list.
      */
     increment: 15,
 
-<span id='Ext-picker.Time-cfg-format'>    /**
+<span id='Ext-picker-Time-cfg-format'>    /**
 </span>     * @cfg {String} format
-     * The default time format string which can be overriden for localization support. The format must be
-     * valid according to {@link Ext.Date#parse} (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
-     * format try 'H:i' instead.
+     * The default time format string which can be overriden for localization support. The format must be valid
+     * according to {@link Ext.Date#parse} (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time format try 'H:i'
+     * instead.
      */
     format : &quot;g:i A&quot;,
 
-<span id='Ext-picker.Time-property-displayField'>    /**
+<span id='Ext-picker-Time-property-displayField'>    /**
 </span>     * @hide
      * The field in the implicitly-generated Model objects that gets displayed in the list. This is
      * an internal field name only and is not useful to change via config.
      */
     displayField: 'disp',
 
-<span id='Ext-picker.Time-property-initDate'>    /**
+<span id='Ext-picker-Time-property-initDate'>    /**
 </span>     * @private
      * Year, month, and day that all times will be normalized into internally.
      */
-    initDate: [2008,1,1],
+    initDate: [2008,0,1],
 
     componentCls: Ext.baseCSSPrefix + 'timepicker',
 
-<span id='Ext-picker.Time-property-loadingText'>    /**
+<span id='Ext-picker-Time-property-loadMask'>    /**
 </span>     * @hide
      */
-    loadingText: '',
+    loadMask: false,
 
     initComponent: function() {
         var me = this,
             dateUtil = Ext.Date,
             clearTime = dateUtil.clearTime,
-            initDate = me.initDate.join('/');
+            initDate = me.initDate;
 
         // Set up absolute min and max for the entire day
-        me.absMin = clearTime(new Date(initDate));
-        me.absMax = dateUtil.add(clearTime(new Date(initDate)), 'mi', (24 * 60) - 1);
+        me.absMin = clearTime(new Date(initDate[0], initDate[1], initDate[2]));
+        me.absMax = dateUtil.add(clearTime(new Date(initDate[0], initDate[1], initDate[2])), 'mi', (24 * 60) - 1);
 
         me.store = me.createStore();
         me.updateList();
 
-        this.callParent();
+        me.callParent();
     },
 
-<span id='Ext-picker.Time-method-setMinValue'>    /**
-</span>     * Set the {@link #minValue} and update the list of available times. This must be a Date
-     * object (only the time fields will be used); no parsing of String values will be done.
+<span id='Ext-picker-Time-method-setMinValue'>    /**
+</span>     * Set the {@link #minValue} and update the list of available times. This must be a Date object (only the time
+     * fields will be used); no parsing of String values will be done.
      * @param {Date} value
      */
     setMinValue: function(value) {
@@ -104,9 +111,9 @@ Ext.define('Ext.picker.Time', {
         this.updateList();
     },
 
-<span id='Ext-picker.Time-method-setMaxValue'>    /**
-</span>     * Set the {@link #maxValue} and update the list of available times. This must be a Date
-     * object (only the time fields will be used); no parsing of String values will be done.
+<span id='Ext-picker-Time-method-setMaxValue'>    /**
+</span>     * Set the {@link #maxValue} and update the list of available times. This must be a Date object (only the time
+     * fields will be used); no parsing of String values will be done.
      * @param {Date} value
      */
     setMaxValue: function(value) {
@@ -114,7 +121,7 @@ Ext.define('Ext.picker.Time', {
         this.updateList();
     },
 
-<span id='Ext-picker.Time-method-normalizeDate'>    /**
+<span id='Ext-picker-Time-method-normalizeDate'>    /**
 </span>     * @private
      * Sets the year/month/day of the given Date object to the {@link #initDate}, so that only
      * the time fields are significant. This makes values suitable for time comparison.
@@ -122,13 +129,13 @@ Ext.define('Ext.picker.Time', {
      */
     normalizeDate: function(date) {
         var initDate = this.initDate;
-        date.setFullYear(initDate[0], initDate[1] - 1, initDate[2]);
+        date.setFullYear(initDate[0], initDate[1], initDate[2]);
         return date;
     },
 
-<span id='Ext-picker.Time-method-updateList'>    /**
-</span>     * Update the list of available times in the list to be constrained within the
-     * {@link #minValue} and {@link #maxValue}.
+<span id='Ext-picker-Time-method-updateList'>    /**
+</span>     * Update the list of available times in the list to be constrained within the {@link #minValue}
+     * and {@link #maxValue}.
      */
     updateList: function() {
         var me = this,
@@ -141,7 +148,7 @@ Ext.define('Ext.picker.Time', {
         });
     },
 
-<span id='Ext-picker.Time-method-createStore'>    /**
+<span id='Ext-picker-Time-method-createStore'>    /**
 </span>     * @private
      * Creates the internal {@link Ext.data.Store} that contains the available times. The store
      * is loaded with all possible times, and it is later filtered to hide those times outside
@@ -169,4 +176,6 @@ Ext.define('Ext.picker.Time', {
     }
 
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>