source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.grid.ColumnModel.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 69.3 KB
Line 
1        <div class="body-wrap">
2        <div class="top-tools">
3            <a class="inner-link" href="#Ext.grid.ColumnModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4            <a class="inner-link" href="#Ext.grid.ColumnModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5            <a class="inner-link" href="#Ext.grid.ColumnModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                            <a class="inner-link" href="#Ext.grid.ColumnModel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                        <a class="bookmark" href="../docs/?class=Ext.grid.ColumnModel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8        </div>
9                <div class="inheritance res-block">
10<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11  <img src="resources/elbow-end.gif"/>ColumnModel</pre></div>
12                <h1>Class Ext.grid.ColumnModel</h1>
13        <table cellspacing="0">
14            <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
15            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/ColumnModel.js" target="_blank">ColumnModel.js</a></td></tr>
16            <tr><td class="label">Class:</td><td class="hd-info">ColumnModel</td></tr>
17                        <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.grid.PropertyColumnModel" href="output/Ext.grid.PropertyColumnModel.html">PropertyColumnModel</a></td></tr>
18                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
19                    </table>
20        <div class="description">
21            *
22This is the default implementation of a ColumnModel used by the Grid. This class is initialized
23with an Array of column config objects.
24<br><br>
25An individual column's config object defines the header string, the <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a>
26field the column draws its data from, an optional rendering function to provide customized
27data formatting, and the ability to apply a CSS class to all cells in a column through its
28<a ext:cls="Ext.grid.ColumnModel" ext:member="id" href="output/Ext.grid.ColumnModel.html#id">id</a> config option.<br>
29<br>Usage:<br>
30<pre><code>var colModel = <b>new</b> Ext.grid.ColumnModel([
31    { header: <em>"Ticker"</em>, width: 60, sortable: true},
32    { header: <em>"Company Name"</em>, width: 150, sortable: true},
33    { header: <em>"Market Cap."</em>, width: 100, sortable: true},
34    { header: <em>"$ Sales"</em>, width: 100, sortable: true, renderer: money},
35    { header: <em>"Employees"</em>, width: 100, sortable: true, resizable: false}
36 ]);</code></pre>
37<p>
38The config options <b>defined by</b> this class are options which may appear in each
39individual column definition. In order to use configuration options from the superclass,
40specify the column configuration Array in the <tt><b>columns<b><tt> config property. eg:<pre><code>var colModel = <b>new</b> Ext.grid.ColumnModel({
41    listeners: {
42        widthchange: <b>function</b>(cm, colIndex, width) {
43            saveConfig(colIndex, width);
44        }
45    },
46    columns: [
47        { header: <em>"Ticker"</em>, width: 60, sortable: true},
48        { header: <em>"Company Name"</em>, width: 150, sortable: true},
49        { header: <em>"Market Cap."</em>, width: 100, sortable: true},
50        { header: <em>"$ Sales"</em>, width: 100, sortable: true, renderer: money},
51        { header: <em>"Employees"</em>, width: 100, sortable: true, resizable: false}
52     ]
53});</code></pre>        </div>
54       
55        <div class="hr"></div>
56                <a id="Ext.grid.ColumnModel-configs"></a>
57        <h2>Config Options</h2>
58        <table cellspacing="0" class="member-table">
59            <tr>
60                <th class="sig-header" colspan="2">Config Options</th>
61                <th class="msource-header">Defined By</th>
62            </tr>
63                <tr class="config-row">
64        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
65        <td class="sig">
66        <a id="Ext.grid.ColumnModel-align"></a>
67            <b>align</b> : String            <div class="mdesc">
68                            (optional) Set the CSS text-align property of the column. Defaults to undefined.                        </div>
69        </td>
70        <td class="msource">ColumnModel</td>
71    </tr>
72        <tr class="config-row alt">
73        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
74        <td class="sig">
75        <a id="Ext.grid.ColumnModel-css"></a>
76            <b>css</b> : String            <div class="mdesc">
77                            (optional) Set custom CSS for all table cells in the column (excluding headers). Defaults to undefined.                        </div>
78        </td>
79        <td class="msource">ColumnModel</td>
80    </tr>
81        <tr class="config-row expandable">
82        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
83        <td class="sig">
84        <a id="Ext.grid.ColumnModel-dataIndex"></a>
85            <b>dataIndex</b> : String            <div class="mdesc">
86                        <div class="short">(optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the col...</div>
87            <div class="long">
88                (optional) The name of the field in the grid's <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a>'s <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> definition from which to draw the column's value. If not specified, the column's index is used as an index into the Record's data Array.            </div>
89                        </div>
90        </td>
91        <td class="msource">ColumnModel</td>
92    </tr>
93        <tr class="config-row alt">
94        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
95        <td class="sig">
96        <a id="Ext.grid.ColumnModel-editor"></a>
97            <b>editor</b> : Ext.form.Field            <div class="mdesc">
98                            (optional) The <a ext:cls="Ext.form.Field" href="output/Ext.form.Field.html">Ext.form.Field</a> to use when editing values in this column if editing is supported by the grid.                        </div>
99        </td>
100        <td class="msource">ColumnModel</td>
101    </tr>
102        <tr class="config-row">
103        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
104        <td class="sig">
105        <a id="Ext.grid.ColumnModel-fixed"></a>
106            <b>fixed</b> : Boolean            <div class="mdesc">
107                            (optional) True if the column width cannot be changed. Defaults to false.                        </div>
108        </td>
109        <td class="msource">ColumnModel</td>
110    </tr>
111        <tr class="config-row alt">
112        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
113        <td class="sig">
114        <a id="Ext.grid.ColumnModel-header"></a>
115            <b>header</b> : String            <div class="mdesc">
116                            The header text to display in the Grid view.                        </div>
117        </td>
118        <td class="msource">ColumnModel</td>
119    </tr>
120        <tr class="config-row">
121        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
122        <td class="sig">
123        <a id="Ext.grid.ColumnModel-hidden"></a>
124            <b>hidden</b> : Boolean            <div class="mdesc">
125                            (optional) True to hide the column. Defaults to false.                        </div>
126        </td>
127        <td class="msource">ColumnModel</td>
128    </tr>
129        <tr class="config-row alt expandable">
130        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
131        <td class="sig">
132        <a id="Ext.grid.ColumnModel-hideable"></a>
133            <b>hideable</b> : Boolean            <div class="mdesc">
134                        <div class="short">(optional) Specify as false to prevent the user from hiding this column (defaults to true). To disallow column hiding...</div>
135            <div class="long">
136                (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 ext:cls="Ext.grid.GridPanel" ext:member="enableColumnHide" href="output/Ext.grid.GridPanel.html#enableColumnHide">Ext.grid.GridPanel.enableColumnHide</a> instead.            </div>
137                        </div>
138        </td>
139        <td class="msource">ColumnModel</td>
140    </tr>
141        <tr class="config-row expandable">
142        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
143        <td class="sig">
144        <a id="Ext.grid.ColumnModel-id"></a>
145            <b>id</b> : String            <div class="mdesc">
146                        <div class="short">(optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to ...</div>
147            <div class="long">
148                (optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to create a CSS class name which is applied to all table cells (including headers) in that column. The class name takes the form of <pre>x-grid3-td-<b>id</b></pre> <br><br> Header cells will also recieve this class name, but will also have the class <pr>x-grid3-hd</pre>, so to target header cells, use CSS selectors such as:<pre>.x-grid3-hd.x-grid3-td-<b>id</b></pre> The <a ext:cls="Ext.grid.GridPanel" ext:member="autoExpandColumn" href="output/Ext.grid.GridPanel.html#autoExpandColumn">Ext.grid.GridPanel.autoExpandColumn</a> grid config option references the column via this identifier.            </div>
149                        </div>
150        </td>
151        <td class="msource">ColumnModel</td>
152    </tr>
153        <tr class="config-row inherited alt expandable">
154        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
155        <td class="sig">
156        <a id="Ext.grid.ColumnModel-listeners"></a>
157            <b>listeners</b> : Object            <div class="mdesc">
158                        <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
159            <div class="long">
160                (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>
161                        </div>
162        </td>
163        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
164    </tr>
165        <tr class="config-row">
166        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
167        <td class="sig">
168        <a id="Ext.grid.ColumnModel-menuDisabled"></a>
169            <b>menuDisabled</b> : Boolean            <div class="mdesc">
170                            (optional) True to disable the column menu. Defaults to false.                        </div>
171        </td>
172        <td class="msource">ColumnModel</td>
173    </tr>
174        <tr class="config-row alt expandable">
175        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
176        <td class="sig">
177        <a id="Ext.grid.ColumnModel-renderer"></a>
178            <b>renderer</b> : Function            <div class="mdesc">
179                        <div class="short">(optional) A function used to generate HTML markup for a cell given the cell's data value. See setRenderer. If not sp...</div>
180            <div class="long">
181                (optional) A function used to generate HTML markup for a cell given the cell's data value. See <a ext:cls="Ext.grid.ColumnModel" ext:member="setRenderer" href="output/Ext.grid.ColumnModel.html#setRenderer">setRenderer</a>. If not specified, the default renderer uses the raw data value.            </div>
182                        </div>
183        </td>
184        <td class="msource">ColumnModel</td>
185    </tr>
186        <tr class="config-row">
187        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
188        <td class="sig">
189        <a id="Ext.grid.ColumnModel-resizable"></a>
190            <b>resizable</b> : Boolean            <div class="mdesc">
191                            (optional) False to disable column resizing. Defaults to true.                        </div>
192        </td>
193        <td class="msource">ColumnModel</td>
194    </tr>
195        <tr class="config-row alt expandable">
196        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
197        <td class="sig">
198        <a id="Ext.grid.ColumnModel-sortable"></a>
199            <b>sortable</b> : Boolean            <div class="mdesc">
200                        <div class="short">(optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Wh...</div>
201            <div class="long">
202                (optional) True if sorting is to be allowed on this column. Defaults to the value of the <a ext:cls="Ext.grid.ColumnModel" ext:member="defaultSortable" href="output/Ext.grid.ColumnModel.html#defaultSortable">defaultSortable</a> property. Whether local/remote sorting is used is specified in <a ext:cls="Ext.data.Store" ext:member="remoteSort" href="output/Ext.data.Store.html#remoteSort">Ext.data.Store.remoteSort</a>.            </div>
203                        </div>
204        </td>
205        <td class="msource">ColumnModel</td>
206    </tr>
207        <tr class="config-row expandable">
208        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
209        <td class="sig">
210        <a id="Ext.grid.ColumnModel-tooltip"></a>
211            <b>tooltip</b> : String            <div class="mdesc">
212                        <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>
213            <div class="long">
214                (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>
215                        </div>
216        </td>
217        <td class="msource">ColumnModel</td>
218    </tr>
219        <tr class="config-row alt expandable">
220        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
221        <td class="sig">
222        <a id="Ext.grid.ColumnModel-width"></a>
223            <b>width</b> : Number            <div class="mdesc">
224                        <div class="short">(optional) The initial width in pixels of the column. This is ignored if the Grid's view is configured with forceFit ...</div>
225            <div class="long">
226                (optional) The initial width in pixels of the column. This is ignored if the Grid's <a ext:cls="Ext.grid.GridView" href="output/Ext.grid.GridView.html">view</a> is configured with <a ext:cls="Ext.grid.GridView" ext:member="forceFit" href="output/Ext.grid.GridView.html#forceFit">forceFit</a> true.            </div>
227                        </div>
228        </td>
229        <td class="msource">ColumnModel</td>
230    </tr>
231            </table>
232                <a id="Ext.grid.ColumnModel-props"></a>
233        <h2>Public Properties</h2>
234                <table cellspacing="0" class="member-table">
235            <tr>
236                <th class="sig-header" colspan="2">Property</th>
237                <th class="msource-header">Defined By</th>
238            </tr>
239                <tr class="property-row">
240        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
241        <td class="sig">
242        <a id="Ext.grid.ColumnModel-defaultSortable"></a>
243            <b>defaultSortable</b> : Boolean            <div class="mdesc">
244                            Default sortable of columns which have no sortable specified (defaults to false)                        </div>
245        </td>
246        <td class="msource">ColumnModel</td>
247    </tr>
248        <tr class="property-row alt">
249        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
250        <td class="sig">
251        <a id="Ext.grid.ColumnModel-defaultWidth"></a>
252            <b>defaultWidth</b> : Number            <div class="mdesc">
253                            The width of columns which have no width specified (defaults to 100)                        </div>
254        </td>
255        <td class="msource">ColumnModel</td>
256    </tr>
257            </table>
258                <a id="Ext.grid.ColumnModel-methods"></a>
259        <h2>Public Methods</h2>
260                <table cellspacing="0" class="member-table">
261            <tr>
262                <th class="sig-header" colspan="2">Method</th>
263                <th class="msource-header">Defined By</th>
264            </tr>
265                <tr class="method-row expandable">
266        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
267        <td class="sig">
268        <a id="Ext.grid.ColumnModel-ColumnModel"></a>
269            <b>ColumnModel</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">
270                        <div class="short"></div>
271            <div class="long">
272                    <div class="mdetail-params">
273        <strong>Parameters:</strong>
274        <ul><li><code>config</code> : Object<div class="sub-desc">An Array of column config objects. See this class's
275config objects for details.</div></li>        </ul>
276        <strong>Returns:</strong>
277        <ul>
278            <li><code></code></li>
279        </ul>
280    </div>
281                </div>
282                        </div>
283        </td>
284        <td class="msource">ColumnModel</td>
285    </tr>
286        <tr class="method-row inherited alt expandable">
287        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
288        <td class="sig">
289        <a id="Ext.grid.ColumnModel-addEvents"></a>
290            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
291                        <div class="short">Used to define events on this Observable</div>
292            <div class="long">
293                Used to define events on this Observable    <div class="mdetail-params">
294        <strong>Parameters:</strong>
295        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
296        <strong>Returns:</strong>
297        <ul>
298            <li><code>void</code></li>
299        </ul>
300    </div>
301                </div>
302                        </div>
303        </td>
304        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
305    </tr>
306        <tr class="method-row inherited expandable">
307        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
308        <td class="sig">
309        <a id="Ext.grid.ColumnModel-addListener"></a>
310            <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
311                        <div class="short">Appends an event handler to this component</div>
312            <div class="long">
313                Appends an event handler to this component    <div class="mdetail-params">
314        <strong>Parameters:</strong>
315        <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 in which to execute the handler
316function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
317properties. This may contain any of the following properties:<ul>
318<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
319<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
320<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
321<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
322by the specified number of milliseconds. If the event fires again within that time, the original
323handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
324</ul><br>
325<p>
326<b>Combining Options</b><br>
327Using the options argument, it is possible to combine different types of listeners:<br>
328<br>
329A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
330<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
331    single: true,
332    delay: 100,
333    forumId: 4
334});</code></pre>
335<p>
336<b>Attaching multiple handlers in 1 call</b><br>
337The method also allows for a single argument to be passed which is a config object containing properties
338which specify multiple handlers.
339<p>
340<pre><code>foo.on({
341    <em>'click'</em> : {
342        fn: <b>this</b>.onClick,
343        scope: <b>this</b>,
344        delay: 100
345    },
346    <em>'mouseover'</em> : {
347        fn: <b>this</b>.onMouseOver,
348        scope: <b>this</b>
349    },
350    <em>'mouseout'</em> : {
351        fn: <b>this</b>.onMouseOut,
352        scope: <b>this</b>
353    }
354});</code></pre>
355<p>
356Or a shorthand syntax:<br>
357<pre><code>foo.on({
358    <em>'click'</em> : <b>this</b>.onClick,
359    <em>'mouseover'</em> : <b>this</b>.onMouseOver,
360    <em>'mouseout'</em> : <b>this</b>.onMouseOut,
361     scope: <b>this</b>
362});</code></pre></div></li>        </ul>
363        <strong>Returns:</strong>
364        <ul>
365            <li><code>void</code></li>
366        </ul>
367    </div>
368                </div>
369                        </div>
370        </td>
371        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
372    </tr>
373        <tr class="method-row alt expandable">
374        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
375        <td class="sig">
376        <a id="Ext.grid.ColumnModel-findColumnIndex"></a>
377            <b>findColumnIndex</b>(&nbsp;<code>String col</code>&nbsp;) : Number            <div class="mdesc">
378                        <div class="short">Finds the index of the first matching column for the given dataIndex.</div>
379            <div class="long">
380                Finds the index of the first matching column for the given dataIndex.    <div class="mdetail-params">
381        <strong>Parameters:</strong>
382        <ul><li><code>col</code> : String<div class="sub-desc">The dataIndex to find</div></li>        </ul>
383        <strong>Returns:</strong>
384        <ul>
385            <li><code>Number</code><div class="sub-desc">The column index, or -1 if no match was found</div></li>
386        </ul>
387    </div>
388                </div>
389                        </div>
390        </td>
391        <td class="msource">ColumnModel</td>
392    </tr>
393        <tr class="method-row inherited expandable">
394        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
395        <td class="sig">
396        <a id="Ext.grid.ColumnModel-fireEvent"></a>
397            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
398                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
399            <div class="long">
400                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
401        <strong>Parameters:</strong>
402        <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>
403        <strong>Returns:</strong>
404        <ul>
405            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
406        </ul>
407    </div>
408                </div>
409                        </div>
410        </td>
411        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
412    </tr>
413        <tr class="method-row alt expandable">
414        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
415        <td class="sig">
416        <a id="Ext.grid.ColumnModel-getCellEditor"></a>
417            <b>getCellEditor</b>(&nbsp;<code>Number colIndex</code>, <code>Number rowIndex</code>&nbsp;) : Ext.Editor            <div class="mdesc">
418                        <div class="short">Returns the editor defined for the cell/column.</div>
419            <div class="long">
420                Returns the editor defined for the cell/column.    <div class="mdetail-params">
421        <strong>Parameters:</strong>
422        <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>
423        <strong>Returns:</strong>
424        <ul>
425            <li><code>Ext.Editor</code><div class="sub-desc">The {@link Ext.Editor Editor} that was created to wrap the {@link Ext.form.Field Field} used to edit the cell.</div></li>
426        </ul>
427    </div>
428                </div>
429                        </div>
430        </td>
431        <td class="msource">ColumnModel</td>
432    </tr>
433        <tr class="method-row expandable">
434        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
435        <td class="sig">
436        <a id="Ext.grid.ColumnModel-getColumnById"></a>
437            <b>getColumnById</b>(&nbsp;<code>String id</code>&nbsp;) : Object            <div class="mdesc">
438                        <div class="short">Returns the column for a specified id.</div>
439            <div class="long">
440                Returns the column for a specified id.    <div class="mdetail-params">
441        <strong>Parameters:</strong>
442        <ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li>        </ul>
443        <strong>Returns:</strong>
444        <ul>
445            <li><code>Object</code><div class="sub-desc">the column</div></li>
446        </ul>
447    </div>
448                </div>
449                        </div>
450        </td>
451        <td class="msource">ColumnModel</td>
452    </tr>
453        <tr class="method-row alt expandable">
454        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
455        <td class="sig">
456        <a id="Ext.grid.ColumnModel-getColumnCount"></a>
457            <b>getColumnCount</b>(&nbsp;<code>Boolean visibleOnly</code>&nbsp;) : Number            <div class="mdesc">
458                        <div class="short">Returns the number of columns.</div>
459            <div class="long">
460                Returns the number of columns.    <div class="mdetail-params">
461        <strong>Parameters:</strong>
462        <ul><li><code>visibleOnly</code> : Boolean<div class="sub-desc">Optional. Pass as true to only include visible columns.</div></li>        </ul>
463        <strong>Returns:</strong>
464        <ul>
465            <li><code>Number</code></li>
466        </ul>
467    </div>
468                </div>
469                        </div>
470        </td>
471        <td class="msource">ColumnModel</td>
472    </tr>
473        <tr class="method-row expandable">
474        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
475        <td class="sig">
476        <a id="Ext.grid.ColumnModel-getColumnHeader"></a>
477            <b>getColumnHeader</b>(&nbsp;<code>Number col</code>&nbsp;) : String            <div class="mdesc">
478                        <div class="short">Returns the header for the specified column.</div>
479            <div class="long">
480                Returns the header for the specified column.    <div class="mdetail-params">
481        <strong>Parameters:</strong>
482        <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
483        <strong>Returns:</strong>
484        <ul>
485            <li><code>String</code></li>
486        </ul>
487    </div>
488                </div>
489                        </div>
490        </td>
491        <td class="msource">ColumnModel</td>
492    </tr>
493        <tr class="method-row alt expandable">
494        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
495        <td class="sig">
496        <a id="Ext.grid.ColumnModel-getColumnId"></a>
497            <b>getColumnId</b>(&nbsp;<code>Number index</code>&nbsp;) : String            <div class="mdesc">
498                        <div class="short">
499Returns the id of the column at the specified index.</div>
500            <div class="long">
501               
502Returns the id of the column at the specified index.    <div class="mdetail-params">
503        <strong>Parameters:</strong>
504        <ul><li><code>index</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
505        <strong>Returns:</strong>
506        <ul>
507            <li><code>String</code><div class="sub-desc">the id</div></li>
508        </ul>
509    </div>
510                </div>
511                        </div>
512        </td>
513        <td class="msource">ColumnModel</td>
514    </tr>
515        <tr class="method-row expandable">
516        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
517        <td class="sig">
518        <a id="Ext.grid.ColumnModel-getColumnTooltip"></a>
519            <b>getColumnTooltip</b>(&nbsp;<code>Number col</code>&nbsp;) : String            <div class="mdesc">
520                        <div class="short">Returns the tooltip for the specified column.</div>
521            <div class="long">
522                Returns the tooltip for the specified column.    <div class="mdetail-params">
523        <strong>Parameters:</strong>
524        <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
525        <strong>Returns:</strong>
526        <ul>
527            <li><code>String</code></li>
528        </ul>
529    </div>
530                </div>
531                        </div>
532        </td>
533        <td class="msource">ColumnModel</td>
534    </tr>
535        <tr class="method-row alt expandable">
536        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
537        <td class="sig">
538        <a id="Ext.grid.ColumnModel-getColumnWidth"></a>
539            <b>getColumnWidth</b>(&nbsp;<code>Number col</code>&nbsp;) : Number            <div class="mdesc">
540                        <div class="short">Returns the width for the specified column.</div>
541            <div class="long">
542                Returns the width for the specified column.    <div class="mdetail-params">
543        <strong>Parameters:</strong>
544        <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
545        <strong>Returns:</strong>
546        <ul>
547            <li><code>Number</code></li>
548        </ul>
549    </div>
550                </div>
551                        </div>
552        </td>
553        <td class="msource">ColumnModel</td>
554    </tr>
555        <tr class="method-row expandable">
556        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
557        <td class="sig">
558        <a id="Ext.grid.ColumnModel-getColumnsBy"></a>
559            <b>getColumnsBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : Array            <div class="mdesc">
560                        <div class="short">Returns the column configs that return true by the passed function that is called with (columnConfig, index)</div>
561            <div class="long">
562                Returns the column configs that return true by the passed function that is called with (columnConfig, index)    <div class="mdetail-params">
563        <strong>Parameters:</strong>
564        <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>
565        <strong>Returns:</strong>
566        <ul>
567            <li><code>Array</code><div class="sub-desc">result</div></li>
568        </ul>
569    </div>
570                </div>
571                        </div>
572        </td>
573        <td class="msource">ColumnModel</td>
574    </tr>
575        <tr class="method-row alt expandable">
576        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
577        <td class="sig">
578        <a id="Ext.grid.ColumnModel-getDataIndex"></a>
579            <b>getDataIndex</b>(&nbsp;<code>Number col</code>&nbsp;) : String            <div class="mdesc">
580                        <div class="short">Returns the dataIndex for the specified column.</div>
581            <div class="long">
582                Returns the dataIndex for the specified column.    <div class="mdetail-params">
583        <strong>Parameters:</strong>
584        <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
585        <strong>Returns:</strong>
586        <ul>
587            <li><code>String</code><div class="sub-desc">The column's dataIndex</div></li>
588        </ul>
589    </div>
590                </div>
591                        </div>
592        </td>
593        <td class="msource">ColumnModel</td>
594    </tr>
595        <tr class="method-row expandable">
596        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
597        <td class="sig">
598        <a id="Ext.grid.ColumnModel-getIndexById"></a>
599            <b>getIndexById</b>(&nbsp;<code>String id</code>&nbsp;) : Number            <div class="mdesc">
600                        <div class="short">Returns the index for a specified column id.</div>
601            <div class="long">
602                Returns the index for a specified column id.    <div class="mdetail-params">
603        <strong>Parameters:</strong>
604        <ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li>        </ul>
605        <strong>Returns:</strong>
606        <ul>
607            <li><code>Number</code><div class="sub-desc">the index, or -1 if not found</div></li>
608        </ul>
609    </div>
610                </div>
611                        </div>
612        </td>
613        <td class="msource">ColumnModel</td>
614    </tr>
615        <tr class="method-row alt expandable">
616        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
617        <td class="sig">
618        <a id="Ext.grid.ColumnModel-getRenderer"></a>
619            <b>getRenderer</b>(&nbsp;<code>Number col</code>&nbsp;) : Function            <div class="mdesc">
620                        <div class="short">Returns the rendering (formatting) function defined for the column.</div>
621            <div class="long">
622                Returns the rendering (formatting) function defined for the column.    <div class="mdetail-params">
623        <strong>Parameters:</strong>
624        <ul><li><code>col</code> : Number<div class="sub-desc">The column index.</div></li>        </ul>
625        <strong>Returns:</strong>
626        <ul>
627            <li><code>Function</code><div class="sub-desc">The function used to render the cell. See {@link #setRenderer}.</div></li>
628        </ul>
629    </div>
630                </div>
631                        </div>
632        </td>
633        <td class="msource">ColumnModel</td>
634    </tr>
635        <tr class="method-row expandable">
636        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
637        <td class="sig">
638        <a id="Ext.grid.ColumnModel-getTotalWidth"></a>
639            <b>getTotalWidth</b>(&nbsp;<code>Boolean includeHidden</code>&nbsp;) : Number            <div class="mdesc">
640                        <div class="short">Returns the total width of all columns.</div>
641            <div class="long">
642                Returns the total width of all columns.    <div class="mdetail-params">
643        <strong>Parameters:</strong>
644        <ul><li><code>includeHidden</code> : Boolean<div class="sub-desc">True to include hidden column widths</div></li>        </ul>
645        <strong>Returns:</strong>
646        <ul>
647            <li><code>Number</code></li>
648        </ul>
649    </div>
650                </div>
651                        </div>
652        </td>
653        <td class="msource">ColumnModel</td>
654    </tr>
655        <tr class="method-row inherited alt expandable">
656        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
657        <td class="sig">
658        <a id="Ext.grid.ColumnModel-hasListener"></a>
659            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
660                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
661            <div class="long">
662                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
663        <strong>Parameters:</strong>
664        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
665        <strong>Returns:</strong>
666        <ul>
667            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
668        </ul>
669    </div>
670                </div>
671                        </div>
672        </td>
673        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
674    </tr>
675        <tr class="method-row expandable">
676        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
677        <td class="sig">
678        <a id="Ext.grid.ColumnModel-isCellEditable"></a>
679            <b>isCellEditable</b>(&nbsp;<code>Number colIndex</code>, <code>Number rowIndex</code>&nbsp;) : Boolean            <div class="mdesc">
680                        <div class="short">Returns true if the cell is editable.</div>
681            <div class="long">
682                Returns true if the cell is editable.    <div class="mdetail-params">
683        <strong>Parameters:</strong>
684        <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>
685        <strong>Returns:</strong>
686        <ul>
687            <li><code>Boolean</code></li>
688        </ul>
689    </div>
690                </div>
691                        </div>
692        </td>
693        <td class="msource">ColumnModel</td>
694    </tr>
695        <tr class="method-row alt expandable">
696        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
697        <td class="sig">
698        <a id="Ext.grid.ColumnModel-isFixed"></a>
699            <b>isFixed</b>() : void            <div class="mdesc">
700                        <div class="short">Returns true if the column width cannot be changed</div>
701            <div class="long">
702                Returns true if the column width cannot be changed    <div class="mdetail-params">
703        <strong>Parameters:</strong>
704        <ul><li>None.</li>        </ul>
705        <strong>Returns:</strong>
706        <ul>
707            <li><code>void</code></li>
708        </ul>
709    </div>
710                </div>
711                        </div>
712        </td>
713        <td class="msource">ColumnModel</td>
714    </tr>
715        <tr class="method-row expandable">
716        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
717        <td class="sig">
718        <a id="Ext.grid.ColumnModel-isHidden"></a>
719            <b>isHidden</b>(&nbsp;<code>Number colIndex</code>&nbsp;) : Boolean            <div class="mdesc">
720                        <div class="short">Returns true if the column is hidden.</div>
721            <div class="long">
722                Returns true if the column is hidden.    <div class="mdetail-params">
723        <strong>Parameters:</strong>
724        <ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
725        <strong>Returns:</strong>
726        <ul>
727            <li><code>Boolean</code></li>
728        </ul>
729    </div>
730                </div>
731                        </div>
732        </td>
733        <td class="msource">ColumnModel</td>
734    </tr>
735        <tr class="method-row alt expandable">
736        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
737        <td class="sig">
738        <a id="Ext.grid.ColumnModel-isMenuDisabled"></a>
739            <b>isMenuDisabled</b>(&nbsp;<code>Number col</code>&nbsp;) : Boolean            <div class="mdesc">
740                        <div class="short">Returns true if the specified column menu is disabled.</div>
741            <div class="long">
742                Returns true if the specified column menu is disabled.    <div class="mdetail-params">
743        <strong>Parameters:</strong>
744        <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
745        <strong>Returns:</strong>
746        <ul>
747            <li><code>Boolean</code></li>
748        </ul>
749    </div>
750                </div>
751                        </div>
752        </td>
753        <td class="msource">ColumnModel</td>
754    </tr>
755        <tr class="method-row expandable">
756        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
757        <td class="sig">
758        <a id="Ext.grid.ColumnModel-isResizable"></a>
759            <b>isResizable</b>() : Boolean            <div class="mdesc">
760                        <div class="short">Returns true if the column can be resized</div>
761            <div class="long">
762                Returns true if the column can be resized    <div class="mdetail-params">
763        <strong>Parameters:</strong>
764        <ul><li>None.</li>        </ul>
765        <strong>Returns:</strong>
766        <ul>
767            <li><code>Boolean</code></li>
768        </ul>
769    </div>
770                </div>
771                        </div>
772        </td>
773        <td class="msource">ColumnModel</td>
774    </tr>
775        <tr class="method-row alt expandable">
776        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
777        <td class="sig">
778        <a id="Ext.grid.ColumnModel-isSortable"></a>
779            <b>isSortable</b>(&nbsp;<code>Number col</code>&nbsp;) : Boolean            <div class="mdesc">
780                        <div class="short">Returns true if the specified column is sortable.</div>
781            <div class="long">
782                Returns true if the specified column is sortable.    <div class="mdetail-params">
783        <strong>Parameters:</strong>
784        <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li>        </ul>
785        <strong>Returns:</strong>
786        <ul>
787            <li><code>Boolean</code></li>
788        </ul>
789    </div>
790                </div>
791                        </div>
792        </td>
793        <td class="msource">ColumnModel</td>
794    </tr>
795        <tr class="method-row expandable">
796        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
797        <td class="sig">
798        <a id="Ext.grid.ColumnModel-moveColumn"></a>
799            <b>moveColumn</b>(&nbsp;<code>Number oldIndex</code>, <code>Number newIndex</code>&nbsp;) : void            <div class="mdesc">
800                        <div class="short">Moves a column from one position to another.</div>
801            <div class="long">
802                Moves a column from one position to another.    <div class="mdetail-params">
803        <strong>Parameters:</strong>
804        <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>
805        <strong>Returns:</strong>
806        <ul>
807            <li><code>void</code></li>
808        </ul>
809    </div>
810                </div>
811                        </div>
812        </td>
813        <td class="msource">ColumnModel</td>
814    </tr>
815        <tr class="method-row inherited alt expandable">
816        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
817        <td class="sig">
818        <a id="Ext.grid.ColumnModel-on"></a>
819            <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
820                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
821            <div class="long">
822                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
823        <strong>Parameters:</strong>
824        <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 in which to execute the handler
825function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
826        <strong>Returns:</strong>
827        <ul>
828            <li><code>void</code></li>
829        </ul>
830    </div>
831                </div>
832                        </div>
833        </td>
834        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
835    </tr>
836        <tr class="method-row inherited expandable">
837        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
838        <td class="sig">
839        <a id="Ext.grid.ColumnModel-purgeListeners"></a>
840            <b>purgeListeners</b>() : void            <div class="mdesc">
841                        <div class="short">Removes all listeners for this object</div>
842            <div class="long">
843                Removes all listeners for this object    <div class="mdetail-params">
844        <strong>Parameters:</strong>
845        <ul><li>None.</li>        </ul>
846        <strong>Returns:</strong>
847        <ul>
848            <li><code>void</code></li>
849        </ul>
850    </div>
851                </div>
852                        </div>
853        </td>
854        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
855    </tr>
856        <tr class="method-row inherited alt expandable">
857        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
858        <td class="sig">
859        <a id="Ext.grid.ColumnModel-relayEvents"></a>
860            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
861                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
862            <div class="long">
863                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
864        <strong>Parameters:</strong>
865        <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>
866        <strong>Returns:</strong>
867        <ul>
868            <li><code>void</code></li>
869        </ul>
870    </div>
871                </div>
872                        </div>
873        </td>
874        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
875    </tr>
876        <tr class="method-row inherited expandable">
877        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
878        <td class="sig">
879        <a id="Ext.grid.ColumnModel-removeListener"></a>
880            <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
881                        <div class="short">Removes a listener</div>
882            <div class="long">
883                Removes a listener    <div class="mdetail-params">
884        <strong>Parameters:</strong>
885        <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
886        <strong>Returns:</strong>
887        <ul>
888            <li><code>void</code></li>
889        </ul>
890    </div>
891                </div>
892                        </div>
893        </td>
894        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
895    </tr>
896        <tr class="method-row inherited alt expandable">
897        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
898        <td class="sig">
899        <a id="Ext.grid.ColumnModel-resumeEvents"></a>
900            <b>resumeEvents</b>() : void            <div class="mdesc">
901                        <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
902            <div class="long">
903                Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">
904        <strong>Parameters:</strong>
905        <ul><li>None.</li>        </ul>
906        <strong>Returns:</strong>
907        <ul>
908            <li><code>void</code></li>
909        </ul>
910    </div>
911                </div>
912                        </div>
913        </td>
914        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
915    </tr>
916        <tr class="method-row expandable">
917        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
918        <td class="sig">
919        <a id="Ext.grid.ColumnModel-setColumnHeader"></a>
920            <b>setColumnHeader</b>(&nbsp;<code>Number col</code>, <code>String header</code>&nbsp;) : void            <div class="mdesc">
921                        <div class="short">Sets the header for a column.</div>
922            <div class="long">
923                Sets the header for a column.    <div class="mdetail-params">
924        <strong>Parameters:</strong>
925        <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>
926        <strong>Returns:</strong>
927        <ul>
928            <li><code>void</code></li>
929        </ul>
930    </div>
931                </div>
932                        </div>
933        </td>
934        <td class="msource">ColumnModel</td>
935    </tr>
936        <tr class="method-row alt expandable">
937        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
938        <td class="sig">
939        <a id="Ext.grid.ColumnModel-setColumnTooltip"></a>
940            <b>setColumnTooltip</b>(&nbsp;<code>Number col</code>, <code>String tooltip</code>&nbsp;) : void            <div class="mdesc">
941                        <div class="short">Sets the tooltip for a column.</div>
942            <div class="long">
943                Sets the tooltip for a column.    <div class="mdetail-params">
944        <strong>Parameters:</strong>
945        <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>
946        <strong>Returns:</strong>
947        <ul>
948            <li><code>void</code></li>
949        </ul>
950    </div>
951                </div>
952                        </div>
953        </td>
954        <td class="msource">ColumnModel</td>
955    </tr>
956        <tr class="method-row expandable">
957        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
958        <td class="sig">
959        <a id="Ext.grid.ColumnModel-setColumnWidth"></a>
960            <b>setColumnWidth</b>(&nbsp;<code>Number col</code>, <code>Number width</code>&nbsp;) : void            <div class="mdesc">
961                        <div class="short">Sets the width for a column.</div>
962            <div class="long">
963                Sets the width for a column.    <div class="mdetail-params">
964        <strong>Parameters:</strong>
965        <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>        </ul>
966        <strong>Returns:</strong>
967        <ul>
968            <li><code>void</code></li>
969        </ul>
970    </div>
971                </div>
972                        </div>
973        </td>
974        <td class="msource">ColumnModel</td>
975    </tr>
976        <tr class="method-row alt expandable">
977        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
978        <td class="sig">
979        <a id="Ext.grid.ColumnModel-setConfig"></a>
980            <b>setConfig</b>(&nbsp;<code>Array config</code>&nbsp;) : void            <div class="mdesc">
981                        <div class="short">Reconfigures this column model according to the passed Array of column definition objects. For a description of
982the i...</div>
983            <div class="long">
984                <p>Reconfigures this column model according to the passed Array of column definition objects. For a description of
985the individual properties of a column definition object, see the <a href="#Ext.grid.ColumnModel-configs">Config Options</a>.</p>
986<p>Causes the <a ext:cls="Ext.grid.ColumnModel" ext:member="configchange" href="output/Ext.grid.ColumnModel.html#configchange">configchange</a> event to be fired. A <a ext:cls="Ext.grid.GridPanel" href="output/Ext.grid.GridPanel.html">GridPanel</a> using
987this ColumnModel will listen for this event and refresh its UI automatically.</p>    <div class="mdetail-params">
988        <strong>Parameters:</strong>
989        <ul><li><code>config</code> : Array<div class="sub-desc">Array of Column definition objects.</div></li>        </ul>
990        <strong>Returns:</strong>
991        <ul>
992            <li><code>void</code></li>
993        </ul>
994    </div>
995                </div>
996                        </div>
997        </td>
998        <td class="msource">ColumnModel</td>
999    </tr>
1000        <tr class="method-row expandable">
1001        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1002        <td class="sig">
1003        <a id="Ext.grid.ColumnModel-setDataIndex"></a>
1004            <b>setDataIndex</b>(&nbsp;<code>Number col</code>, <code>String dataIndex</code>&nbsp;) : void            <div class="mdesc">
1005                        <div class="short">Sets the dataIndex for a column.</div>
1006            <div class="long">
1007                Sets the dataIndex for a column.    <div class="mdetail-params">
1008        <strong>Parameters:</strong>
1009        <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>
1010        <strong>Returns:</strong>
1011        <ul>
1012            <li><code>void</code></li>
1013        </ul>
1014    </div>
1015                </div>
1016                        </div>
1017        </td>
1018        <td class="msource">ColumnModel</td>
1019    </tr>
1020        <tr class="method-row alt expandable">
1021        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1022        <td class="sig">
1023        <a id="Ext.grid.ColumnModel-setEditable"></a>
1024            <b>setEditable</b>(&nbsp;<code>Number col</code>, <code>Boolean editable</code>&nbsp;) : void            <div class="mdesc">
1025                        <div class="short">Sets if a column is editable.</div>
1026            <div class="long">
1027                Sets if a column is editable.    <div class="mdetail-params">
1028        <strong>Parameters:</strong>
1029        <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>
1030        <strong>Returns:</strong>
1031        <ul>
1032            <li><code>void</code></li>
1033        </ul>
1034    </div>
1035                </div>
1036                        </div>
1037        </td>
1038        <td class="msource">ColumnModel</td>
1039    </tr>
1040        <tr class="method-row expandable">
1041        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1042        <td class="sig">
1043        <a id="Ext.grid.ColumnModel-setEditor"></a>
1044            <b>setEditor</b>(&nbsp;<code>Number col</code>, <code>Object editor</code>&nbsp;) : void            <div class="mdesc">
1045                        <div class="short">Sets the editor for a column.</div>
1046            <div class="long">
1047                Sets the editor for a column.    <div class="mdetail-params">
1048        <strong>Parameters:</strong>
1049        <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>
1050        <strong>Returns:</strong>
1051        <ul>
1052            <li><code>void</code></li>
1053        </ul>
1054    </div>
1055                </div>
1056                        </div>
1057        </td>
1058        <td class="msource">ColumnModel</td>
1059    </tr>
1060        <tr class="method-row alt expandable">
1061        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1062        <td class="sig">
1063        <a id="Ext.grid.ColumnModel-setHidden"></a>
1064            <b>setHidden</b>(&nbsp;<code>Number colIndex</code>, <code>Boolean hidden</code>&nbsp;) : void            <div class="mdesc">
1065                        <div class="short">Sets if a column is hidden.</div>
1066            <div class="long">
1067                Sets if a column is hidden.    <div class="mdetail-params">
1068        <strong>Parameters:</strong>
1069        <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>
1070        <strong>Returns:</strong>
1071        <ul>
1072            <li><code>void</code></li>
1073        </ul>
1074    </div>
1075                </div>
1076                        </div>
1077        </td>
1078        <td class="msource">ColumnModel</td>
1079    </tr>
1080        <tr class="method-row expandable">
1081        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1082        <td class="sig">
1083        <a id="Ext.grid.ColumnModel-setRenderer"></a>
1084            <b>setRenderer</b>(&nbsp;<code>Number col</code>, <code>Function fn</code>&nbsp;) : void            <div class="mdesc">
1085                        <div class="short">Sets the rendering (formatting) function for a column.  See <a ext:cls="Ext.util.Format" href="output/Ext.util.Format.html">Ext.util.Format</a> for some
1086default formatting functions.</div>
1087            <div class="long">
1088                Sets the rendering (formatting) function for a column.  See <a ext:cls="Ext.util.Format" href="output/Ext.util.Format.html">Ext.util.Format</a> for some
1089default formatting functions.    <div class="mdetail-params">
1090        <strong>Parameters:</strong>
1091        <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
1092to return HTML markup for the grid view. The render function is called with
1093the following parameters:<ul>
1094<li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>
1095<li><b>metadata</b> : Object<p class="sub-desc">An object in which you may set the following attributes:<ul>
1096<li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
1097<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
1098(e.g. 'style="color:red;"').</p></li></ul></p></li>
1099<li><b>record</b> : Ext.data.record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> from which the data was extracted.</p></li>
1100<li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>
1101<li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
1102<li><b>store</b> : Ext.data.Store<p class="sub-desc">The <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> object from which the Record was extracted.</p></li></ul></div></li>        </ul>
1103        <strong>Returns:</strong>
1104        <ul>
1105            <li><code>void</code></li>
1106        </ul>
1107    </div>
1108                </div>
1109                        </div>
1110        </td>
1111        <td class="msource">ColumnModel</td>
1112    </tr>
1113        <tr class="method-row inherited alt expandable">
1114        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1115        <td class="sig">
1116        <a id="Ext.grid.ColumnModel-suspendEvents"></a>
1117            <b>suspendEvents</b>() : void            <div class="mdesc">
1118                        <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
1119            <div class="long">
1120                Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">
1121        <strong>Parameters:</strong>
1122        <ul><li>None.</li>        </ul>
1123        <strong>Returns:</strong>
1124        <ul>
1125            <li><code>void</code></li>
1126        </ul>
1127    </div>
1128                </div>
1129                        </div>
1130        </td>
1131        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
1132    </tr>
1133        <tr class="method-row inherited expandable">
1134        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1135        <td class="sig">
1136        <a id="Ext.grid.ColumnModel-un"></a>
1137            <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
1138                        <div class="short">Removes a listener (shorthand for removeListener)</div>
1139            <div class="long">
1140                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
1141        <strong>Parameters:</strong>
1142        <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
1143        <strong>Returns:</strong>
1144        <ul>
1145            <li><code>void</code></li>
1146        </ul>
1147    </div>
1148                </div>
1149                        </div>
1150        </td>
1151        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
1152    </tr>
1153            </table>
1154                <a id="Ext.grid.ColumnModel-events"></a>
1155        <h2>Public Events</h2>
1156                <table cellspacing="0" class="member-table">
1157            <tr>
1158                <th class="sig-header" colspan="2">Event</th>
1159                <th class="msource-header">Defined By</th>
1160            </tr>
1161                <tr class="event-row expandable">
1162        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1163        <td class="sig">
1164        <a id="Ext.grid.ColumnModel-columnmoved"></a>
1165            <b>columnmoved</b> : (&nbsp;<code>ColumnModel this</code>, <code>Number oldIndex</code>, <code>Number newIndex</code>&nbsp;)            <div class="mdesc">
1166                        <div class="short">Fires when a column is moved.</div>
1167            <div class="long">
1168                Fires when a column is moved.    <div class="mdetail-params">
1169        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1170        <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>
1171    </div>
1172                </div>
1173                        </div>
1174        </td>
1175        <td class="msource">ColumnModel</td>
1176    </tr>
1177        <tr class="event-row alt expandable">
1178        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1179        <td class="sig">
1180        <a id="Ext.grid.ColumnModel-configchange"></a>
1181            <b>configchange</b> : (&nbsp;<code>ColumnModel this</code>&nbsp;)            <div class="mdesc">
1182                        <div class="short">Fires when the configuration is changed</div>
1183            <div class="long">
1184                Fires when the configuration is changed    <div class="mdetail-params">
1185        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1186        <ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li>        </ul>
1187    </div>
1188                </div>
1189                        </div>
1190        </td>
1191        <td class="msource">ColumnModel</td>
1192    </tr>
1193        <tr class="event-row expandable">
1194        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1195        <td class="sig">
1196        <a id="Ext.grid.ColumnModel-headerchange"></a>
1197            <b>headerchange</b> : (&nbsp;<code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>String newText</code>&nbsp;)            <div class="mdesc">
1198                        <div class="short">Fires when the text of a header changes.</div>
1199            <div class="long">
1200                Fires when the text of a header changes.    <div class="mdetail-params">
1201        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1202        <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>
1203    </div>
1204                </div>
1205                        </div>
1206        </td>
1207        <td class="msource">ColumnModel</td>
1208    </tr>
1209        <tr class="event-row alt expandable">
1210        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1211        <td class="sig">
1212        <a id="Ext.grid.ColumnModel-hiddenchange"></a>
1213            <b>hiddenchange</b> : (&nbsp;<code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Boolean hidden</code>&nbsp;)            <div class="mdesc">
1214                        <div class="short">Fires when a column is hidden or "unhidden".</div>
1215            <div class="long">
1216                Fires when a column is hidden or "unhidden".    <div class="mdetail-params">
1217        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1218        <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>
1219    </div>
1220                </div>
1221                        </div>
1222        </td>
1223        <td class="msource">ColumnModel</td>
1224    </tr>
1225        <tr class="event-row expandable">
1226        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1227        <td class="sig">
1228        <a id="Ext.grid.ColumnModel-widthchange"></a>
1229            <b>widthchange</b> : (&nbsp;<code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Number newWidth</code>&nbsp;)            <div class="mdesc">
1230                        <div class="short">Fires when the width of a column changes.</div>
1231            <div class="long">
1232                Fires when the width of a column changes.    <div class="mdetail-params">
1233        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
1234        <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>
1235    </div>
1236                </div>
1237                        </div>
1238        </td>
1239        <td class="msource">ColumnModel</td>
1240    </tr>
1241            </table>
1242       
1243        </div>
Note: See TracBrowser for help on using the repository browser.