-<div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.grid.Column.html" ext:member="" ext:cls="Ext.grid.Column">Column</a> <img src="resources/elbow-end.gif">BooleanColumn</pre></div><h1>Class <a href="source/Column.html#cls-Ext.grid.BooleanColumn">Ext.grid.BooleanColumn</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Column.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Column.html#cls-Ext.grid.BooleanColumn">BooleanColumn</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column" ext:member="">Column</a></td></tr></table><div class="description"><p>A Column definition class which renders boolean data fields. See the <a href="output/Ext.grid.Column.html#Ext.grid.Column-xtype" ext:member="xtype" ext:cls="Ext.grid.Column">xtype</a>\r
-config option of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> for more details.</p></div><div class="hr"></div><a id="Ext.grid.BooleanColumn-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-align"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-align">align</a></b> : String<div class="mdesc">Optional. Set the CSS text-align property of the column. Defaults to undefined.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#align" ext:member="#align" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-css"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-css">css</a></b> : String<div class="mdesc"><div class="short">Optional. An inline style definition string which is applied to all table cells in the column
-(excluding headers). D...</div><div class="long">Optional. An inline style definition string which is applied to all table cells in the column\r
-(excluding headers). Defaults to undefined.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#css" ext:member="#css" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-dataIndex"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-dataIndex">dataIndex</a></b> : String<div class="mdesc"><div class="short">Required. The name of the field in the
-grid's Ext.data.Store's Ext.data.Record definition from
-which to draw the co...</div><div class="long"><p><b>Required</b>. The name of the field in the\r
-grid's <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a>'s <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> definition from\r
-which to draw the column's value.</p></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#dataIndex" ext:member="#dataIndex" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-editable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-editable">editable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. Defaults to true, enabling the configured
-editor. Set to false to initially disable editing on this colum...</div><div class="long">Optional. Defaults to <tt>true</tt>, enabling the configured\r
-<tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-editor" ext:member="editor" ext:cls="Ext.grid.Column">editor</a></tt>. Set to <tt>false</tt> to initially disable editing on this column.\r
-The initial configuration may be dynamically altered using\r
-<a href="output/Ext.grid.ColumnModel.html" ext:cls="Ext.grid.ColumnModel">Ext.grid.ColumnModel</a>.<a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-setEditable" ext:member="setEditable" ext:cls="Ext.grid.ColumnModel">setEditable()</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#editable" ext:member="#editable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-editor"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-editor">editor</a></b> : Ext.form.Field<div class="mdesc"><div class="short">Optional. The Ext.form.Field to use when editing values in this column
-if editing is supported by the grid. See edit...</div><div class="long">Optional. The <a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field">Ext.form.Field</a> to use when editing values in this column\r
-if editing is supported by the grid. See <tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-editable" ext:member="editable" ext:cls="Ext.grid.Column">editable</a></tt> also.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#editor" ext:member="#editor" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-emptyGroupText"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-emptyGroupText">emptyGroupText</a></b> : String<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
-may be used to specify the text to ...</div><div class="long">Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option\r
-may be used to specify the text to display when there is an empty group value. Defaults to the\r
-<a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>.<a href="output/Ext.grid.GroupingView.html#Ext.grid.GroupingView-emptyGroupText" ext:member="emptyGroupText" ext:cls="Ext.grid.GroupingView">emptyGroupText</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#emptyGroupText" ext:member="#emptyGroupText" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.BooleanColumn-falseText"></a><b><a href="source/Column.html#cfg-Ext.grid.BooleanColumn-falseText">falseText</a></b> : String<div class="mdesc">The string returned by the renderer when the column value is falsey (but not undefined) (defaults to\r
-<tt>'false'</tt>).</div></td><td class="msource">BooleanColumn</td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-fixed"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-fixed">fixed</a></b> : Boolean<div class="mdesc">Optional. <tt>true</tt> if the column width cannot be changed. Defaults to <tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#fixed" ext:member="#fixed" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-groupName"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-groupName">groupName</a></b> : String<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
-may be used to specify the text wit...</div><div class="long">Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option\r
-may be used to specify the text with which to prefix the group field value in the group header line.\r
-See also <a href="output/Ext.grid.Column.html#Ext.grid.Column-groupRenderer" ext:member="groupRenderer" ext:cls="Ext.grid.Column">groupRenderer</a> and\r
-<a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>.<a href="output/Ext.grid.GroupingView.html#Ext.grid.GroupingView-showGroupName" ext:member="showGroupName" ext:cls="Ext.grid.GroupingView">showGroupName</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#groupName" ext:member="#groupName" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-groupRenderer"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-groupRenderer">groupRenderer</a></b> : Function<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
-may be used to specify the function...</div><div class="long"><p>Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option\r
-may be used to specify the function used to format the grouping field value for display in the group\r
-<a href="output/Ext.grid.Column.html#Ext.grid.Column-groupName" ext:member="groupName" ext:cls="Ext.grid.Column">header</a>. If a <tt><b>groupRenderer</b></tt> is not specified, the configured\r
-<tt><b><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></b></tt> will be called; if a <tt><b><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></b></tt> is also not specified\r
-the new value of the group field will be used.</p>\r
-<p>The called function (either the <tt><b>groupRenderer</b></tt> or <tt><b><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></b></tt>) will be\r
-passed the following parameters:\r
-<div class="mdetail-params"><ul>\r
-<li><b>v</b> : Object<p class="sub-desc">The new value of the group field.</p></li>\r
-<li><b>unused</b> : undefined<p class="sub-desc">Unused parameter.</p></li>\r
-<li><b>r</b> : Ext.data.Record<p class="sub-desc">The Record providing the data\r
-for the row which caused group change.</p></li>\r
-<li><b>rowIndex</b> : Number<p class="sub-desc">The row index of the Record which caused group change.</p></li>\r
-<li><b>colIndex</b> : Number<p class="sub-desc">The column index of the group field.</p></li>\r
-<li><b>ds</b> : Ext.data.Store<p class="sub-desc">The Store which is providing the data Model.</p></li>\r
-</ul></div></p>\r
-<p>The function should return a string value.</p></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#groupRenderer" ext:member="#groupRenderer" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-groupable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-groupable">groupable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
-may be used to disable the header m...</div><div class="long">Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option\r
-may be used to disable the header menu item to group by the column selected. Defaults to <tt>true</tt>,\r
-which enables the header menu group option. Set to <tt>false</tt> to disable (but still show) the\r
-group option in the header menu for the column. See also <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-groupName" ext:member="groupName" ext:cls="Ext.grid.Column">groupName</a></code>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#groupable" ext:member="#groupable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-header"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-header">header</a></b> : String<div class="mdesc"><div class="short">Optional. The header text to be used as innerHTML
-(html tags are accepted) to display in the Grid view. Note: to
-h...</div><div class="long">Optional. The header text to be used as innerHTML\r
-(html tags are accepted) to display in the Grid view. <b>Note</b>: to\r
-have a clickable header with no text displayed use <tt>' '</tt>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#header" ext:member="#header" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-hidden"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hidden">hidden</a></b> : Boolean<div class="mdesc"><div class="short">Optional. true to initially hide this column. Defaults to false.
-A hidden column may be shown via the header row men...</div><div class="long">Optional. <tt>true</tt> to initially hide this column. Defaults to <tt>false</tt>.\r
-A hidden column <a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-enableColumnHide" ext:member="enableColumnHide" ext:cls="Ext.grid.GridPanel">may be shown via the header row menu</a>.\r
-If a column is never to be shown, simply do not include this column in the Column Model at all.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#hidden" ext:member="#hidden" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-hideable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hideable">hideable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. Specify as false to prevent the user from hiding this column
-(defaults to true). To disallow column hidin...</div><div class="long">Optional. Specify as <tt>false</tt> to prevent the user from hiding this column\r
-(defaults to true). To disallow column hiding globally for all columns in the grid, use\r
-<a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-enableColumnHide" ext:member="enableColumnHide" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel.enableColumnHide</a> instead.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#hideable" ext:member="#hideable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-id"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-id">id</a></b> : String<div class="mdesc"><div class="short">Optional. A name which identifies this column (defaults to the column's initial
-ordinal position.) The id is used to...</div><div class="long">Optional. A name which identifies this column (defaults to the column's initial\r
-ordinal position.) The <tt>id</tt> is used to create a CSS <b>class</b> name which is applied to all\r
-table cells (including headers) in that column (in this context the <tt>id</tt> does not need to be\r
-unique). The class name takes the form of <pre>x-grid3-td-<b>id</b></pre>\r
-Header cells will also receive this class name, but will also have the class <pre>x-grid3-hd</pre>\r
-So, to target header cells, use CSS selectors such as:<pre>.x-grid3-hd-row .x-grid3-td-<b>id</b></pre>\r
-The <a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-autoExpandColumn" ext:member="autoExpandColumn" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel.autoExpandColumn</a> grid config option references the column via this\r
-unique identifier.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#id" ext:member="#id" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-menuDisabled"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-menuDisabled">menuDisabled</a></b> : Boolean<div class="mdesc">Optional. <tt>true</tt> to disable the column menu. Defaults to <tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#menuDisabled" ext:member="#menuDisabled" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-renderer"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-renderer">renderer</a></b> : Mixed<div class="mdesc"><div class="short">For an alternative to specifying a renderer see xtype
-Optional. A renderer is an 'interceptor' method which can be u...</div><div class="long"><p>For an alternative to specifying a renderer see <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-xtype" ext:member="xtype" ext:cls="Ext.grid.Column">xtype</a></code></p>\r
-<p>Optional. A renderer is an 'interceptor' method which can be used transform data (value,\r
-appearance, etc.) before it is rendered). This may be specified in either of three ways:\r
-<div class="mdetail-params"><ul>\r
-<li>A renderer function used to return HTML markup for a cell given the cell's data value.</li>\r
-<li>A string which references a property name of the <a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">Ext.util.Format</a> class which\r
-provides a renderer function.</li>\r
-<li>An object specifying both the renderer function, and its execution scope (<tt><b>this</b></tt>\r
-reference) e.g.:<pre style="margin-left:1.2em"><code>{\r
- fn: this.gridRenderer,\r
- scope: this\r
-}</code></pre></li></ul></div>\r
-If not specified, the default renderer uses the raw data value.</p>\r
-<p>For information about the renderer function (passed parameters, etc.), see\r
-<a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-setRenderer" ext:member="setRenderer" ext:cls="Ext.grid.ColumnModel">Ext.grid.ColumnModel.setRenderer</a>. An example of specifying renderer function inline:</p><pre><code><b>var</b> companyColumn = {\r
- header: <em>'Company Name'</em>,\r
- dataIndex: <em>'company'</em>,\r
- renderer: <b>function</b>(value, metaData, record, rowIndex, colIndex, store) {\r
- <i>// provide the logic depending on business rules\r</i>
- <i>// name of your own choosing to manipulate the cell depending upon\r</i>
- <i>// the data <b>in</b> the underlying Record object.\r</i>
- <b>if</b> (value == <em>'whatever'</em>) {\r
- <i>//metaData.css : String : A CSS class name to add to the TD element of the cell.\r</i>
- <i>//metaData.attr : String : An html attribute definition string to apply to\r</i>
- <i>// the data container element within the table\r</i>
- <i>// cell (e.g. <em>'style=<em>"color:red;"</em>'</em>).\r</i>
- metaData.css = <em>'name-of-css-class-you-will-define'</em>;\r
- }\r
- <b>return</b> value;\r
- }\r
-}</code></pre>\r
-See also <a href="output/Ext.grid.Column.html#Ext.grid.Column-scope" ext:member="scope" ext:cls="Ext.grid.Column">scope</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#renderer" ext:member="#renderer" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-resizable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-resizable">resizable</a></b> : Boolean<div class="mdesc">Optional. <tt>false</tt> to disable column resizing. Defaults to <tt>true</tt>.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#resizable" ext:member="#resizable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-scope"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-scope">scope</a></b> : Object<div class="mdesc">Optional. The scope (<tt><b>this</b></tt> reference) in which to execute the\r
-renderer. Defaults to the Column configuration object.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#scope" ext:member="#scope" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-sortable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-sortable">sortable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. true if sorting is to be allowed on this column.
-Defaults to the value of the Ext.grid.ColumnModel.default...</div><div class="long">Optional. <tt>true</tt> if sorting is to be allowed on this column.\r
-Defaults to the value of the <code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaultSortable" ext:member="defaultSortable" ext:cls="Ext.grid.ColumnModel">Ext.grid.ColumnModel.defaultSortable</a></code> property.\r
-Whether local/remote sorting is used is specified in <code><a href="output/Ext.data.Store.html#Ext.data.Store-remoteSort" ext:member="remoteSort" ext:cls="Ext.data.Store">Ext.data.Store.remoteSort</a></code>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#sortable" ext:member="#sortable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-tooltip"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-tooltip">tooltip</a></b> : String<div class="mdesc"><div class="short">Optional. A text string to use as the column header's tooltip. If Quicktips
-are enabled, this value will be used as...</div><div class="long">Optional. A text string to use as the column header's tooltip. If Quicktips\r
-are enabled, this value will be used as the text of the quick tip, otherwise it will be set as the\r
-header's HTML title attribute. Defaults to ''.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#tooltip" ext:member="#tooltip" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.BooleanColumn-trueText"></a><b><a href="source/Column.html#cfg-Ext.grid.BooleanColumn-trueText">trueText</a></b> : String<div class="mdesc">The string returned by the renderer when the column value is not falsey (defaults to <tt>'true'</tt>).</div></td><td class="msource">BooleanColumn</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.BooleanColumn-undefinedText"></a><b><a href="source/Column.html#cfg-Ext.grid.BooleanColumn-undefinedText">undefinedText</a></b> : String<div class="mdesc">The string returned by the renderer when the column value is undefined (defaults to <tt>' '</tt>).</div></td><td class="msource">BooleanColumn</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-width"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-width">width</a></b> : Number<div class="mdesc"><div class="short">Optional. The initial width in pixels of the column.
-The width of each column can also be affected if any of the fol...</div><div class="long">Optional. The initial width in pixels of the column.\r
-The width of each column can also be affected if any of the following are configured:\r
-<div class="mdetail-params"><ul>\r
-<li><a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel</a>.<tt><a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-autoExpandColumn" ext:member="autoExpandColumn" ext:cls="Ext.grid.GridPanel">autoExpandColumn</a></tt></li>\r
-<li><a href="output/Ext.grid.GridView.html" ext:cls="Ext.grid.GridView">Ext.grid.GridView</a>.<tt><a href="output/Ext.grid.GridView.html#Ext.grid.GridView-forceFit" ext:member="forceFit" ext:cls="Ext.grid.GridView">forceFit</a></tt>\r
-<div class="sub-desc">\r
-<p>By specifying <tt>forceFit:true</tt>, <a href="output/Ext.grid.Column.html#Ext.grid.Column-fixed" ext:member="fixed" ext:cls="Ext.grid.Column">non-fixed width</a> columns will be\r
-re-proportioned (based on the relative initial widths) to fill the width of the grid so\r
-that no horizontal scrollbar is shown.</p>\r
-</div></li>\r
-<li><a href="output/Ext.grid.GridView.html" ext:cls="Ext.grid.GridView">Ext.grid.GridView</a>.<tt><a href="output/Ext.grid.GridView.html#Ext.grid.GridView-autoFill" ext:member="autoFill" ext:cls="Ext.grid.GridView">autoFill</a></tt></li>\r
-<li><a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel</a>.<tt><a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-minColumnWidth" ext:member="minColumnWidth" ext:cls="Ext.grid.GridPanel">minColumnWidth</a></tt></li>\r
-<br><p><b>Note</b>: when the width of each column is determined, a space on the right side\r
-is reserved for the vertical scrollbar. The\r
-<a href="output/Ext.grid.GridView.html" ext:cls="Ext.grid.GridView">Ext.grid.GridView</a>.<tt><a href="output/Ext.grid.GridView.html#Ext.grid.GridView-scrollOffset" ext:member="scrollOffset" ext:cls="Ext.grid.GridView">scrollOffset</a></tt>\r
-can be modified to reduce or eliminate the reserved offset.</p></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#width" ext:member="#width" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-xtype"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-xtype">xtype</a></b> : String<div class="mdesc"><div class="short">Optional. A String which references a predefined Ext.grid.Column subclass
-type which is preconfigured with an approp...</div><div class="long">Optional. A String which references a predefined <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> subclass\r
-type which is preconfigured with an appropriate <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></code> to be easily\r
-configured into a ColumnModel. The predefined <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> subclass types are:\r
-<div class="mdetail-params"><ul>\r
-<li><b><tt>gridcolumn</tt></b> : <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> (<b>Default</b>)<p class="sub-desc"></p></li>\r
-<li><b><tt>booleancolumn</tt></b> : <a href="output/Ext.grid.BooleanColumn.html" ext:cls="Ext.grid.BooleanColumn">Ext.grid.BooleanColumn</a><p class="sub-desc"></p></li>\r
-<li><b><tt>numbercolumn</tt></b> : <a href="output/Ext.grid.NumberColumn.html" ext:cls="Ext.grid.NumberColumn">Ext.grid.NumberColumn</a><p class="sub-desc"></p></li>\r
-<li><b><tt>datecolumn</tt></b> : <a href="output/Ext.grid.DateColumn.html" ext:cls="Ext.grid.DateColumn">Ext.grid.DateColumn</a><p class="sub-desc"></p></li>\r
-<li><b><tt>templatecolumn</tt></b> : <a href="output/Ext.grid.TemplateColumn.html" ext:cls="Ext.grid.TemplateColumn">Ext.grid.TemplateColumn</a><p class="sub-desc"></p></li>\r
-</ul></div>\r
-<p>Configuration properties for the specified <code>xtype</code> may be specified with\r
-the Column configuration properties, for example:</p>\r
-<pre><code><b>var</b> grid = <b>new</b> Ext.grid.GridPanel({\r
- ...\r
- columns: [{\r
- header: <em>'Last Updated'</em>,\r
- dataIndex: <em>'lastChange'</em>,\r
- width: 85,\r
- sortable: true,\r
- <i>//renderer: Ext.util.Format.dateRenderer(<em>'m/d/Y'</em>),\r</i>
- xtype: <em>'datecolumn'</em>, <i>// use xtype instead of renderer\r</i>
- format: <em>'M/d/Y'</em> <i>// configuration property <b>for</b> <a href="output/Ext.grid.DateColumn.html" ext:cls="Ext.grid.DateColumn">Ext.grid.DateColumn</a>\r</i>
- }, {\r
- ...\r
- }]\r
-});</code></pre></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#xtype" ext:member="#xtype" ext:cls="Ext.grid.Column">Column</a></td></tr></tbody></table><a id="Ext.grid.BooleanColumn-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-renderer"></a><b><a href="source/Column.html#prop-Ext.grid.Column-renderer">renderer</a></b> : Function<div class="mdesc"><div class="short">Optional. A function which returns displayable data when passed the following parameters:
-<div class="mdetail-params...</div><div class="long">Optional. A function which returns displayable data when passed the following parameters:\r
-<div class="mdetail-params"><ul>\r
-<li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>\r
-<li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>\r
-<li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>\r
-<li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container\r
-element <i>within</i> the table cell (e.g. 'style="color:red;"').</p></li></ul></p></li>\r
-<li><b>record</b> : Ext.data.record<p class="sub-desc">The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> from which the data was\r
-extracted.</p></li>\r
-<li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>\r
-<li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>\r
-<li><b>store</b> : Ext.data.Store<p class="sub-desc">The <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a> object from which the Record\r
-was extracted.</p></li>\r
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.grid.BooleanColumn-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.grid.BooleanColumn-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.grid.BooleanColumn-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.grid.BooleanColumn-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.grid.BooleanColumn"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.grid.Column.html" ext:member="" ext:cls="Ext.grid.Column">Column</a>
+ <img src="resources/elbow-end.gif">BooleanColumn</pre></div><h1>Class <a href="source/Column.html#cls-Ext.grid.BooleanColumn">Ext.grid.BooleanColumn</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/Column.html#cls-Ext.grid.BooleanColumn">Column.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Column.html#cls-Ext.grid.BooleanColumn">BooleanColumn</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column" ext:member="">Column</a></td></tr></table><div class="description"><p>A Column definition class which renders boolean data fields. See the <a href="output/Ext.grid.Column.html#Ext.grid.Column-xtype" ext:member="xtype" ext:cls="Ext.grid.Column">xtype</a>
+config option of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> for more details.</p></div><div class="hr"></div><a id="Ext.grid.BooleanColumn-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-align"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-align">align</a></b> : String<div class="mdesc">Optional. Set the CSS text-align property of the column. Defaults to undefined.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#align" ext:member="#align" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-css"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-css">css</a></b> : String<div class="mdesc"><div class="short">Optional. An inline style definition string which is applied to all table cells in the column
+(excluding headers). De...</div><div class="long">Optional. An inline style definition string which is applied to all table cells in the column
+(excluding headers). Defaults to undefined.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#css" ext:member="#css" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-dataIndex"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-dataIndex">dataIndex</a></b> : String<div class="mdesc"><div class="short">Required. The name of the field in the
+grid's Ext.data.Store's Ext.data.Record definition from
+which to draw the colu...</div><div class="long"><p><b>Required</b>. The name of the field in the
+grid's <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a>'s <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> definition from
+which to draw the column's value.</p></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#dataIndex" ext:member="#dataIndex" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-editable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-editable">editable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. Defaults to true, enabling the configured
+editor. Set to false to initially disable editing on this column...</div><div class="long">Optional. Defaults to <tt>true</tt>, enabling the configured
+<tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-editor" ext:member="editor" ext:cls="Ext.grid.Column">editor</a></tt>. Set to <tt>false</tt> to initially disable editing on this column.
+The initial configuration may be dynamically altered using
+<a href="output/Ext.grid.ColumnModel.html" ext:cls="Ext.grid.ColumnModel">Ext.grid.ColumnModel</a>.<a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-setEditable" ext:member="setEditable" ext:cls="Ext.grid.ColumnModel">setEditable()</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#editable" ext:member="#editable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-editor"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-editor">editor</a></b> : Ext.form.Field<div class="mdesc"><div class="short">Optional. The Ext.form.Field to use when editing values in this column
+if editing is supported by the grid. See edita...</div><div class="long">Optional. The <a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field">Ext.form.Field</a> to use when editing values in this column
+if editing is supported by the grid. See <tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-editable" ext:member="editable" ext:cls="Ext.grid.Column">editable</a></tt> also.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#editor" ext:member="#editor" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-emptyGroupText"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-emptyGroupText">emptyGroupText</a></b> : String<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
+may be used to specify the text to d...</div><div class="long">Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option
+may be used to specify the text to display when there is an empty group value. Defaults to the
+<a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>.<a href="output/Ext.grid.GroupingView.html#Ext.grid.GroupingView-emptyGroupText" ext:member="emptyGroupText" ext:cls="Ext.grid.GroupingView">emptyGroupText</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#emptyGroupText" ext:member="#emptyGroupText" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.BooleanColumn-falseText"></a><b><a href="source/Column.html#cfg-Ext.grid.BooleanColumn-falseText">falseText</a></b> : String<div class="mdesc">The string returned by the renderer when the column value is falsy (but not undefined) (defaults to
+<tt>'false'</tt>).</div></td><td class="msource">BooleanColumn</td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-fixed"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-fixed">fixed</a></b> : Boolean<div class="mdesc">Optional. <tt>true</tt> if the column width cannot be changed. Defaults to <tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#fixed" ext:member="#fixed" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-groupName"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-groupName">groupName</a></b> : String<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
+may be used to specify the text with...</div><div class="long">Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option
+may be used to specify the text with which to prefix the group field value in the group header line.
+See also <a href="output/Ext.grid.Column.html#Ext.grid.Column-groupRenderer" ext:member="groupRenderer" ext:cls="Ext.grid.Column">groupRenderer</a> and
+<a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>.<a href="output/Ext.grid.GroupingView.html#Ext.grid.GroupingView-showGroupName" ext:member="showGroupName" ext:cls="Ext.grid.GroupingView">showGroupName</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#groupName" ext:member="#groupName" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-groupRenderer"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-groupRenderer">groupRenderer</a></b> : Function<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
+may be used to specify the function ...</div><div class="long"><p>Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option
+may be used to specify the function used to format the grouping field value for display in the group
+<a href="output/Ext.grid.Column.html#Ext.grid.Column-groupName" ext:member="groupName" ext:cls="Ext.grid.Column">header</a>. If a <tt><b>groupRenderer</b></tt> is not specified, the configured
+<tt><b><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></b></tt> will be called; if a <tt><b><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></b></tt> is also not specified
+the new value of the group field will be used.</p>
+<p>The called function (either the <tt><b>groupRenderer</b></tt> or <tt><b><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></b></tt>) will be
+passed the following parameters:
+<div class="mdetail-params"><ul>
+<li><b>v</b> : Object<p class="sub-desc">The new value of the group field.</p></li>
+<li><b>unused</b> : undefined<p class="sub-desc">Unused parameter.</p></li>
+<li><b>r</b> : Ext.data.Record<p class="sub-desc">The Record providing the data
+for the row which caused group change.</p></li>
+<li><b>rowIndex</b> : Number<p class="sub-desc">The row index of the Record which caused group change.</p></li>
+<li><b>colIndex</b> : Number<p class="sub-desc">The column index of the group field.</p></li>
+<li><b>ds</b> : Ext.data.Store<p class="sub-desc">The Store which is providing the data Model.</p></li>
+</ul></div></p>
+<p>The function should return a string value.</p></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#groupRenderer" ext:member="#groupRenderer" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-groupable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-groupable">groupable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. If the grid is being rendered by an Ext.grid.GroupingView, this option
+may be used to disable the header me...</div><div class="long">Optional. If the grid is being rendered by an <a href="output/Ext.grid.GroupingView.html" ext:cls="Ext.grid.GroupingView">Ext.grid.GroupingView</a>, this option
+may be used to disable the header menu item to group by the column selected. Defaults to <tt>true</tt>,
+which enables the header menu group option. Set to <tt>false</tt> to disable (but still show) the
+group option in the header menu for the column. See also <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-groupName" ext:member="groupName" ext:cls="Ext.grid.Column">groupName</a></code>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#groupable" ext:member="#groupable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-header"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-header">header</a></b> : String<div class="mdesc"><div class="short">Optional. The header text to be used as innerHTML
+(html tags are accepted) to display in the Grid view. Note: to
+hav...</div><div class="long">Optional. The header text to be used as innerHTML
+(html tags are accepted) to display in the Grid view. <b>Note</b>: to
+have a clickable header with no text displayed use <tt>'&#160;'</tt>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#header" ext:member="#header" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-hidden"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hidden">hidden</a></b> : Boolean<div class="mdesc"><div class="short">Optional. true to initially hide this column. Defaults to false.
+A hidden column may be shown via the header row menu...</div><div class="long">Optional. <tt>true</tt> to initially hide this column. Defaults to <tt>false</tt>.
+A hidden column <a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-enableColumnHide" ext:member="enableColumnHide" ext:cls="Ext.grid.GridPanel">may be shown via the header row menu</a>.
+If a column is never to be shown, simply do not include this column in the Column Model at all.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#hidden" ext:member="#hidden" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-hideable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hideable">hideable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. Specify as false to prevent the user from hiding this column
+(defaults to true). To disallow column hiding...</div><div class="long">Optional. Specify as <tt>false</tt> to prevent the user from hiding this column
+(defaults to true). To disallow column hiding globally for all columns in the grid, use
+<a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-enableColumnHide" ext:member="enableColumnHide" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel.enableColumnHide</a> instead.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#hideable" ext:member="#hideable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-id"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-id">id</a></b> : String<div class="mdesc"><div class="short">Optional. A name which identifies this column (defaults to the column's initial
+ordinal position.) The id is used to ...</div><div class="long">Optional. A name which identifies this column (defaults to the column's initial
+ordinal position.) The <tt>id</tt> is used to create a CSS <b>class</b> name which is applied to all
+table cells (including headers) in that column (in this context the <tt>id</tt> does not need to be
+unique). The class name takes the form of <pre>x-grid3-td-<b>id</b></pre>
+Header cells will also receive this class name, but will also have the class <pre>x-grid3-hd</pre>
+So, to target header cells, use CSS selectors such as:<pre>.x-grid3-hd-row .x-grid3-td-<b>id</b></pre>
+The <a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-autoExpandColumn" ext:member="autoExpandColumn" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel.autoExpandColumn</a> grid config option references the column via this
+unique identifier.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#id" ext:member="#id" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-menuDisabled"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-menuDisabled">menuDisabled</a></b> : Boolean<div class="mdesc">Optional. <tt>true</tt> to disable the column menu. Defaults to <tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#menuDisabled" ext:member="#menuDisabled" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-renderer"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-renderer">renderer</a></b> : Mixed<div class="mdesc"><div class="short">For an alternative to specifying a renderer see xtype
+Optional. A renderer is an 'interceptor' method which can be us...</div><div class="long"><p>For an alternative to specifying a renderer see <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-xtype" ext:member="xtype" ext:cls="Ext.grid.Column">xtype</a></code></p>
+<p>Optional. A renderer is an 'interceptor' method which can be used transform data (value,
+appearance, etc.) before it is rendered). This may be specified in either of three ways:
+<div class="mdetail-params"><ul>
+<li>A renderer function used to return HTML markup for a cell given the cell's data value.</li>
+<li>A string which references a property name of the <a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">Ext.util.Format</a> class which
+provides a renderer function.</li>
+<li>An object specifying both the renderer function, and its execution scope (<tt><b>this</b></tt>
+reference) e.g.:<pre style="margin-left:1.2em"><code>{
+ fn: this.gridRenderer,
+ scope: this
+}</code></pre></li></ul></div>
+If not specified, the default renderer uses the raw data value.</p>
+<p>For information about the renderer function (passed parameters, etc.), see
+<a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-setRenderer" ext:member="setRenderer" ext:cls="Ext.grid.ColumnModel">Ext.grid.ColumnModel.setRenderer</a>. An example of specifying renderer function inline:</p><pre><code><b>var</b> companyColumn = {
+ header: <em>'Company Name'</em>,
+ dataIndex: <em>'company'</em>,
+ renderer: <b>function</b>(value, metaData, record, rowIndex, colIndex, store) {
+ <i>// provide the logic depending on business rules</i>
+ <i>// name of your own choosing to manipulate the cell depending upon</i>
+ <i>// the data <b>in</b> the underlying Record object.</i>
+ <b>if</b> (value == <em>'whatever'</em>) {
+ <i>//metaData.css : String : A CSS class name to add to the TD element of the cell.</i>
+ <i>//metaData.attr : String : An html attribute definition string to apply to</i>
+ <i>// the data container element within the table</i>
+ <i>// cell (e.g. <em>'style=<em>"color:red;"</em>'</em>).</i>
+ metaData.css = <em>'name-of-css-class-you-will-define'</em>;
+ }
+ <b>return</b> value;
+ }
+}</code></pre>
+See also <a href="output/Ext.grid.Column.html#Ext.grid.Column-scope" ext:member="scope" ext:cls="Ext.grid.Column">scope</a>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#renderer" ext:member="#renderer" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-resizable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-resizable">resizable</a></b> : Boolean<div class="mdesc">Optional. <tt>false</tt> to disable column resizing. Defaults to <tt>true</tt>.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#resizable" ext:member="#resizable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-scope"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-scope">scope</a></b> : Object<div class="mdesc">Optional. The scope (<tt><b>this</b></tt> reference) in which to execute the
+renderer. Defaults to the Column configuration object.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#scope" ext:member="#scope" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-sortable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-sortable">sortable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. true if sorting is to be allowed on this column.
+Defaults to the value of the Ext.grid.ColumnModel.defaultS...</div><div class="long">Optional. <tt>true</tt> if sorting is to be allowed on this column.
+Defaults to the value of the <code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaultSortable" ext:member="defaultSortable" ext:cls="Ext.grid.ColumnModel">Ext.grid.ColumnModel.defaultSortable</a></code> property.
+Whether local/remote sorting is used is specified in <code><a href="output/Ext.data.Store.html#Ext.data.Store-remoteSort" ext:member="remoteSort" ext:cls="Ext.data.Store">Ext.data.Store.remoteSort</a></code>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#sortable" ext:member="#sortable" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-tooltip"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-tooltip">tooltip</a></b> : String<div class="mdesc"><div class="short">Optional. A text string to use as the column header's tooltip. If Quicktips
+are enabled, this value will be used as ...</div><div class="long">Optional. A text string to use as the column header's tooltip. If Quicktips
+are enabled, this value will be used as the text of the quick tip, otherwise it will be set as the
+header's HTML title attribute. Defaults to ''.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#tooltip" ext:member="#tooltip" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.BooleanColumn-trueText"></a><b><a href="source/Column.html#cfg-Ext.grid.BooleanColumn-trueText">trueText</a></b> : String<div class="mdesc">The string returned by the renderer when the column value is not falsy (defaults to <tt>'true'</tt>).</div></td><td class="msource">BooleanColumn</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.BooleanColumn-undefinedText"></a><b><a href="source/Column.html#cfg-Ext.grid.BooleanColumn-undefinedText">undefinedText</a></b> : String<div class="mdesc">The string returned by the renderer when the column value is undefined (defaults to <tt>'&#160;'</tt>).</div></td><td class="msource">BooleanColumn</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-width"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-width">width</a></b> : Number<div class="mdesc"><div class="short">Optional. The initial width in pixels of the column.
+The width of each column can also be affected if any of the foll...</div><div class="long">Optional. The initial width in pixels of the column.
+The width of each column can also be affected if any of the following are configured:
+<div class="mdetail-params"><ul>
+<li><a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel</a>.<tt><a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-autoExpandColumn" ext:member="autoExpandColumn" ext:cls="Ext.grid.GridPanel">autoExpandColumn</a></tt></li>
+<li><a href="output/Ext.grid.GridView.html" ext:cls="Ext.grid.GridView">Ext.grid.GridView</a>.<tt><a href="output/Ext.grid.GridView.html#Ext.grid.GridView-forceFit" ext:member="forceFit" ext:cls="Ext.grid.GridView">forceFit</a></tt>
+<div class="sub-desc">
+<p>By specifying <tt>forceFit:true</tt>, <a href="output/Ext.grid.Column.html#Ext.grid.Column-fixed" ext:member="fixed" ext:cls="Ext.grid.Column">non-fixed width</a> columns will be
+re-proportioned (based on the relative initial widths) to fill the width of the grid so
+that no horizontal scrollbar is shown.</p>
+</div></li>
+<li><a href="output/Ext.grid.GridView.html" ext:cls="Ext.grid.GridView">Ext.grid.GridView</a>.<tt><a href="output/Ext.grid.GridView.html#Ext.grid.GridView-autoFill" ext:member="autoFill" ext:cls="Ext.grid.GridView">autoFill</a></tt></li>
+<li><a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel</a>.<tt><a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-minColumnWidth" ext:member="minColumnWidth" ext:cls="Ext.grid.GridPanel">minColumnWidth</a></tt></li>
+<br><p><b>Note</b>: when the width of each column is determined, a space on the right side
+is reserved for the vertical scrollbar. The
+<a href="output/Ext.grid.GridView.html" ext:cls="Ext.grid.GridView">Ext.grid.GridView</a>.<tt><a href="output/Ext.grid.GridView.html#Ext.grid.GridView-scrollOffset" ext:member="scrollOffset" ext:cls="Ext.grid.GridView">scrollOffset</a></tt>
+can be modified to reduce or eliminate the reserved offset.</p></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#width" ext:member="#width" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-xtype"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-xtype">xtype</a></b> : String<div class="mdesc"><div class="short">Optional. A String which references a predefined Ext.grid.Column subclass
+type which is preconfigured with an appropr...</div><div class="long">Optional. A String which references a predefined <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> subclass
+type which is preconfigured with an appropriate <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-renderer" ext:member="renderer" ext:cls="Ext.grid.Column">renderer</a></code> to be easily
+configured into a ColumnModel. The predefined <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> subclass types are:
+<div class="mdetail-params"><ul>
+<li><b><tt>gridcolumn</tt></b> : <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> (<b>Default</b>)<p class="sub-desc"></p></li>
+<li><b><tt>booleancolumn</tt></b> : <a href="output/Ext.grid.BooleanColumn.html" ext:cls="Ext.grid.BooleanColumn">Ext.grid.BooleanColumn</a><p class="sub-desc"></p></li>
+<li><b><tt>numbercolumn</tt></b> : <a href="output/Ext.grid.NumberColumn.html" ext:cls="Ext.grid.NumberColumn">Ext.grid.NumberColumn</a><p class="sub-desc"></p></li>
+<li><b><tt>datecolumn</tt></b> : <a href="output/Ext.grid.DateColumn.html" ext:cls="Ext.grid.DateColumn">Ext.grid.DateColumn</a><p class="sub-desc"></p></li>
+<li><b><tt>templatecolumn</tt></b> : <a href="output/Ext.grid.TemplateColumn.html" ext:cls="Ext.grid.TemplateColumn">Ext.grid.TemplateColumn</a><p class="sub-desc"></p></li>
+</ul></div>
+<p>Configuration properties for the specified <code>xtype</code> may be specified with
+the Column configuration properties, for example:</p>
+<pre><code><b>var</b> grid = <b>new</b> Ext.grid.GridPanel({
+ ...
+ columns: [{
+ header: <em>'Last Updated'</em>,
+ dataIndex: <em>'lastChange'</em>,
+ width: 85,
+ sortable: true,
+ <i>//renderer: Ext.util.Format.dateRenderer(<em>'m/d/Y'</em>),</i>
+ xtype: <em>'datecolumn'</em>, <i>// use xtype instead of renderer</i>
+ format: <em>'M/d/Y'</em> <i>// configuration property <b>for</b> <a href="output/Ext.grid.DateColumn.html" ext:cls="Ext.grid.DateColumn">Ext.grid.DateColumn</a></i>
+ }, {
+ ...
+ }]
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#xtype" ext:member="#xtype" ext:cls="Ext.grid.Column">Column</a></td></tr></tbody></table><a id="Ext.grid.BooleanColumn-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.Column-renderer"></a><b><a href="source/Column.html#prop-Ext.grid.Column-renderer">renderer</a></b> : Function<div class="mdesc"><div class="short">Optional. A function which returns displayable data when passed the following parameters:
+<div class="mdetail-params"...</div><div class="long">Optional. A function which returns displayable data when passed the following parameters:
+<div class="mdetail-params"><ul>
+<li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>
+<li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
+<li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
+<li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container
+element <i>within</i> the table cell (e.g. 'style="color:red;"').</p></li></ul></p></li>
+<li><b>record</b> : Ext.data.record<p class="sub-desc">The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> from which the data was
+extracted.</p></li>
+<li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>
+<li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
+<li><b>store</b> : Ext.data.Store<p class="sub-desc">The <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a> object from which the Record
+was extracted.</p></li>
git.ithinksw.org / extjs.git / blobdiff