Upgrade to ExtJS 4.0.0 - Released 04/26/2011

[extjs.git] / src / grid / column / Date.js

diff --git a/src/grid/column/Date.js b/src/grid/column/Date.js
new file mode 100644 (file)
index 0000000..a4793c2
--- /dev/null
+++ b/src/grid/column/Date.js
@@ -0,0 +1,62 @@
+/**
+ * @class Ext.grid.column.Date
+ * @extends Ext.grid.column.Column
+ * <p>A Column definition class which renders a passed date according to the default locale, or a configured
+ * {@link #format}.</p>
+ *
+ * {@img Ext.grid.column.Date/Ext.grid.column.Date.png Ext.grid.column.Date grid column}
+ *
+ * ## Code
+ *    Ext.create('Ext.data.Store', {
+ *        storeId:'sampleStore',
+ *        fields:[
+ *            {name: 'symbol', type: 'string'},
+ *            {name: 'date', type: 'date'},
+ *            {name: 'change', type: 'number'},
+ *            {name: 'volume', type: 'number'},
+ *            {name: 'topday', type: 'date'}                        
+ *        ],
+ *        data:[
+ *            {symbol:"msft", date:'2011/04/22', change:2.43, volume:61606325, topday:'04/01/2010'},
+ *            {symbol:"goog", date:'2011/04/22', change:0.81, volume:3053782, topday:'04/11/2010'},
+ *            {symbol:"apple", date:'2011/04/22', change:1.35, volume:24484858, topday:'04/28/2010'},            
+ *            {symbol:"sencha", date:'2011/04/22', change:8.85, volume:5556351, topday:'04/22/2010'}            
+ *        ]
+ *    });
+ *    
+ *    Ext.create('Ext.grid.Panel', {
+ *        title: 'Date Column Demo',
+ *        store: Ext.data.StoreManager.lookup('sampleStore'),
+ *        columns: [
+ *            {text: 'Symbol',  dataIndex: 'symbol', flex: 1},
+ *            {text: 'Date',  dataIndex: 'date', xtype: 'datecolumn', format:'Y-m-d'},
+ *            {text: 'Change',  dataIndex: 'change', xtype: 'numbercolumn', format:'0.00'},
+ *            {text: 'Volume',  dataIndex: 'volume', xtype: 'numbercolumn', format:'0,000'},
+ *            {text: 'Top Day',  dataIndex: 'topday', xtype: 'datecolumn', format:'l'}            
+ *        ],
+ *        height: 200,
+ *        width: 450,
+ *        renderTo: Ext.getBody()
+ *    });
+ *    
+ * @xtype datecolumn
+ */
+Ext.define('Ext.grid.column.Date', {
+    extend: 'Ext.grid.column.Column',
+    alias: ['widget.datecolumn'],
+    requires: ['Ext.Date'],
+    alternateClassName: 'Ext.grid.DateColumn',
+
+    /**
+     * @cfg {String} format
+     * A formatting string as used by {@link Date#format Date.format} to format a Date for this Column.
+     * This defaults to the default date from {@link Ext.Date#defaultFormat} which itself my be overridden
+     * in a locale file.
+     */
+    format : Ext.Date.defaultFormat,
+
+    constructor: function(cfg){
+        this.callParent(arguments);
+        this.renderer = Ext.util.Format.dateRenderer(this.format);
+    }
+});
\ No newline at end of file