1
<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.grid.ColumnModel-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.grid.ColumnModel-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.grid.ColumnModel-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.grid.ColumnModel-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.grid.ColumnModel"><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.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif">ColumnModel</pre></div><h1>Class <a href="source/ColumnModel.html#cls-Ext.grid.ColumnModel">Ext.grid.ColumnModel</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">ColumnModel.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/ColumnModel.html#cls-Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.grid.PropertyColumnModel.html" ext:cls="Ext.grid.PropertyColumnModel">PropertyColumnModel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p>After the data has been read into the client side cache (<b><a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Store</a></b>),
2
the ColumnModel is used to configure how and what parts of that data will be displayed in the
3
vertical slices (columns) of the grid. The Ext.grid.ColumnModel Class is the default implementation
4
of a ColumnModel used by implentations of <a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">GridPanel</a>.</p>
5
<p>Data is mapped into the store's records and then indexed into the ColumnModel using the
6
<tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-dataIndex" ext:member="dataIndex" ext:cls="Ext.grid.Column">dataIndex</a></tt>:</p>
7
<pre><code>{data source} == mapping ==> {data store} == <b><tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-dataIndex" ext:member="dataIndex" ext:cls="Ext.grid.Column">dataIndex</a></tt></b> ==> {ColumnModel}</code></pre>
8
<p>Each <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Column</a> in the grid's ColumnModel is configured with a
9
<tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-dataIndex" ext:member="dataIndex" ext:cls="Ext.grid.Column">dataIndex</a></tt> to specify how the data within
10
each record in the store is indexed into the ColumnModel.</p>
11
<p>There are two ways to initialize the ColumnModel class:</p>
12
<p><u>Initialization Method 1: an Array</u></p>
13
<pre><code><b>var</b> colModel = <b>new</b> Ext.grid.ColumnModel([
14
{ header: <em>"Ticker"</em>, width: 60, sortable: true},
15
{ header: <em>"Company Name"</em>, width: 150, sortable: true, id: <em>'company'</em>},
16
{ header: <em>"Market Cap."</em>, width: 100, sortable: true},
17
{ header: <em>"$ Sales"</em>, width: 100, sortable: true, renderer: money},
18
{ header: <em>"Employees"</em>, width: 100, sortable: true, resizable: false}
20
<p>The ColumnModel may be initialized with an Array of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> column configuration
21
objects to define the initial layout / display of the columns in the Grid. The order of each
22
<a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> column configuration object within the specified Array defines the initial
23
order of the column display. A Column's display may be initially hidden using the
24
<tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-hidden" ext:member="hidden" ext:cls="Ext.grid.Column">hidden</a></tt></b> config property (and then shown using the column
25
header menu). Field's that are not included in the ColumnModel will not be displayable at all.</p>
26
<p>How each column in the grid correlates (maps) to the <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> field in the
27
<a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Store</a> the column draws its data from is configured through the
28
<b><tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-dataIndex" ext:member="dataIndex" ext:cls="Ext.grid.Column">dataIndex</a></tt></b>. If the
29
<b><tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-dataIndex" ext:member="dataIndex" ext:cls="Ext.grid.Column">dataIndex</a></tt></b> is not explicitly defined (as shown in the
30
example above) it will use the column configuration's index in the Array as the index.</p>
31
<p>See <b><tt><a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a></tt></b> for additional configuration options for each column.</p>
32
<p><u>Initialization Method 2: an Object</u></p>
33
<p>In order to use configuration options from <tt>Ext.grid.ColumnModel</tt>, an Object may be used to
34
initialize the ColumnModel. The column configuration Array will be specified in the <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-columns" ext:member="columns" ext:cls="Ext.grid.ColumnModel">columns</a></b></tt>
35
config property. The <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaults" ext:member="defaults" ext:cls="Ext.grid.ColumnModel">defaults</a></b></tt> config property can be used to apply defaults
36
for all columns, e.g.:</p><pre><code><b>var</b> colModel = <b>new</b> Ext.grid.ColumnModel({
38
{ header: <em>"Ticker"</em>, width: 60, menuDisabled: false},
39
{ header: <em>"Company Name"</em>, width: 150, id: <em>'company'</em>},
40
{ header: <em>"Market Cap."</em>},
41
{ header: <em>"$ Sales"</em>, renderer: money},
42
{ header: <em>"Employees"</em>, resizable: false}
50
<a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-hiddenchange" ext:member="hiddenchange" ext:cls="Ext.grid.ColumnModel">hiddenchange</a>: <b>function</b>(cm, colIndex, hidden) {
51
saveConfig(colIndex, hidden);
55
<p>In both examples above, the ability to apply a CSS class to all cells in a column (including the
56
header) is demonstrated through the use of the <b><tt><a href="output/Ext.grid.Column.html#Ext.grid.Column-id" ext:member="id" ext:cls="Ext.grid.Column">id</a></tt></b> config
57
option. This column could be styled by including the following css:</p><pre><code><i>//add this css *after* the core css is loaded</i>
59
color: red; <i>// entire column will have red font</i>
61
<i>// modify the header row only, adding an icon to the column header</i>
63
background: transparent
64
url(../../resources/images/icons/silk/building.png)
65
no-repeat 3px 3px ! important;
68
Note that the "Company Name" column could be specified as the
69
<b><tt><a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel</a>.<a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-autoExpandColumn" ext:member="autoExpandColumn" ext:cls="Ext.grid.GridPanel">autoExpandColumn</a></tt></b>.</div><div class="hr"></div><a id="Ext.grid.ColumnModel-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 expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-columns"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-columns">columns</a></b> : Array<div class="mdesc"><div class="short">An Array of object literals. The config options defined by
70
Ext.grid.Column are the options which may appear in the o...</div><div class="long">An Array of object literals. The config options defined by
71
<b><a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a></b> are the options which may appear in the object literal for each
72
individual column definition.</div></div></td><td class="msource">ColumnModel</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-defaultSortable"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-defaultSortable">defaultSortable</a></b> : Boolean<div class="mdesc"><div class="short">Default sortable of columns which have no
73
sortable specified (defaults to false). This property shall preferably be ...</div><div class="long">Default sortable of columns which have no
74
sortable specified (defaults to <tt>false</tt>). This property shall preferably be configured
75
through the <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaults" ext:member="defaults" ext:cls="Ext.grid.ColumnModel">defaults</a></b></tt> config property.</div></div></td><td class="msource">ColumnModel</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-defaultWidth"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-defaultWidth">defaultWidth</a></b> : Number<div class="mdesc"><div class="short">The width of columns which have no width
76
specified (defaults to 100). This property shall preferably be configured t...</div><div class="long">The width of columns which have no <tt><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-width" ext:member="width" ext:cls="Ext.grid.ColumnModel">width</a></tt>
77
specified (defaults to <tt>100</tt>). This property shall preferably be configured through the
78
<tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaults" ext:member="defaults" ext:cls="Ext.grid.ColumnModel">defaults</a></b></tt> config property.</div></div></td><td class="msource">ColumnModel</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-defaults"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-defaults">defaults</a></b> : Object<div class="mdesc"><div class="short">Object literal which will be used to apply Ext.grid.Column
79
configuration options to all columns. Configuration optio...</div><div class="long">Object literal which will be used to apply <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a>
80
configuration options to all <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-columns" ext:member="columns" ext:cls="Ext.grid.ColumnModel">columns</a></b></tt>. Configuration options specified with
81
individual <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">column</a> configs will supersede these <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaults" ext:member="defaults" ext:cls="Ext.grid.ColumnModel">defaults</a></b></tt>.</div></div></td><td class="msource">ColumnModel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
82
object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
83
object during initialization. This should be a valid listeners config object as specified in the
84
<a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
85
<br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
86
<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
87
is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
88
<b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
89
events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
90
has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
91
<i>// The Component is appended to the argument list of all handler functions.</i>
92
Ext.DomObserver = Ext.extend(Object, {
93
constructor: <b>function</b>(config) {
94
this.listeners = config.listeners ? config.listeners : config;
97
<i>// Component passes itself into plugin's init method</i>
98
init: <b>function</b>(c) {
99
<b>var</b> p, l = this.listeners;
100
<b>for</b> (p <b>in</b> l) {
101
<b>if</b> (Ext.isFunction(l[p])) {
102
l[p] = this.createHandler(l[p], c);
104
l[p].fn = this.createHandler(l[p].fn, c);
108
<i>// Add the listeners to the Element immediately following the render call</i>
109
c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
110
<b>var</b> e = c.getEl();
117
createHandler: <b>function</b>(fn, c) {
118
<b>return</b> <b>function</b>(e) {
124
<b>var</b> combo = <b>new</b> Ext.form.ComboBox({
126
<i>// Collapse combo when its element is clicked on</i>
127
plugins: [ <b>new</b> Ext.DomObserver({
128
click: <b>function</b>(evt, comp) {
134
mode: <em>'local'</em>,
135
triggerAction: <em>'all'</em>
136
});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.grid.ColumnModel-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 "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-config"></a><b><a href="source/ColumnModel.html#prop-Ext.grid.ColumnModel-config">config</a></b> : Array<div class="mdesc"><div class="short">An Array of Column definition objects representing the configuration
137
of this ColumnModel. See Ext.grid.Column for th...</div><div class="long">An Array of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Column definition</a> objects representing the configuration
138
of this ColumnModel. See <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> for the configuration properties that may
139
be specified.</div></div></td><td class="msource">ColumnModel</td></tr></tbody></table><a id="Ext.grid.ColumnModel-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-ColumnModel"></a><b><a href="source/ColumnModel.html#cls-Ext.grid.ColumnModel">ColumnModel</a></b>( <code>Mixed config</code> )
140
<div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Mixed<div class="sub-desc">Specify either an Array of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> configuration objects or specify
141
a configuration Object (see introductory section discussion utilizing Initialization Method 2 above).</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object object</code> )
143
void<div class="mdesc"><div class="short">Used to define events on this Observable</div><div class="long">Used to define events on this Observable<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
145
void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
146
<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
147
properties. This may contain any of the following properties:<ul>
148
<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
149
<b>If omitted, defaults to the object which fired the event.</b></div></li>
150
<li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
151
<li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
152
<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
153
by the specified number of milliseconds. If the event fires again within that time, the original
154
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
155
<li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
156
if the event was bubbled up from a child Observable.</div></li>
159
<b>Combining Options</b><br>
160
Using the options argument, it is possible to combine different types of listeners:<br>
162
A delayed, one-time listener.
163
<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
168
<b>Attaching multiple handlers in 1 call</b><br>
169
The method also allows for a single argument to be passed which is a config object containing properties
170
which specify multiple handlers.
172
<pre><code>myGridPanel.on({
178
<em>'mouseover'</em> : {
179
fn: this.onMouseOver,
182
<em>'mouseout'</em> : {
188
Or a shorthand syntax:<br>
189
<pre><code>myGridPanel.on({
190
<em>'click'</em> : this.onClick,
191
<em>'mouseover'</em> : this.onMouseOver,
192
<em>'mouseout'</em> : this.onMouseOut,
194
});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-destroy"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-destroy">destroy</a></b>()
196
void<div class="mdesc"><div class="short">Destroys this column model by purging any event listeners, and removing any editors.</div><div class="long">Destroys this column model by purging any event listeners, and removing any editors.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>Object events</code> )
198
void<div class="mdesc"><div class="short">Used to enable bubbling of events</div><div class="long">Used to enable bubbling of events<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-findColumnIndex"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-findColumnIndex">findColumnIndex</a></b>( <code>String col</code> )
200
Number<div class="mdesc"><div class="short">Finds the index of the first matching column for the given dataIndex.</div><div class="long">Finds the index of the first matching column for the given dataIndex.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : String<div class="sub-desc">The dataIndex to find</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The column index, or -1 if no match was found</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )
202
Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
203
An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
204
<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
205
by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getCellEditor"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getCellEditor">getCellEditor</a></b>( <code>Number colIndex</code>, <code>Number rowIndex</code> )
207
Ext.Editor<div class="mdesc"><div class="short">Returns the editor defined for the cell/column.</div><div class="long">Returns the editor defined for the cell/column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><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">The {@link Ext.Editor Editor} that was created to wrap
208
the {@link Ext.form.Field Field} used to edit the cell.</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnById"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnById">getColumnById</a></b>( <code>String id</code> )
210
Object<div class="mdesc"><div class="short">Returns the column for a specified id.</div><div class="long">Returns the column for a specified id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">the column</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnCount"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnCount">getColumnCount</a></b>( <code>Boolean visibleOnly</code> )
212
Number<div class="mdesc"><div class="short">Returns the number of columns.</div><div class="long">Returns the number of columns.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>visibleOnly</code> : Boolean<div class="sub-desc">Optional. Pass as true to only include visible columns.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnHeader"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnHeader">getColumnHeader</a></b>( <code>Number col</code> )
214
String<div class="mdesc"><div class="short">Returns the header for the specified column.</div><div class="long">Returns the header for the specified column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnId"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnId">getColumnId</a></b>( <code>Number index</code> )
216
String<div class="mdesc"><div class="short">Returns the id of the column at the specified index.</div><div class="long">Returns the id of the column at the specified index.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">the id</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnTooltip"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnTooltip">getColumnTooltip</a></b>( <code>Number col</code> )
218
String<div class="mdesc"><div class="short">Returns the tooltip for the specified column.</div><div class="long">Returns the tooltip for the specified column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnWidth"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnWidth">getColumnWidth</a></b>( <code>Number col</code> )
220
Number<div class="mdesc"><div class="short">Returns the width for the specified column.</div><div class="long">Returns the width for the specified column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnsBy"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnsBy">getColumnsBy</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
222
Array<div class="mdesc"><div class="short">Returns the column configs that return true by the passed function that is called
223
with (columnConfig, index)
224
// retur...</div><div class="long">Returns the column configs that return true by the passed function that is called
225
with (columnConfig, index)
226
<pre><code><i>// returns an array of column config objects <b>for</b> all hidden columns</i>
227
<b>var</b> columns = grid.getColumnModel().getColumnsBy(<b>function</b>(c){
228
<b>return</b> c.hidden;
229
});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">result</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getDataIndex"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getDataIndex">getDataIndex</a></b>( <code>Number col</code> )
231
String<div class="mdesc"><div class="short">Returns the dataIndex for the specified column.
232
// Get field name for the column
233
var fieldName = grid.getColumnModel(...</div><div class="long">Returns the dataIndex for the specified column.
234
<pre><code><i>// Get field name <b>for</b> the column</i>
235
<b>var</b> fieldName = grid.getColumnModel().getDataIndex(columnIndex);</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The column's dataIndex</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getIndexById"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getIndexById">getIndexById</a></b>( <code>String id</code> )
237
Number<div class="mdesc"><div class="short">Returns the index for a specified column id.</div><div class="long">Returns the index for a specified column id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">the index, or -1 if not found</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getRenderer"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getRenderer">getRenderer</a></b>( <code>Number col</code> )
239
Function<div class="mdesc"><div class="short">Returns the rendering (formatting) function defined for the column.</div><div class="long">Returns the rendering (formatting) function defined for the column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index.</div></li></ul><strong>Returns:</strong><ul><li><code>Function</code><div class="sub-desc">The function used to render the cell. See {@link #setRenderer}.</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getTotalWidth"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getTotalWidth">getTotalWidth</a></b>( <code>Boolean includeHidden</code> )
241
Number<div class="mdesc"><div class="short">Returns the total width of all columns.</div><div class="long">Returns the total width of all columns.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>includeHidden</code> : Boolean<div class="sub-desc">True to include hidden column widths</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> )
243
Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isCellEditable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isCellEditable">isCellEditable</a></b>( <code>Number colIndex</code>, <code>Number rowIndex</code> )
245
Boolean<div class="mdesc"><div class="short">Returns true if the cell is editable.
246
var store = new Ext.data.Store({...});
247
var colModel = new Ext.grid.ColumnModel(...</div><div class="long">Returns true if the cell is editable.
248
<pre><code><b>var</b> store = <b>new</b> Ext.data.Store({...});
249
<b>var</b> colModel = <b>new</b> Ext.grid.ColumnModel({
251
isCellEditable: <b>function</b>(col, row) {
252
<b>var</b> record = store.getAt(row);
253
<b>if</b> (record.get(<em>'readonly'</em>)) { <i>// replace <b>with</b> your condition</i>
256
<b>return</b> Ext.grid.ColumnModel.prototype.isCellEditable.call(this, col, row);
259
<b>var</b> grid = <b>new</b> Ext.grid.GridPanel({
263
});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isFixed"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isFixed">isFixed</a></b>()
265
void<div class="mdesc"><div class="short">Returns true if the column width cannot be changed</div><div class="long">Returns true if the column width cannot be changed<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isHidden"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isHidden">isHidden</a></b>( <code>Number colIndex</code> )
267
Boolean<div class="mdesc"><div class="short">Returns true if the column is hidden.</div><div class="long">Returns true if the column is hidden.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isMenuDisabled"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isMenuDisabled">isMenuDisabled</a></b>( <code>Number col</code> )
269
Boolean<div class="mdesc"><div class="short">Returns true if the specified column menu is disabled.</div><div class="long">Returns true if the specified column menu is disabled.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isResizable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isResizable">isResizable</a></b>()
271
Boolean<div class="mdesc"><div class="short">Returns true if the column can be resized</div><div class="long">Returns true if the column can be resized<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isSortable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isSortable">isSortable</a></b>( <code>Number col</code> )
273
Boolean<div class="mdesc"><div class="short">Returns true if the specified column is sortable.</div><div class="long">Returns true if the specified column is sortable.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-moveColumn"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-moveColumn">moveColumn</a></b>( <code>Number oldIndex</code>, <code>Number newIndex</code> )
275
void<div class="mdesc"><div class="short">Moves a column from one position to another.</div><div class="long">Moves a column from one position to another.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>oldIndex</code> : Number<div class="sub-desc">The index of the column to move.</div></li><li><code>newIndex</code> : Number<div class="sub-desc">The position at which to reinsert the coolumn.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
277
void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
278
<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
280
void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>( <code>Object o</code>, <code>Array events</code> )
282
void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
284
void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
286
void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
287
If events were suspended using the queueSuspended parameter, then all
288
event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
289
If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
290
events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setColumnHeader"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setColumnHeader">setColumnHeader</a></b>( <code>Number col</code>, <code>String header</code> )
292
void<div class="mdesc"><div class="short">Sets the header for a column.</div><div class="long">Sets the header for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>header</code> : String<div class="sub-desc">The new header</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setColumnTooltip"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setColumnTooltip">setColumnTooltip</a></b>( <code>Number col</code>, <code>String tooltip</code> )
294
void<div class="mdesc"><div class="short">Sets the tooltip for a column.</div><div class="long">Sets the tooltip for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>tooltip</code> : String<div class="sub-desc">The new tooltip</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setColumnWidth"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setColumnWidth">setColumnWidth</a></b>( <code>Number col</code>, <code>Number width</code>, <code>Boolean suppressEvent</code> )
296
void<div class="mdesc"><div class="short">Sets the width for a column.</div><div class="long">Sets the width for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>suppressEvent</code> : Boolean<div class="sub-desc">True to suppress firing the <code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-widthchange" ext:member="widthchange" ext:cls="Ext.grid.ColumnModel">widthchange</a></code>
297
event. Defaults to false.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setConfig"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setConfig">setConfig</a></b>( <code>Array config</code>, <code>Boolean initial</code> )
299
void<div class="mdesc"><div class="short">Reconfigures this column model according to the passed Array of column definition objects.
300
For a description of the i...</div><div class="long"><p>Reconfigures this column model according to the passed Array of column definition objects.
301
For a description of the individual properties of a column definition object, see the
302
<a href="#Ext.grid.ColumnModel-configs">Config Options</a>.</p>
303
<p>Causes the <a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-configchange" ext:member="configchange" ext:cls="Ext.grid.ColumnModel">configchange</a> event to be fired. A <a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">GridPanel</a>
304
using this ColumnModel will listen for this event and refresh its UI automatically.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Array<div class="sub-desc">Array of Column definition objects.</div></li><li><code>initial</code> : Boolean<div class="sub-desc">Specify <tt>true</tt> to bypass cleanup which deletes the <tt>totalWidth</tt>
305
and destroys existing editors.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setDataIndex"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setDataIndex">setDataIndex</a></b>( <code>Number col</code>, <code>String dataIndex</code> )
307
void<div class="mdesc"><div class="short">Sets the dataIndex for a column.</div><div class="long">Sets the dataIndex for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>dataIndex</code> : String<div class="sub-desc">The new dataIndex</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setEditable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setEditable">setEditable</a></b>( <code>Number col</code>, <code>Boolean editable</code> )
309
void<div class="mdesc"><div class="short">Sets if a column is editable.</div><div class="long">Sets if a column is editable.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>editable</code> : Boolean<div class="sub-desc">True if the column is editable</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setEditor"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setEditor">setEditor</a></b>( <code>Number col</code>, <code>Object editor</code> )
311
void<div class="mdesc"><div class="short">Sets the editor for a column and destroys the prior editor.</div><div class="long">Sets the editor for a column and destroys the prior editor.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>editor</code> : Object<div class="sub-desc">The editor object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setHidden"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setHidden">setHidden</a></b>( <code>Number colIndex</code>, <code>Boolean hidden</code> )
313
void<div class="mdesc"><div class="short">Sets if a column is hidden.
314
myGrid.getColumnModel().setHidden(0, true); // hide column 0 (0 = the first column).</div><div class="long">Sets if a column is hidden.
315
<pre><code>myGrid.getColumnModel().setHidden(0, true); <i>// hide column 0 (0 = the first column).</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>hidden</code> : Boolean<div class="sub-desc">True if the column is hidden</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setRenderer"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setRenderer">setRenderer</a></b>( <code>Number col</code>, <code>Function fn</code> )
317
void<div class="mdesc"><div class="short">Sets the rendering (formatting) function for a column. See Ext.util.Format for some
318
default formatting functions.</div><div class="long">Sets the rendering (formatting) function for a column. See <a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">Ext.util.Format</a> for some
319
default formatting functions.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>fn</code> : Function<div class="sub-desc">The function to use to process the cell's raw data
320
to return HTML markup for the grid view. The render function is called with
321
the following parameters:<ul>
322
<li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>
323
<li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
324
<li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
325
<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
326
(e.g. 'style="color:red;"').</p></li></ul></p></li>
327
<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>
328
<li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>
329
<li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
330
<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></ul></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>( <code>Boolean queueSuspended</code> )
332
void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
333
after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
335
void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.grid.ColumnModel-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-columnmoved"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-columnmoved">columnmoved</a></b> :
336
( <code>ColumnModel this</code>, <code>Number oldIndex</code>, <code>Number newIndex</code> )
337
<div class="mdesc"><div class="short">Fires when a column is moved.</div><div class="long">Fires when a column is moved.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>oldIndex</code> : Number<div class="sub-desc"></div></li><li><code>newIndex</code> : Number<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-configchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-configchange">configchange</a></b> :
338
( <code>ColumnModel this</code> )
339
<div class="mdesc"><div class="short">Fires when the configuration is changed</div><div class="long">Fires when the configuration is changed<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-headerchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-headerchange">headerchange</a></b> :
340
( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>String newText</code> )
341
<div class="mdesc"><div class="short">Fires when the text of a header changes.</div><div class="long">Fires when the text of a header changes.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>newText</code> : String<div class="sub-desc">The new header text</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-hiddenchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-hiddenchange">hiddenchange</a></b> :
342
( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Boolean hidden</code> )
343
<div class="mdesc"><div class="short">Fires when a column is hidden or "unhidden".</div><div class="long">Fires when a column is hidden or "unhidden".<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>hidden</code> : Boolean<div class="sub-desc">true if hidden, false otherwise</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-widthchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-widthchange">widthchange</a></b> :
344
( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Number newWidth</code> )
345
<div class="mdesc"><div class="short">Fires when the width of a column is programmaticially changed using
347
Note internal resizing suppresses...</div><div class="long">Fires when the width of a column is programmaticially changed using
348
<code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-setColumnWidth" ext:member="setColumnWidth" ext:cls="Ext.grid.ColumnModel">setColumnWidth</a></code>.
349
Note internal resizing suppresses the event from firing. See also
350
<a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel</a>.<code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-columnresize" ext:member="columnresize" ext:cls="Ext.grid.ColumnModel">columnresize</a></code>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>newWidth</code> : Number<div class="sub-desc">The new width</div></li></ul></div></div></div></td><td class="msource">ColumnModel</td></tr></tbody></table></div>
b'\\ No newline at end of file'
added
removed
webui/ecosystem/workspace/extjs/docs/output/Ext.grid.ColumnModel.html
