Upgrade to ExtJS 3.1.1 - Released 02/08/2010
[extjs.git] / docs / output / Ext.grid.Column.html
index 4df2518..4cb5360 100644 (file)
@@ -1,4 +1,4 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.grid.Column-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.grid.Column-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.grid.Column-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.grid.Column-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.grid.Column"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Column.html#cls-Ext.grid.Column">Ext.grid.Column</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.Column">Column</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.grid.BooleanColumn.html" ext:cls="Ext.grid.BooleanColumn">BooleanColumn</a>,&#13;<a href="output/Ext.grid.DateColumn.html" ext:cls="Ext.grid.DateColumn">DateColumn</a>,&#13;<a href="output/Ext.grid.NumberColumn.html" ext:cls="Ext.grid.NumberColumn">NumberColumn</a>,&#13;<a href="output/Ext.grid.TemplateColumn.html" ext:cls="Ext.grid.TemplateColumn">TemplateColumn</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>This class encapsulates column configuration data to be used in the initialization of a\r
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/Column.html#cls-Ext.grid.Column">Ext.grid.Column</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.Column">Column</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.grid.BooleanColumn.html" ext:cls="Ext.grid.BooleanColumn">BooleanColumn</a>,&#13;<a href="output/Ext.grid.DateColumn.html" ext:cls="Ext.grid.DateColumn">DateColumn</a>,&#13;<a href="output/Ext.grid.NumberColumn.html" ext:cls="Ext.grid.NumberColumn">NumberColumn</a>,&#13;<a href="output/Ext.grid.TemplateColumn.html" ext:cls="Ext.grid.TemplateColumn">TemplateColumn</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>This class encapsulates column configuration data to be used in the initialization of a\r
 <a href="output/Ext.grid.ColumnModel.html" ext:cls="Ext.grid.ColumnModel">ColumnModel</a>.</p>\r
 <p>While subclasses are provided to render data in different ways, this class renders a passed\r
 data field unchanged and is usually used for textual columns.</p></div><div class="hr"></div><a id="Ext.grid.Column-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  "><td class="micon"><a href="#expand" class="exi">&nbsp;</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">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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&#13;
@@ -45,7 +45,10 @@ group option in the header menu for the column. See also <code><a href="output/E
 (html tags are accepted) to display in the Grid view.  Note: to&#13;
 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>'&#160;'</tt>.</div></div></td><td class="msource">Column</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</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">Optional. <tt>true</tt> to hide the column. Defaults to <tt>false</tt>.</div></td><td class="msource">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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&#13;
+have a clickable header with no text displayed use <tt>'&#160;'</tt>.</div></div></td><td class="msource">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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.&#13;
+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">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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&#13;
 (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">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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&#13;
@@ -90,10 +93,9 @@ If not specified, the default renderer uses the raw data value.</p>
 }</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">Column</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</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">Column</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</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">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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.&#13;
-Defaults to the value of the defaultSortable property.&#13;
-W...</div><div class="long">Optional. <tt>true</tt> if sorting is to be allowed on this column.\r
-Defaults to the value of the <a href="output/Ext.grid.Column.html#Ext.grid.Column-defaultSortable" ext:member="defaultSortable" ext:cls="Ext.grid.Column">defaultSortable</a> property.\r
-Whether local/remote sorting is used is specified in <a href="output/Ext.data.Store.html#Ext.data.Store-remoteSort" ext:member="remoteSort" ext:cls="Ext.data.Store">Ext.data.Store.remoteSort</a>.</div></div></td><td class="msource">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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&#13;
+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">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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&#13;
 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">Column</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</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.&#13;
@@ -156,4 +158,6 @@ was extracted.</p></li>
     :
                                         Ext.Editor<div class="mdesc"><div class="short">Returns the editor defined for this column that was created to wrap the Field&#13;
 used to edit the cell.</div><div class="long">Returns the <a href="output/Ext.Editor.html" ext:cls="Ext.Editor">editor</a> defined for this column that was created to wrap the <a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field">Field</a>\r
-used to edit the cell.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Editor</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Column</td></tr></tbody></table><a id="Ext.grid.Column-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file
+used to edit the cell.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Editor</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Column</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-setEditor"></a><b><a href="source/Column.html#method-Ext.grid.Column-setEditor">setEditor</a></b>(&nbsp;<code>Ext.Editor/Ext.form.Field&nbsp;editor</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Sets a new editor for this column.</div><div class="long">Sets a new editor for this column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>editor</code> : Ext.Editor/Ext.form.Field<div class="sub-desc">The editor to set</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Column</td></tr></tbody></table><a id="Ext.grid.Column-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file