Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / output / Ext.list.Column.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.list.Column-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.list.Column-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.list.Column-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.list.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.list.Column"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Column1.html#cls-Ext.list.Column">Ext.list.Column</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.list</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/Column1.html#cls-Ext.list.Column">Column.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Column1.html#cls-Ext.list.Column">Column</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.list.BooleanColumn.html" ext:cls="Ext.list.BooleanColumn">BooleanColumn</a>,&#13;<a href="output/Ext.list.DateColumn.html" ext:cls="Ext.list.DateColumn">DateColumn</a>,&#13;<a href="output/Ext.list.NumberColumn.html" ext:cls="Ext.list.NumberColumn">NumberColumn</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
2 <a href="output/Ext.list.ListView.html" ext:cls="Ext.list.ListView">ListView</a>.</p>
3 <p>While subclasses are provided to render data in different ways, this class renders a passed
4 data field unchanged and is usually used for textual columns.</p></div><div class="hr"></div><a id="Ext.list.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.list.Column-align"></a><b><a href="source/Column1.html#cfg-Ext.list.Column-align">align</a></b> : String<div class="mdesc">Set the CSS text-align property of the column. Defaults to <tt>'left'</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.list.Column-cls"></a><b><a href="source/Column1.html#cfg-Ext.list.Column-cls">cls</a></b> : String<div class="mdesc">Optional. This option can be used to add a CSS class to the cell of each
5 row for this column.</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.list.Column-dataIndex"></a><b><a href="source/Column1.html#cfg-Ext.list.Column-dataIndex">dataIndex</a></b> : String<div class="mdesc"><div class="short">Required. The name of the field in the
6 ListViews's Ext.data.Store's Ext.data.Record definition from
7 which to draw the...</div><div class="long"><p><b>Required</b>. The name of the field in the
8 ListViews'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
9 which to draw the column's value.</p></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.list.Column-header"></a><b><a href="source/Column1.html#cfg-Ext.list.Column-header">header</a></b> : String<div class="mdesc"><div class="short">Optional. The header text to be used as innerHTML
10 (html tags are accepted) to display in the ListView.  Note: to
11 have...</div><div class="long">Optional. The header text to be used as innerHTML
12 (html tags are accepted) to display in the ListView.  <b>Note</b>: to
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.list.Column-tpl"></a><b><a href="source/Column1.html#cfg-Ext.list.Column-tpl">tpl</a></b> : String<div class="mdesc"><div class="short">Optional. Specify a string to pass as the
14 configuration string for Ext.XTemplate.  By default an Ext.XTemplate
15 will b...</div><div class="long">Optional. Specify a string to pass as the
16 configuration string for <a href="output/Ext.XTemplate.html" ext:cls="Ext.XTemplate">Ext.XTemplate</a>.  By default an <a href="output/Ext.XTemplate.html" ext:cls="Ext.XTemplate">Ext.XTemplate</a>
17 will be implicitly created using the <tt>dataIndex</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.list.Column-width"></a><b><a href="source/Column1.html#cfg-Ext.list.Column-width">width</a></b> : Number<div class="mdesc"><div class="short">Optional. Percentage of the container width
18 this column should be allocated.  Columns that have no width specified wi...</div><div class="long">Optional. Percentage of the container width
19 this column should be allocated.  Columns that have no width specified will be
20 allocated with an equal percentage to fill 100% of the container width.  To easily take
21 advantage of the full container width, leave the width of at least one column undefined.
22 Note that if you do not want to take up the full width of the container, the width of
23 every column needs to be explicitly defined.</div></div></td><td class="msource">Column</td></tr></tbody></table><a id="Ext.list.Column-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.list.Column-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.list.Column-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>