Upgrade to ExtJS 4.0.7 - Released 10/19/2011

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

diff --git a/src/grid/column/Boolean.js b/src/grid/column/Boolean.js
index 728e7ef..e9285f4 100644 (file)
--- a/src/grid/column/Boolean.js
+++ b/src/grid/column/Boolean.js
@@ -1,12 +1,22 @@
+/*
+
+This file is part of Ext JS 4
+
+Copyright (c) 2011 Sencha Inc
+
+Contact:  http://www.sencha.com/contact
+
+GNU General Public License Usage
+This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.  Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
+
+If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
+
+*/
 /**
- * @class Ext.grid.column.Boolean
- * @extends Ext.grid.column.Column
- * <p>A Column definition class which renders boolean data fields.  See the {@link Ext.grid.column.Column#xtype xtype}
- * config option of {@link Ext.grid.column.Column} for more details.</p>
+ * A Column definition class which renders boolean data fields.  See the {@link Ext.grid.column.Column#xtype xtype}
+ * config option of {@link Ext.grid.column.Column} for more details.
  *
- * {@img Ext.grid.column.Boolean/Ext.grid.column.Boolean.png Ext.grid.column.Boolean grid column}
- *
- *  ## Code
+ *     @example
  *     Ext.create('Ext.data.Store', {
  *        storeId:'sampleStore',
  *        fields:[
@@ -14,10 +24,10 @@
  *            {name: 'rocks', type: 'boolean'}
  *        ],
  *        data:{'items':[
- *            {"framework":"Ext JS 4", "rocks":true},
- *            {"framework":"Sencha Touch", "rocks":true},
- *            {"framework":"Ext GWT", "rocks":true},            
- *            {"framework":"Other Guys", "rocks":false}            
+ *            { 'framework': "Ext JS 4",     'rocks': true  },
+ *            { 'framework': "Sencha Touch", 'rocks': true  },
+ *            { 'framework': "Ext GWT",      'rocks': true  }, 
+ *            { 'framework': "Other Guys",   'rocks': false } 
  *        ]},
  *        proxy: {
  *            type: 'memory',
@@ -26,26 +36,25 @@
  *                root: 'items'
  *            }
  *        }
- *    });
- *    
- *    Ext.create('Ext.grid.Panel', {
- *        title: 'Boolean Column Demo',
- *        store: Ext.data.StoreManager.lookup('sampleStore'),
- *        columns: [
- *            {text: 'Framework',  dataIndex: 'framework', flex: 1},
- *            {
- *                xtype: 'booleancolumn', 
- *                text: 'Rocks',
- *                trueText: 'Yes',
- *                falseText: 'No', 
- *                dataIndex: 'rocks'}
- *        ],
- *        height: 200,
- *        width: 400,
- *        renderTo: Ext.getBody()
- *    });
- * 
- * @xtype booleancolumn
+ *     });
+ *     
+ *     Ext.create('Ext.grid.Panel', {
+ *         title: 'Boolean Column Demo',
+ *         store: Ext.data.StoreManager.lookup('sampleStore'),
+ *         columns: [
+ *             { text: 'Framework',  dataIndex: 'framework', flex: 1 },
+ *             {
+ *                 xtype: 'booleancolumn', 
+ *                 text: 'Rocks',
+ *                 trueText: 'Yes',
+ *                 falseText: 'No', 
+ *                 dataIndex: 'rocks'
+ *             }
+ *         ],
+ *         height: 200,
+ *         width: 400,
+ *         renderTo: Ext.getBody()
+ *     });
  */
 Ext.define('Ext.grid.column.Boolean', {
     extend: 'Ext.grid.column.Column',
@@ -54,20 +63,19 @@ Ext.define('Ext.grid.column.Boolean', {
 
     /**
      * @cfg {String} trueText
-     * The string returned by the renderer when the column value is not falsey (defaults to <tt>'true'</tt>).
+     * The string returned by the renderer when the column value is not falsey.
      */
     trueText: 'true',
 
     /**
      * @cfg {String} falseText
-     * The string returned by the renderer when the column value is falsey (but not undefined) (defaults to
-     * <tt>'false'</tt>).
+     * The string returned by the renderer when the column value is falsey (but not undefined).
      */
     falseText: 'false',
 
     /**
      * @cfg {String} undefinedText
-     * The string returned by the renderer when the column value is undefined (defaults to <tt>'&#160;'</tt>).
+     * The string returned by the renderer when the column value is undefined.
      */
     undefinedText: '&#160;',
 
@@ -87,4 +95,4 @@ Ext.define('Ext.grid.column.Boolean', {
             return trueText;
         };
     }
-});
\ No newline at end of file
+});