1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.grid.ColumnModel</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.grid.ColumnModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.grid.ColumnModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.grid.ColumnModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.grid.ColumnModel-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.ColumnModel
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.grid.ColumnModel
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_grid_ColumnModel.js.html">Roo/grid/ColumnModel.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">ColumnModel</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 This is the default implementation of a ColumnModel used by the Grid. It defines<br/>the columns in the grid.<br/><br>Usage:<br><br/> <pre><code><br/> var colModel = new Roo.grid.ColumnModel([<br/> {header: "Ticker", width: 60, sortable: true, locked: true},<br/> {header: "Company Name", width: 150, sortable: true},<br/> {header: "Market Cap.", width: 100, sortable: true},<br/> {header: "$ Sales", width: 100, sortable: true, renderer: money},<br/> {header: "Employees", width: 100, sortable: true, resizable: false}<br/> ]);<br/> </code></pre><br/><p><br/>The config options listed for this class are options which may appear in each<br/>individual column definition.<br/><br/>RooJS Fix - column id's are not sequential but use Roo.id() - fixes bugs with layouts.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.ColumnModel';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.grid.ColumnModel.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.grid.ColumnModel-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.grid.ColumnModel-cfg-align" name=".align"></a>
132 <div class="fixedFont">
133 <b class="itemname">align</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">(Optional) Set the CSS text-align property of the column.</div>
143 <div class="long">(Optional) Set the CSS text-align property of the column. Defaults to undefined.</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.grid.ColumnModel-cfg-dataIndex" name=".dataIndex"></a>
162 <div class="fixedFont">
163 <b class="itemname">dataIndex</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
169 <div class="short">(Optional) The name of the field in the grid's {<b>link</b> Roo.data.Store}'s<br/>{<b>link</b> Roo.data.Record} definition from which to draw the column's value.</div>
173 <div class="long">(Optional) The name of the field in the grid's {<b>link</b> Roo.data.Store}'s<br/>{<b>link</b> Roo.data.Record} definition from which to draw the column's value. If not<br/>specified, the column's index is used as an index into the Record's data Array.</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.grid.ColumnModel-cfg-editor" name=".editor"></a>
192 <div class="fixedFont">
193 <b class="itemname">editor</b> : <a href="./Roo.grid.GridEditor.html#constructor" roo:cls="Roo.grid.GridEditor.html#constructor">Roo.grid.GridEditor</a>
199 <div class="short">(Optional) For grid editors - returns the grid editor</div>
203 <div class="long">(Optional) For grid editors - returns the grid editor</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.grid.ColumnModel-cfg-fixed" name=".fixed"></a>
222 <div class="fixedFont">
223 <b class="itemname">fixed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
229 <div class="short">(Optional) True if the column width cannot be changed.</div>
233 <div class="long">(Optional) True if the column width cannot be changed. Defaults to false.</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.grid.ColumnModel-cfg-header" name=".header"></a>
252 <div class="fixedFont">
253 <b class="itemname">header</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">The header text to display in the Grid view.</div>
263 <div class="long">The header text to display in the Grid view.</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.grid.ColumnModel-cfg-hidden" name=".hidden"></a>
282 <div class="fixedFont">
283 <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
289 <div class="short">(Optional) True to hide the column.</div>
293 <div class="long">(Optional) True to hide the column. Defaults to false.</div>
307 <tr class="config-row expandable config-row-alt0">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
312 <div class="fixedFont">
313 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
319 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
323 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
331 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.grid.ColumnModel-cfg-locked" name=".locked"></a>
342 <div class="fixedFont">
343 <b class="itemname">locked</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
349 <div class="short">(Optional) True to lock the column in place while scrolling the Grid.</div>
353 <div class="long">(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.</div>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.grid.ColumnModel-cfg-renderer" name=".renderer"></a>
372 <div class="fixedFont">
373 <b class="itemname">renderer</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
379 <div class="short">(Optional) A function used to generate HTML markup for a cell<br/>given the cell's data value.</div>
383 <div class="long">(Optional) A function used to generate HTML markup for a cell<br/>given the cell's data value. See {<b>link</b> <b>setRenderer</b>}. If not specified, the<br/>default renderer uses the raw data value.</div>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.grid.ColumnModel-cfg-resizable" name=".resizable"></a>
402 <div class="fixedFont">
403 <b class="itemname">resizable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
409 <div class="short">(Optional) False to disable column resizing.</div>
413 <div class="long">(Optional) False to disable column resizing. Defaults to true.</div>
427 <tr class="config-row expandable config-row-alt0 notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.grid.ColumnModel-cfg-sortable" name=".sortable"></a>
432 <div class="fixedFont">
433 <b class="itemname">sortable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
439 <div class="short">(Optional) True if sorting is to be allowed on this column.</div>
443 <div class="long">(Optional) True if sorting is to be allowed on this column.<br/>Defaults to the value of the {<b>link</b> <b>defaultSortable</b>} property.<br/>Whether local/remote sorting is used is specified in {<b>link</b> Roo.data.Store<b>remoteSort</b>}.</div>
457 <tr class="config-row expandable config-row-alt1 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.grid.ColumnModel-cfg-width" name=".width"></a>
462 <div class="fixedFont">
463 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
469 <div class="short">(Optional) The initial width in pixels of the column.</div>
473 <div class="long">(Optional) The initial width in pixels of the column. Using this<br/>instead of {<b>link</b> Roo.grid.Grid<b>autoSizeColumns</b>} is more efficient.</div>
497 <!-- ============================== public properties ==================== -->
501 <a id="Roo.grid.ColumnModel-props"></a>
507 <table cellspacing="0" class="member-table">
508 <caption class="Empty">Public Properties - Has None</caption>
514 <!-- ============================== methods summary / details ======================== -->
517 <a id="Roo.grid.ColumnModel-methods"></a>
518 <!-- constructor?? -->
525 <!-- then dynamics first -->
532 <table cellspacing="0" class="member-table">
533 <caption>Public Methods</caption>
535 <th class="sig-header" colspan="2">Method</th>
536 <th class="msource-header">Defined By</th>
546 <tr class="method-row config-row-alt0 expandable notInherited">
547 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.grid-method-ColumnModel" name=".ColumnModel"></a>
552 <div class="fixedFont">
553 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">ColumnModel</b>
555 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
563 <div class="short">Create a new Roo.grid.ColumnModel</div>
570 Create a new Roo.grid.ColumnModel
573 <dl class="detailList">
574 <dt class="heading">Parameters:</dt>
577 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
580 <dd>An Array of column config objects. See this class's<br/>config objects for details.</dd>
604 <tr class="method-row config-row-alt1 expandable">
605 <td class="micon"><a class="exi" href="#expand"> </a></td>
609 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
610 <div class="fixedFont">
611 <span class="attributes"></span><b class="itemname">addEvents</b>
613 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
620 <div class="short">Used to define events on this Observable</div>
626 Used to define events on this Observable
633 <dl class="detailList">
634 <dt class="heading">Parameters:</dt>
637 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
640 <dd>The object with the events defined</dd>
660 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
666 <tr class="method-row config-row-alt0 expandable">
667 <td class="micon"><a class="exi" href="#expand"> </a></td>
671 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
672 <div class="fixedFont">
673 <span class="attributes"></span><b class="itemname">addListener</b>
675 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
682 <div class="short">Appends an event handler to this component</div>
688 Appends an event handler to this component
695 <dl class="detailList">
696 <dt class="heading">Parameters:</dt>
699 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
702 <dd>The type of event to listen for</dd>
705 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
708 <dd>The method the event invokes</dd>
711 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
714 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
717 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
720 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
740 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
746 <tr class="method-row config-row-alt1 expandable notInherited">
747 <td class="micon"><a class="exi" href="#expand"> </a></td>
751 <a id="Roo.grid.ColumnModel-method-findColumnIndex" name=".findColumnIndex"></a>
752 <div class="fixedFont">
753 <span class="attributes"></span><b class="itemname">findColumnIndex</b>
755 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>)
761 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
770 <div class="short">Returns the index for a specified column dataIndex.</div>
776 Returns the index for a specified column dataIndex.
783 <dl class="detailList">
784 <dt class="heading">Parameters:</dt>
787 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
790 <dd>The column dataIndex</dd>
798 <dl class="detailList">
799 <dt class="heading">Returns:</dt>
801 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> the index, or -1 if not found</dd>
823 <tr class="method-row config-row-alt0 expandable">
824 <td class="micon"><a class="exi" href="#expand"> </a></td>
828 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
829 <div class="fixedFont">
830 <span class="attributes"></span><b class="itemname">fireEvent</b>
832 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
838 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
847 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
853 Fires the specified event with the passed parameters (minus the event name).
860 <dl class="detailList">
861 <dt class="heading">Parameters:</dt>
864 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
870 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
873 <dd>Variable number of parameters are passed to handlers</dd>
881 <dl class="detailList">
882 <dt class="heading">Returns:</dt>
884 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
900 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
906 <tr class="method-row config-row-alt1 expandable notInherited">
907 <td class="micon"><a class="exi" href="#expand"> </a></td>
911 <a id="Roo.grid.ColumnModel-method-getCellEditor" name=".getCellEditor"></a>
912 <div class="fixedFont">
913 <span class="attributes"></span><b class="itemname">getCellEditor</b>
915 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>)
921 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
930 <div class="short">Returns the editor defined for the cell/column.</div>
936 Returns the editor defined for the cell/column.<br/>return false or null to disable editing.
943 <dl class="detailList">
944 <dt class="heading">Parameters:</dt>
947 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
950 <dd>The column index</dd>
953 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
956 <dd>The row index</dd>
964 <dl class="detailList">
965 <dt class="heading">Returns:</dt>
967 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
989 <tr class="method-row config-row-alt0 expandable notInherited">
990 <td class="micon"><a class="exi" href="#expand"> </a></td>
994 <a id="Roo.grid.ColumnModel-method-getColumnByDataIndex" name=".getColumnByDataIndex"></a>
995 <div class="fixedFont">
996 <span class="attributes"></span><b class="itemname">getColumnByDataIndex</b>
998 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>)
1004 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>|<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1013 <div class="short">Returns the column for a specified dataIndex.</div>
1019 Returns the column for a specified dataIndex.
1026 <dl class="detailList">
1027 <dt class="heading">Parameters:</dt>
1030 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
1033 <dd>The column dataIndex</dd>
1041 <dl class="detailList">
1042 <dt class="heading">Returns:</dt>
1044 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>|<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> the column or false if not found</dd>
1058 <td class="msource">
1060 Roo.grid.ColumnModel
1066 <tr class="method-row config-row-alt1 expandable notInherited">
1067 <td class="micon"><a class="exi" href="#expand"> </a></td>
1071 <a id="Roo.grid.ColumnModel-method-getColumnById" name=".getColumnById"></a>
1072 <div class="fixedFont">
1073 <span class="attributes"></span><b class="itemname">getColumnById</b>
1075 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1081 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1090 <div class="short">Returns the column for a specified id.</div>
1096 Returns the column for a specified id.
1103 <dl class="detailList">
1104 <dt class="heading">Parameters:</dt>
1107 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1110 <dd>The column id</dd>
1118 <dl class="detailList">
1119 <dt class="heading">Returns:</dt>
1121 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> the column</dd>
1135 <td class="msource">
1137 Roo.grid.ColumnModel
1143 <tr class="method-row config-row-alt0 expandable notInherited">
1144 <td class="micon"><a class="exi" href="#expand"> </a></td>
1148 <a id="Roo.grid.ColumnModel-method-getColumnCount" name=".getColumnCount"></a>
1149 <div class="fixedFont">
1150 <span class="attributes"></span><b class="itemname">getColumnCount</b>
1158 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1167 <div class="short">Returns the number of columns.</div>
1173 Returns the number of columns.
1184 <dl class="detailList">
1185 <dt class="heading">Returns:</dt>
1187 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1201 <td class="msource">
1203 Roo.grid.ColumnModel
1209 <tr class="method-row config-row-alt1 expandable notInherited">
1210 <td class="micon"><a class="exi" href="#expand"> </a></td>
1214 <a id="Roo.grid.ColumnModel-method-getColumnHeader" name=".getColumnHeader"></a>
1215 <div class="fixedFont">
1216 <span class="attributes"></span><b class="itemname">getColumnHeader</b>
1218 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1224 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1233 <div class="short">Returns the header for the specified column.</div>
1239 Returns the header for the specified column.
1246 <dl class="detailList">
1247 <dt class="heading">Parameters:</dt>
1250 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1253 <dd>The column index</dd>
1261 <dl class="detailList">
1262 <dt class="heading">Returns:</dt>
1264 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1278 <td class="msource">
1280 Roo.grid.ColumnModel
1286 <tr class="method-row config-row-alt0 expandable notInherited">
1287 <td class="micon"><a class="exi" href="#expand"> </a></td>
1291 <a id="Roo.grid.ColumnModel-method-getColumnId" name=".getColumnId"></a>
1292 <div class="fixedFont">
1293 <span class="attributes"></span><b class="itemname">getColumnId</b>
1295 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1301 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1310 <div class="short">Returns the id of the column at the specified index.</div>
1316 Returns the id of the column at the specified index.
1323 <dl class="detailList">
1324 <dt class="heading">Parameters:</dt>
1327 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1330 <dd>The column index</dd>
1338 <dl class="detailList">
1339 <dt class="heading">Returns:</dt>
1341 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> the id</dd>
1355 <td class="msource">
1357 Roo.grid.ColumnModel
1363 <tr class="method-row config-row-alt1 expandable notInherited">
1364 <td class="micon"><a class="exi" href="#expand"> </a></td>
1368 <a id="Roo.grid.ColumnModel-method-getColumnTooltip" name=".getColumnTooltip"></a>
1369 <div class="fixedFont">
1370 <span class="attributes"></span><b class="itemname">getColumnTooltip</b>
1372 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1378 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1387 <div class="short">Returns the tooltip for the specified column.</div>
1393 Returns the tooltip for the specified column.
1400 <dl class="detailList">
1401 <dt class="heading">Parameters:</dt>
1404 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1407 <dd>The column index</dd>
1415 <dl class="detailList">
1416 <dt class="heading">Returns:</dt>
1418 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1432 <td class="msource">
1434 Roo.grid.ColumnModel
1440 <tr class="method-row config-row-alt0 expandable notInherited">
1441 <td class="micon"><a class="exi" href="#expand"> </a></td>
1445 <a id="Roo.grid.ColumnModel-method-getColumnWidth" name=".getColumnWidth"></a>
1446 <div class="fixedFont">
1447 <span class="attributes"></span><b class="itemname">getColumnWidth</b>
1449 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1455 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1464 <div class="short">Returns the width for the specified column.</div>
1470 Returns the width for the specified column.
1477 <dl class="detailList">
1478 <dt class="heading">Parameters:</dt>
1481 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1484 <dd>The column index</dd>
1492 <dl class="detailList">
1493 <dt class="heading">Returns:</dt>
1495 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1509 <td class="msource">
1511 Roo.grid.ColumnModel
1517 <tr class="method-row config-row-alt1 expandable notInherited">
1518 <td class="micon"><a class="exi" href="#expand"> </a></td>
1522 <a id="Roo.grid.ColumnModel-method-getColumnsBy" name=".getColumnsBy"></a>
1523 <div class="fixedFont">
1524 <span class="attributes"></span><b class="itemname">getColumnsBy</b>
1526 (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1532 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1541 <div class="short">Returns the column configs that return true by the passed function that is called with (columnConfig, index)</div>
1547 Returns the column configs that return true by the passed function that is called with (columnConfig, index)
1554 <dl class="detailList">
1555 <dt class="heading">Parameters:</dt>
1558 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1564 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1575 <dl class="detailList">
1576 <dt class="heading">Returns:</dt>
1578 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> result</dd>
1592 <td class="msource">
1594 Roo.grid.ColumnModel
1600 <tr class="method-row config-row-alt0 expandable notInherited">
1601 <td class="micon"><a class="exi" href="#expand"> </a></td>
1605 <a id="Roo.grid.ColumnModel-method-getDataIndex" name=".getDataIndex"></a>
1606 <div class="fixedFont">
1607 <span class="attributes"></span><b class="itemname">getDataIndex</b>
1609 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1615 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1624 <div class="short">Returns the dataIndex for the specified column.</div>
1630 Returns the dataIndex for the specified column.
1637 <dl class="detailList">
1638 <dt class="heading">Parameters:</dt>
1641 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1644 <dd>The column index</dd>
1652 <dl class="detailList">
1653 <dt class="heading">Returns:</dt>
1655 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1669 <td class="msource">
1671 Roo.grid.ColumnModel
1677 <tr class="method-row config-row-alt1 expandable notInherited">
1678 <td class="micon"><a class="exi" href="#expand"> </a></td>
1682 <a id="Roo.grid.ColumnModel-method-getIndexById" name=".getIndexById"></a>
1683 <div class="fixedFont">
1684 <span class="attributes"></span><b class="itemname">getIndexById</b>
1686 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1692 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1701 <div class="short">Returns the index for a specified column id.</div>
1707 Returns the index for a specified column id.
1714 <dl class="detailList">
1715 <dt class="heading">Parameters:</dt>
1718 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1721 <dd>The column id</dd>
1729 <dl class="detailList">
1730 <dt class="heading">Returns:</dt>
1732 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> the index, or -1 if not found</dd>
1746 <td class="msource">
1748 Roo.grid.ColumnModel
1754 <tr class="method-row config-row-alt0 expandable notInherited">
1755 <td class="micon"><a class="exi" href="#expand"> </a></td>
1759 <a id="Roo.grid.ColumnModel-method-getRenderer" name=".getRenderer"></a>
1760 <div class="fixedFont">
1761 <span class="attributes"></span><b class="itemname">getRenderer</b>
1763 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1769 <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
1778 <div class="short">Returns the rendering (formatting) function defined for the column.</div>
1784 Returns the rendering (formatting) function defined for the column.
1791 <dl class="detailList">
1792 <dt class="heading">Parameters:</dt>
1795 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1798 <dd>The column index.</dd>
1806 <dl class="detailList">
1807 <dt class="heading">Returns:</dt>
1809 <dd><span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> The function used to render the cell. See {<b>link</b> <b>setRenderer</b>}.</dd>
1823 <td class="msource">
1825 Roo.grid.ColumnModel
1831 <tr class="method-row config-row-alt1 expandable notInherited">
1832 <td class="micon"><a class="exi" href="#expand"> </a></td>
1836 <a id="Roo.grid.ColumnModel-method-getTotalWidth" name=".getTotalWidth"></a>
1837 <div class="fixedFont">
1838 <span class="attributes"></span><b class="itemname">getTotalWidth</b>
1840 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>includeHidden</i></B>)
1846 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1855 <div class="short">Returns the total width of all columns.</div>
1861 Returns the total width of all columns.
1868 <dl class="detailList">
1869 <dt class="heading">Parameters:</dt>
1872 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>includeHidden</b>
1875 <dd>True to include hidden column widths</dd>
1883 <dl class="detailList">
1884 <dt class="heading">Returns:</dt>
1886 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1900 <td class="msource">
1902 Roo.grid.ColumnModel
1908 <tr class="method-row config-row-alt0 expandable">
1909 <td class="micon"><a class="exi" href="#expand"> </a></td>
1913 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1914 <div class="fixedFont">
1915 <span class="attributes"></span><b class="itemname">hasListener</b>
1917 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1923 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1932 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1938 Checks to see if this object has any listeners for a specified event
1945 <dl class="detailList">
1946 <dt class="heading">Parameters:</dt>
1949 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1952 <dd>The name of the event to check for</dd>
1960 <dl class="detailList">
1961 <dt class="heading">Returns:</dt>
1963 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1977 <td class="msource">
1979 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1985 <tr class="method-row config-row-alt1 expandable notInherited">
1986 <td class="micon"><a class="exi" href="#expand"> </a></td>
1990 <a id="Roo.grid.ColumnModel-method-isCellEditable" name=".isCellEditable"></a>
1991 <div class="fixedFont">
1992 <span class="attributes"></span><b class="itemname">isCellEditable</b>
1994 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>)
2000 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2009 <div class="short">Returns true if the cell is editable.</div>
2015 Returns true if the cell is editable.
2022 <dl class="detailList">
2023 <dt class="heading">Parameters:</dt>
2026 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
2029 <dd>The column index</dd>
2032 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2035 <dd>The row index</dd>
2043 <dl class="detailList">
2044 <dt class="heading">Returns:</dt>
2046 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2060 <td class="msource">
2062 Roo.grid.ColumnModel
2068 <tr class="method-row config-row-alt0 expandable notInherited">
2069 <td class="micon"><a class="exi" href="#expand"> </a></td>
2073 <a id="Roo.grid.ColumnModel-method-isFixed" name=".isFixed"></a>
2074 <div class="fixedFont">
2075 <span class="attributes"></span><b class="itemname">isFixed</b>
2084 <div class="short">Returns true if the column width cannot be changed</div>
2090 Returns true if the column width cannot be changed
2111 <td class="msource">
2113 Roo.grid.ColumnModel
2119 <tr class="method-row config-row-alt1 expandable notInherited">
2120 <td class="micon"><a class="exi" href="#expand"> </a></td>
2124 <a id="Roo.grid.ColumnModel-method-isHidden" name=".isHidden"></a>
2125 <div class="fixedFont">
2126 <span class="attributes"></span><b class="itemname">isHidden</b>
2128 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>)
2134 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2143 <div class="short">Returns true if the column is hidden.</div>
2149 Returns true if the column is hidden.
2156 <dl class="detailList">
2157 <dt class="heading">Parameters:</dt>
2160 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
2163 <dd>The column index</dd>
2171 <dl class="detailList">
2172 <dt class="heading">Returns:</dt>
2174 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2188 <td class="msource">
2190 Roo.grid.ColumnModel
2196 <tr class="method-row config-row-alt0 expandable notInherited">
2197 <td class="micon"><a class="exi" href="#expand"> </a></td>
2201 <a id="Roo.grid.ColumnModel-method-isResizable" name=".isResizable"></a>
2202 <div class="fixedFont">
2203 <span class="attributes"></span><b class="itemname">isResizable</b>
2211 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2220 <div class="short">Returns true if the column can be resized</div>
2226 Returns true if the column can be resized
2237 <dl class="detailList">
2238 <dt class="heading">Returns:</dt>
2240 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2254 <td class="msource">
2256 Roo.grid.ColumnModel
2262 <tr class="method-row config-row-alt1 expandable notInherited">
2263 <td class="micon"><a class="exi" href="#expand"> </a></td>
2267 <a id="Roo.grid.ColumnModel-method-isSortable" name=".isSortable"></a>
2268 <div class="fixedFont">
2269 <span class="attributes"></span><b class="itemname">isSortable</b>
2271 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
2277 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2286 <div class="short">Returns true if the specified column is sortable.</div>
2292 Returns true if the specified column is sortable.
2299 <dl class="detailList">
2300 <dt class="heading">Parameters:</dt>
2303 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2306 <dd>The column index</dd>
2314 <dl class="detailList">
2315 <dt class="heading">Returns:</dt>
2317 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2331 <td class="msource">
2333 Roo.grid.ColumnModel
2339 <tr class="method-row config-row-alt0 expandable">
2340 <td class="micon"><a class="exi" href="#expand"> </a></td>
2344 <a id="Roo.util.Observable-method-on" name=".on"></a>
2345 <div class="fixedFont">
2346 <span class="attributes"></span><b class="itemname">on</b>
2348 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2355 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2361 Appends an event handler to this element (shorthand for addListener)
2368 <dl class="detailList">
2369 <dt class="heading">Parameters:</dt>
2372 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2375 <dd>The type of event to listen for</dd>
2378 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2381 <dd>The method the event invokes</dd>
2384 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2387 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2390 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
2411 <td class="msource">
2413 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2419 <tr class="method-row config-row-alt1 expandable">
2420 <td class="micon"><a class="exi" href="#expand"> </a></td>
2424 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2425 <div class="fixedFont">
2426 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2435 <div class="short">Removes all listeners for this object</div>
2441 Removes all listeners for this object
2462 <td class="msource">
2464 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2470 <tr class="method-row config-row-alt0 expandable">
2471 <td class="micon"><a class="exi" href="#expand"> </a></td>
2475 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2476 <div class="fixedFont">
2477 <span class="attributes"></span><b class="itemname">removeListener</b>
2479 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2486 <div class="short">Removes a listener</div>
2499 <dl class="detailList">
2500 <dt class="heading">Parameters:</dt>
2503 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2506 <dd>The type of event to listen for</dd>
2509 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2512 <dd>The handler to remove</dd>
2515 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2518 <dd>(optional) The scope (this object) for the handler</dd>
2536 <td class="msource">
2538 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2544 <tr class="method-row config-row-alt1 expandable notInherited">
2545 <td class="micon"><a class="exi" href="#expand"> </a></td>
2549 <a id="Roo.grid.ColumnModel-method-setColumnHeader" name=".setColumnHeader"></a>
2550 <div class="fixedFont">
2551 <span class="attributes"></span><b class="itemname">setColumnHeader</b>
2553 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>header</i></B>)
2560 <div class="short">Sets the header for a column.</div>
2566 Sets the header for a column.
2573 <dl class="detailList">
2574 <dt class="heading">Parameters:</dt>
2577 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2580 <dd>The column index</dd>
2583 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>header</b>
2586 <dd>The new header</dd>
2604 <td class="msource">
2606 Roo.grid.ColumnModel
2612 <tr class="method-row config-row-alt0 expandable notInherited">
2613 <td class="micon"><a class="exi" href="#expand"> </a></td>
2617 <a id="Roo.grid.ColumnModel-method-setColumnTooltip" name=".setColumnTooltip"></a>
2618 <div class="fixedFont">
2619 <span class="attributes"></span><b class="itemname">setColumnTooltip</b>
2621 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>tooltip</i></B>)
2628 <div class="short">Sets the tooltip for a column.</div>
2634 Sets the tooltip for a column.
2641 <dl class="detailList">
2642 <dt class="heading">Parameters:</dt>
2645 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2648 <dd>The column index</dd>
2651 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>tooltip</b>
2654 <dd>The new tooltip</dd>
2672 <td class="msource">
2674 Roo.grid.ColumnModel
2680 <tr class="method-row config-row-alt1 expandable notInherited">
2681 <td class="micon"><a class="exi" href="#expand"> </a></td>
2685 <a id="Roo.grid.ColumnModel-method-setColumnWidth" name=".setColumnWidth"></a>
2686 <div class="fixedFont">
2687 <span class="attributes"></span><b class="itemname">setColumnWidth</b>
2689 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>)
2696 <div class="short">Sets the width for a column.</div>
2702 Sets the width for a column.
2709 <dl class="detailList">
2710 <dt class="heading">Parameters:</dt>
2713 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2716 <dd>The column index</dd>
2719 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2722 <dd>The new width</dd>
2740 <td class="msource">
2742 Roo.grid.ColumnModel
2748 <tr class="method-row config-row-alt0 expandable notInherited">
2749 <td class="micon"><a class="exi" href="#expand"> </a></td>
2753 <a id="Roo.grid.ColumnModel-method-setDataIndex" name=".setDataIndex"></a>
2754 <div class="fixedFont">
2755 <span class="attributes"></span><b class="itemname">setDataIndex</b>
2757 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>dataIndex</i></B>)
2764 <div class="short">Sets the dataIndex for a column.</div>
2770 Sets the dataIndex for a column.
2777 <dl class="detailList">
2778 <dt class="heading">Parameters:</dt>
2781 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2784 <dd>The column index</dd>
2787 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>dataIndex</b>
2790 <dd>The new dataIndex</dd>
2808 <td class="msource">
2810 Roo.grid.ColumnModel
2816 <tr class="method-row config-row-alt1 expandable notInherited">
2817 <td class="micon"><a class="exi" href="#expand"> </a></td>
2821 <a id="Roo.grid.ColumnModel-method-setEditable" name=".setEditable"></a>
2822 <div class="fixedFont">
2823 <span class="attributes"></span><b class="itemname">setEditable</b>
2825 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>editable</i></B>)
2832 <div class="short">Sets if a column is editable.</div>
2838 Sets if a column is editable.
2845 <dl class="detailList">
2846 <dt class="heading">Parameters:</dt>
2849 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2852 <dd>The column index</dd>
2855 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>editable</b>
2858 <dd>True if the column is editable</dd>
2876 <td class="msource">
2878 Roo.grid.ColumnModel
2884 <tr class="method-row config-row-alt0 expandable notInherited">
2885 <td class="micon"><a class="exi" href="#expand"> </a></td>
2889 <a id="Roo.grid.ColumnModel-method-setEditor" name=".setEditor"></a>
2890 <div class="fixedFont">
2891 <span class="attributes"></span><b class="itemname">setEditor</b>
2893 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>editor</i></B>)
2900 <div class="short">Sets the editor for a column.</div>
2906 Sets the editor for a column.
2913 <dl class="detailList">
2914 <dt class="heading">Parameters:</dt>
2917 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2920 <dd>The column index</dd>
2923 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>editor</b>
2926 <dd>The editor object</dd>
2944 <td class="msource">
2946 Roo.grid.ColumnModel
2952 <tr class="method-row config-row-alt1 expandable notInherited">
2953 <td class="micon"><a class="exi" href="#expand"> </a></td>
2957 <a id="Roo.grid.ColumnModel-method-setHidden" name=".setHidden"></a>
2958 <div class="fixedFont">
2959 <span class="attributes"></span><b class="itemname">setHidden</b>
2961 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>hidden</i></B>)
2968 <div class="short">Sets if a column is hidden.</div>
2974 Sets if a column is hidden.
2981 <dl class="detailList">
2982 <dt class="heading">Parameters:</dt>
2985 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
2988 <dd>The column index</dd>
2991 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>hidden</b>
2994 <dd>True if the column is hidden</dd>
3012 <td class="msource">
3014 Roo.grid.ColumnModel
3020 <tr class="method-row config-row-alt0 expandable notInherited">
3021 <td class="micon"><a class="exi" href="#expand"> </a></td>
3025 <a id="Roo.grid.ColumnModel-method-setRenderer" name=".setRenderer"></a>
3026 <div class="fixedFont">
3027 <span class="attributes"></span><b class="itemname">setRenderer</b>
3029 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>)
3036 <div class="short">Sets the rendering (formatting) function for a column.</div>
3042 Sets the rendering (formatting) function for a column.
3049 <dl class="detailList">
3050 <dt class="heading">Parameters:</dt>
3053 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
3056 <dd>The column index</dd>
3059 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
3062 <dd>The function to use to process the cell's raw data<br/>to return HTML markup for the grid view. The render function is called with<br/>the following parameters:<ul><br/><li>Data value.</li><br/><li>Cell metadata. An object in which you may set the following attributes:<ul><br/><li>css A CSS style string to apply to the table cell.</li><br/><li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul><br/><li>The {<b>link</b> Roo.data.Record} from which the data was extracted.</li><br/><li>Row index</li><br/><li>Column index</li><br/><li>The {<b>link</b> Roo.data.Store} object from which the Record was extracted</li></ul></dd>
3080 <td class="msource">
3082 Roo.grid.ColumnModel
3088 <tr class="method-row config-row-alt1 expandable">
3089 <td class="micon"><a class="exi" href="#expand"> </a></td>
3093 <a id="Roo.util.Observable-method-un" name=".un"></a>
3094 <div class="fixedFont">
3095 <span class="attributes"></span><b class="itemname">un</b>
3097 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
3104 <div class="short">Removes a listener (shorthand for removeListener)</div>
3110 Removes a listener (shorthand for removeListener)
3117 <dl class="detailList">
3118 <dt class="heading">Parameters:</dt>
3121 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3124 <dd>The type of event to listen for</dd>
3127 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3130 <dd>The handler to remove</dd>
3133 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
3136 <dd>(optional) The scope (this object) for the handler</dd>
3154 <td class="msource">
3156 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3165 <!-- ============================== events summary / details ======================== -->
3168 <a id="Roo.grid.ColumnModel-events"></a>
3177 <table cellspacing="0" class="member-table">
3178 <caption>Events</caption>
3181 <th class="sig-header" colspan="2">Event</th>
3182 <th class="msource-header">Defined By</th>
3191 <tr class="method-row expandable config-row-alt0 notInherited">
3192 <td class="micon"><a class="exi" href="#expand"> </a></td>
3195 <a id="Roo.grid.ColumnModel-event-*columlockchange"></a>
3197 <div class="fixedFont">
3198 <b class="itemname">columlockchange</b> (ColumnModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>locked</i></B>)
3204 <div class="short">Fires when a column's locked state is changed
3210 Fires when a column's locked state is changed
3216 <dl class="detailList">
3217 <dt class="heading">Parameters:</dt>
3220 <span class="fixedFont">ColumnModel</span> <b>this</b>
3226 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
3232 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>locked</b>
3235 <dd>true if locked</dd>
3253 <td class="msource">
3254 Roo.grid.ColumnModel
3258 <tr class="method-row expandable config-row-alt1 notInherited">
3259 <td class="micon"><a class="exi" href="#expand"> </a></td>
3262 <a id="Roo.grid.ColumnModel-event-*columnmoved"></a>
3264 <div class="fixedFont">
3265 <b class="itemname">columnmoved</b> (ColumnModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>oldIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newIndex</i></B>)
3271 <div class="short">Fires when a column is moved.
3277 Fires when a column is moved.
3283 <dl class="detailList">
3284 <dt class="heading">Parameters:</dt>
3287 <span class="fixedFont">ColumnModel</span> <b>this</b>
3293 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>oldIndex</b>
3299 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newIndex</b>
3320 <td class="msource">
3321 Roo.grid.ColumnModel
3325 <tr class="method-row expandable config-row-alt0 notInherited">
3326 <td class="micon"><a class="exi" href="#expand"> </a></td>
3329 <a id="Roo.grid.ColumnModel-event-*headerchange"></a>
3331 <div class="fixedFont">
3332 <b class="itemname">headerchange</b> (ColumnModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newText</i></B>)
3338 <div class="short">Fires when the text of a header changes.
3344 Fires when the text of a header changes.
3350 <dl class="detailList">
3351 <dt class="heading">Parameters:</dt>
3354 <span class="fixedFont">ColumnModel</span> <b>this</b>
3360 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3363 <dd>The column index</dd>
3366 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newText</b>
3369 <dd>The new header text</dd>
3387 <td class="msource">
3388 Roo.grid.ColumnModel
3392 <tr class="method-row expandable config-row-alt1 notInherited">
3393 <td class="micon"><a class="exi" href="#expand"> </a></td>
3396 <a id="Roo.grid.ColumnModel-event-*hiddenchange"></a>
3398 <div class="fixedFont">
3399 <b class="itemname">hiddenchange</b> (ColumnModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>hidden</i></B>)
3405 <div class="short">Fires when a column is hidden or "unhidden".
3411 Fires when a column is hidden or "unhidden".
3417 <dl class="detailList">
3418 <dt class="heading">Parameters:</dt>
3421 <span class="fixedFont">ColumnModel</span> <b>this</b>
3427 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3430 <dd>The column index</dd>
3433 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>hidden</b>
3436 <dd>true if hidden, false otherwise</dd>
3454 <td class="msource">
3455 Roo.grid.ColumnModel
3459 <tr class="method-row expandable config-row-alt0 notInherited">
3460 <td class="micon"><a class="exi" href="#expand"> </a></td>
3463 <a id="Roo.grid.ColumnModel-event-*widthchange"></a>
3465 <div class="fixedFont">
3466 <b class="itemname">widthchange</b> (ColumnModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newWidth</i></B>)
3472 <div class="short">Fires when the width of a column changes.
3478 Fires when the width of a column changes.
3484 <dl class="detailList">
3485 <dt class="heading">Parameters:</dt>
3488 <span class="fixedFont">ColumnModel</span> <b>this</b>
3494 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3497 <dd>The column index</dd>
3500 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newWidth</b>
3503 <dd>The new width</dd>
3521 <td class="msource">
3522 Roo.grid.ColumnModel
3533 <!-- ============================== footer ================================= -->
3534 <div class="fineprint" style="clear:both">
3536 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Apr 01 2014 13:12:16 GMT+0800 (HKT)
3538 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>