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>
144 (Optional) Set the CSS text-align property of the column. Defaults to undefined.
160 <tr class="config-row expandable config-row-alt1 notInherited">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
164 <a id="Roo.grid.ColumnModel-cfg-cursor" name=".cursor"></a>
165 <div class="fixedFont">
166 <b class="itemname">cursor</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
172 <div class="short">(Optional)</div>
193 <tr class="config-row expandable config-row-alt0 notInherited">
194 <td class="micon"><a class="exi" href="#expand"> </a></td>
197 <a id="Roo.grid.ColumnModel-cfg-dataIndex" name=".dataIndex"></a>
198 <div class="fixedFont">
199 <b class="itemname">dataIndex</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
205 <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>
210 (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.
226 <tr class="config-row expandable config-row-alt1 notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
230 <a id="Roo.grid.ColumnModel-cfg-editor" name=".editor"></a>
231 <div class="fixedFont">
232 <b class="itemname">editor</b> : <a href="./Roo.grid.GridEditor.html#constructor" roo:cls="Roo.grid.GridEditor.html#constructor">Roo.grid.GridEditor</a>
238 <div class="short">(Optional) For grid editors - returns the grid editor</div>
243 (Optional) For grid editors - returns the grid editor
259 <tr class="config-row expandable config-row-alt0 notInherited">
260 <td class="micon"><a class="exi" href="#expand"> </a></td>
263 <a id="Roo.grid.ColumnModel-cfg-fixed" name=".fixed"></a>
264 <div class="fixedFont">
265 <b class="itemname">fixed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
271 <div class="short">(Optional) True if the column width cannot be changed.</div>
276 (Optional) True if the column width cannot be changed. Defaults to false.
292 <tr class="config-row expandable config-row-alt1 notInherited">
293 <td class="micon"><a class="exi" href="#expand"> </a></td>
296 <a id="Roo.grid.ColumnModel-cfg-header" name=".header"></a>
297 <div class="fixedFont">
298 <b class="itemname">header</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
304 <div class="short">The header text to display in the Grid view.</div>
309 The header text to display in the Grid view.
325 <tr class="config-row expandable config-row-alt0 notInherited">
326 <td class="micon"><a class="exi" href="#expand"> </a></td>
329 <a id="Roo.grid.ColumnModel-cfg-hidden" name=".hidden"></a>
330 <div class="fixedFont">
331 <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
337 <div class="short">(Optional) True to hide the column.</div>
342 (Optional) True to hide the column. Defaults to false.
358 <tr class="config-row expandable config-row-alt1">
359 <td class="micon"><a class="exi" href="#expand"> </a></td>
362 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
363 <div class="fixedFont">
364 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
370 <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>
375 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>
385 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
391 <tr class="config-row expandable config-row-alt0 notInherited">
392 <td class="micon"><a class="exi" href="#expand"> </a></td>
395 <a id="Roo.grid.ColumnModel-cfg-locked" name=".locked"></a>
396 <div class="fixedFont">
397 <b class="itemname">locked</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
403 <div class="short">(Optional) True to lock the column in place while scrolling the Grid.</div>
408 (Optional) True to lock the column in place while scrolling the Grid. Defaults to false.
424 <tr class="config-row expandable config-row-alt1 notInherited">
425 <td class="micon"><a class="exi" href="#expand"> </a></td>
428 <a id="Roo.grid.ColumnModel-cfg-renderer" name=".renderer"></a>
429 <div class="fixedFont">
430 <b class="itemname">renderer</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
436 <div class="short">(Optional) A function used to generate HTML markup for a cell<br/>given the cell's data value.</div>
441 (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. If an object is returned (bootstrap only)<br/>then it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered
457 <tr class="config-row expandable config-row-alt0 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.grid.ColumnModel-cfg-resizable" name=".resizable"></a>
462 <div class="fixedFont">
463 <b class="itemname">resizable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
469 <div class="short">(Optional) False to disable column resizing.</div>
474 (Optional) False to disable column resizing. Defaults to true.
490 <tr class="config-row expandable config-row-alt1 notInherited">
491 <td class="micon"><a class="exi" href="#expand"> </a></td>
494 <a id="Roo.grid.ColumnModel-cfg-sortable" name=".sortable"></a>
495 <div class="fixedFont">
496 <b class="itemname">sortable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
502 <div class="short">(Optional) True if sorting is to be allowed on this column.</div>
507 (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>}.
523 <tr class="config-row expandable config-row-alt0 notInherited">
524 <td class="micon"><a class="exi" href="#expand"> </a></td>
527 <a id="Roo.grid.ColumnModel-cfg-width" name=".width"></a>
528 <div class="fixedFont">
529 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
535 <div class="short">(Optional) The initial width in pixels of the column.</div>
540 (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.
566 <!-- ============================== public properties ==================== -->
570 <a id="Roo.grid.ColumnModel-props"></a>
576 <table cellspacing="0" class="member-table">
577 <caption class="Empty">Public Properties - Has None</caption>
583 <!-- ============================== methods summary / details ======================== -->
586 <a id="Roo.grid.ColumnModel-methods"></a>
587 <!-- constructor?? -->
594 <!-- then dynamics first -->
601 <table cellspacing="0" class="member-table">
602 <caption>Public Methods</caption>
604 <th class="sig-header" colspan="2">Method</th>
605 <th class="msource-header">Defined By</th>
615 <tr class="method-row config-row-alt0 expandable notInherited">
616 <td class="micon"><a class="exi" href="#expand"> </a></td>
620 <a id="Roo.grid-method-ColumnModel" name=".ColumnModel"></a>
621 <div class="fixedFont">
622 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">ColumnModel</b>
624 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
632 <div class="short">Create a new Roo.grid.ColumnModel</div>
639 Create a new Roo.grid.ColumnModel
642 <dl class="detailList">
643 <dt class="heading">Parameters:</dt>
646 <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>
649 <dd>An Array of column config objects. See this class's<br/>config objects for details.</dd>
673 <tr class="method-row config-row-alt1 expandable">
674 <td class="micon"><a class="exi" href="#expand"> </a></td>
678 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
679 <div class="fixedFont">
680 <span class="attributes"></span><b class="itemname">addEvents</b>
682 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
689 <div class="short">Used to define events on this Observable</div>
695 Used to define events on this Observable
702 <dl class="detailList">
703 <dt class="heading">Parameters:</dt>
706 <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>
709 <dd>The object with the events defined</dd>
729 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
735 <tr class="method-row config-row-alt0 expandable">
736 <td class="micon"><a class="exi" href="#expand"> </a></td>
740 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
741 <div class="fixedFont">
742 <span class="attributes"></span><b class="itemname">addListener</b>
744 (<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>)
751 <div class="short">Appends an event handler to this component</div>
757 Appends an event handler to this component
764 <dl class="detailList">
765 <dt class="heading">Parameters:</dt>
768 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
771 <dd>The type of event to listen for</dd>
774 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
777 <dd>The method the event invokes</dd>
780 <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>
783 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
786 <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>
789 <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>
809 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
815 <tr class="method-row config-row-alt1 expandable notInherited">
816 <td class="micon"><a class="exi" href="#expand"> </a></td>
820 <a id="Roo.grid.ColumnModel-method-findColumnIndex" name=".findColumnIndex"></a>
821 <div class="fixedFont">
822 <span class="attributes"></span><b class="itemname">findColumnIndex</b>
824 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>)
830 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
839 <div class="short">Returns the index for a specified column dataIndex.</div>
845 Returns the index for a specified column dataIndex.
852 <dl class="detailList">
853 <dt class="heading">Parameters:</dt>
856 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
859 <dd>The column dataIndex</dd>
867 <dl class="detailList">
868 <dt class="heading">Returns:</dt>
870 <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>
892 <tr class="method-row config-row-alt0 expandable">
893 <td class="micon"><a class="exi" href="#expand"> </a></td>
897 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
898 <div class="fixedFont">
899 <span class="attributes"></span><b class="itemname">fireEvent</b>
901 (<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>)
907 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
916 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
922 Fires the specified event with the passed parameters (minus the event name).
929 <dl class="detailList">
930 <dt class="heading">Parameters:</dt>
933 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
939 <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>
942 <dd>Variable number of parameters are passed to handlers</dd>
950 <dl class="detailList">
951 <dt class="heading">Returns:</dt>
953 <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>
969 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
975 <tr class="method-row config-row-alt1 expandable notInherited">
976 <td class="micon"><a class="exi" href="#expand"> </a></td>
980 <a id="Roo.grid.ColumnModel-method-getCellEditor" name=".getCellEditor"></a>
981 <div class="fixedFont">
982 <span class="attributes"></span><b class="itemname">getCellEditor</b>
984 (<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>)
990 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
999 <div class="short">Returns the editor defined for the cell/column.</div>
1005 Returns the editor defined for the cell/column.<br/>return false or null to disable editing.
1012 <dl class="detailList">
1013 <dt class="heading">Parameters:</dt>
1016 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
1019 <dd>The column index</dd>
1022 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
1025 <dd>The row index</dd>
1033 <dl class="detailList">
1034 <dt class="heading">Returns:</dt>
1036 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1050 <td class="msource">
1052 Roo.grid.ColumnModel
1058 <tr class="method-row config-row-alt0 expandable notInherited">
1059 <td class="micon"><a class="exi" href="#expand"> </a></td>
1063 <a id="Roo.grid.ColumnModel-method-getColumnByDataIndex" name=".getColumnByDataIndex"></a>
1064 <div class="fixedFont">
1065 <span class="attributes"></span><b class="itemname">getColumnByDataIndex</b>
1067 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>)
1073 <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>
1082 <div class="short">Returns the column for a specified dataIndex.</div>
1088 Returns the column for a specified dataIndex.
1095 <dl class="detailList">
1096 <dt class="heading">Parameters:</dt>
1099 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
1102 <dd>The column dataIndex</dd>
1110 <dl class="detailList">
1111 <dt class="heading">Returns:</dt>
1113 <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>
1127 <td class="msource">
1129 Roo.grid.ColumnModel
1135 <tr class="method-row config-row-alt1 expandable notInherited">
1136 <td class="micon"><a class="exi" href="#expand"> </a></td>
1140 <a id="Roo.grid.ColumnModel-method-getColumnById" name=".getColumnById"></a>
1141 <div class="fixedFont">
1142 <span class="attributes"></span><b class="itemname">getColumnById</b>
1144 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1150 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1159 <div class="short">Returns the column for a specified id.</div>
1165 Returns the column for a specified id.
1172 <dl class="detailList">
1173 <dt class="heading">Parameters:</dt>
1176 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1179 <dd>The column id</dd>
1187 <dl class="detailList">
1188 <dt class="heading">Returns:</dt>
1190 <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>
1204 <td class="msource">
1206 Roo.grid.ColumnModel
1212 <tr class="method-row config-row-alt0 expandable notInherited">
1213 <td class="micon"><a class="exi" href="#expand"> </a></td>
1217 <a id="Roo.grid.ColumnModel-method-getColumnCount" name=".getColumnCount"></a>
1218 <div class="fixedFont">
1219 <span class="attributes"></span><b class="itemname">getColumnCount</b>
1227 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1236 <div class="short">Returns the number of columns.</div>
1242 Returns the number of columns.
1253 <dl class="detailList">
1254 <dt class="heading">Returns:</dt>
1256 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1270 <td class="msource">
1272 Roo.grid.ColumnModel
1278 <tr class="method-row config-row-alt1 expandable notInherited">
1279 <td class="micon"><a class="exi" href="#expand"> </a></td>
1283 <a id="Roo.grid.ColumnModel-method-getColumnHeader" name=".getColumnHeader"></a>
1284 <div class="fixedFont">
1285 <span class="attributes"></span><b class="itemname">getColumnHeader</b>
1287 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1293 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1302 <div class="short">Returns the header for the specified column.</div>
1308 Returns the header for the specified column.
1315 <dl class="detailList">
1316 <dt class="heading">Parameters:</dt>
1319 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1322 <dd>The column index</dd>
1330 <dl class="detailList">
1331 <dt class="heading">Returns:</dt>
1333 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1347 <td class="msource">
1349 Roo.grid.ColumnModel
1355 <tr class="method-row config-row-alt0 expandable notInherited">
1356 <td class="micon"><a class="exi" href="#expand"> </a></td>
1360 <a id="Roo.grid.ColumnModel-method-getColumnId" name=".getColumnId"></a>
1361 <div class="fixedFont">
1362 <span class="attributes"></span><b class="itemname">getColumnId</b>
1364 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1370 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1379 <div class="short">Returns the id of the column at the specified index.</div>
1385 Returns the id of the column at the specified index.
1392 <dl class="detailList">
1393 <dt class="heading">Parameters:</dt>
1396 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1399 <dd>The column index</dd>
1407 <dl class="detailList">
1408 <dt class="heading">Returns:</dt>
1410 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> the id</dd>
1424 <td class="msource">
1426 Roo.grid.ColumnModel
1432 <tr class="method-row config-row-alt1 expandable notInherited">
1433 <td class="micon"><a class="exi" href="#expand"> </a></td>
1437 <a id="Roo.grid.ColumnModel-method-getColumnTooltip" name=".getColumnTooltip"></a>
1438 <div class="fixedFont">
1439 <span class="attributes"></span><b class="itemname">getColumnTooltip</b>
1441 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1447 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1456 <div class="short">Returns the tooltip for the specified column.</div>
1462 Returns the tooltip for the specified column.
1469 <dl class="detailList">
1470 <dt class="heading">Parameters:</dt>
1473 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1476 <dd>The column index</dd>
1484 <dl class="detailList">
1485 <dt class="heading">Returns:</dt>
1487 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1501 <td class="msource">
1503 Roo.grid.ColumnModel
1509 <tr class="method-row config-row-alt0 expandable notInherited">
1510 <td class="micon"><a class="exi" href="#expand"> </a></td>
1514 <a id="Roo.grid.ColumnModel-method-getColumnWidth" name=".getColumnWidth"></a>
1515 <div class="fixedFont">
1516 <span class="attributes"></span><b class="itemname">getColumnWidth</b>
1518 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1524 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1533 <div class="short">Returns the width for the specified column.</div>
1539 Returns the width for the specified column.
1546 <dl class="detailList">
1547 <dt class="heading">Parameters:</dt>
1550 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1553 <dd>The column index</dd>
1561 <dl class="detailList">
1562 <dt class="heading">Returns:</dt>
1564 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1578 <td class="msource">
1580 Roo.grid.ColumnModel
1586 <tr class="method-row config-row-alt1 expandable notInherited">
1587 <td class="micon"><a class="exi" href="#expand"> </a></td>
1591 <a id="Roo.grid.ColumnModel-method-getColumnsBy" name=".getColumnsBy"></a>
1592 <div class="fixedFont">
1593 <span class="attributes"></span><b class="itemname">getColumnsBy</b>
1595 (<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>)
1601 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1610 <div class="short">Returns the column configs that return true by the passed function that is called with (columnConfig, index)</div>
1616 Returns the column configs that return true by the passed function that is called with (columnConfig, index)
1623 <dl class="detailList">
1624 <dt class="heading">Parameters:</dt>
1627 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1633 <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>
1644 <dl class="detailList">
1645 <dt class="heading">Returns:</dt>
1647 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> result</dd>
1661 <td class="msource">
1663 Roo.grid.ColumnModel
1669 <tr class="method-row config-row-alt0 expandable notInherited">
1670 <td class="micon"><a class="exi" href="#expand"> </a></td>
1674 <a id="Roo.grid.ColumnModel-method-getDataIndex" name=".getDataIndex"></a>
1675 <div class="fixedFont">
1676 <span class="attributes"></span><b class="itemname">getDataIndex</b>
1678 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1684 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1693 <div class="short">Returns the dataIndex for the specified column.</div>
1699 Returns the dataIndex for the specified column.
1706 <dl class="detailList">
1707 <dt class="heading">Parameters:</dt>
1710 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1713 <dd>The column index</dd>
1721 <dl class="detailList">
1722 <dt class="heading">Returns:</dt>
1724 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1738 <td class="msource">
1740 Roo.grid.ColumnModel
1746 <tr class="method-row config-row-alt1 expandable notInherited">
1747 <td class="micon"><a class="exi" href="#expand"> </a></td>
1751 <a id="Roo.grid.ColumnModel-method-getIndexById" name=".getIndexById"></a>
1752 <div class="fixedFont">
1753 <span class="attributes"></span><b class="itemname">getIndexById</b>
1755 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1761 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1770 <div class="short">Returns the index for a specified column id.</div>
1776 Returns the index for a specified column id.
1783 <dl class="detailList">
1784 <dt class="heading">Parameters:</dt>
1787 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1790 <dd>The column id</dd>
1798 <dl class="detailList">
1799 <dt class="heading">Returns:</dt>
1801 <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>
1815 <td class="msource">
1817 Roo.grid.ColumnModel
1823 <tr class="method-row config-row-alt0 expandable notInherited">
1824 <td class="micon"><a class="exi" href="#expand"> </a></td>
1828 <a id="Roo.grid.ColumnModel-method-getRenderer" name=".getRenderer"></a>
1829 <div class="fixedFont">
1830 <span class="attributes"></span><b class="itemname">getRenderer</b>
1832 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1838 <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
1847 <div class="short">Returns the rendering (formatting) function defined for the column.</div>
1853 Returns the rendering (formatting) function defined for the column.
1860 <dl class="detailList">
1861 <dt class="heading">Parameters:</dt>
1864 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1867 <dd>The column index.</dd>
1875 <dl class="detailList">
1876 <dt class="heading">Returns:</dt>
1878 <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>
1892 <td class="msource">
1894 Roo.grid.ColumnModel
1900 <tr class="method-row config-row-alt1 expandable notInherited">
1901 <td class="micon"><a class="exi" href="#expand"> </a></td>
1905 <a id="Roo.grid.ColumnModel-method-getTotalWidth" name=".getTotalWidth"></a>
1906 <div class="fixedFont">
1907 <span class="attributes"></span><b class="itemname">getTotalWidth</b>
1909 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>includeHidden</i></B>)
1915 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1924 <div class="short">Returns the total width of all columns.</div>
1930 Returns the total width of all columns.
1937 <dl class="detailList">
1938 <dt class="heading">Parameters:</dt>
1941 <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>
1944 <dd>True to include hidden column widths</dd>
1952 <dl class="detailList">
1953 <dt class="heading">Returns:</dt>
1955 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1969 <td class="msource">
1971 Roo.grid.ColumnModel
1977 <tr class="method-row config-row-alt0 expandable">
1978 <td class="micon"><a class="exi" href="#expand"> </a></td>
1982 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1983 <div class="fixedFont">
1984 <span class="attributes"></span><b class="itemname">hasListener</b>
1986 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1992 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2001 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2007 Checks to see if this object has any listeners for a specified event
2014 <dl class="detailList">
2015 <dt class="heading">Parameters:</dt>
2018 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2021 <dd>The name of the event to check for</dd>
2029 <dl class="detailList">
2030 <dt class="heading">Returns:</dt>
2032 <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>
2046 <td class="msource">
2048 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2054 <tr class="method-row config-row-alt1 expandable notInherited">
2055 <td class="micon"><a class="exi" href="#expand"> </a></td>
2059 <a id="Roo.grid.ColumnModel-method-isCellEditable" name=".isCellEditable"></a>
2060 <div class="fixedFont">
2061 <span class="attributes"></span><b class="itemname">isCellEditable</b>
2063 (<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>)
2069 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2078 <div class="short">Returns true if the cell is editable.</div>
2084 Returns true if the cell is editable.
2091 <dl class="detailList">
2092 <dt class="heading">Parameters:</dt>
2095 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
2098 <dd>The column index</dd>
2101 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2104 <dd>The row index</dd>
2112 <dl class="detailList">
2113 <dt class="heading">Returns:</dt>
2115 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2129 <td class="msource">
2131 Roo.grid.ColumnModel
2137 <tr class="method-row config-row-alt0 expandable notInherited">
2138 <td class="micon"><a class="exi" href="#expand"> </a></td>
2142 <a id="Roo.grid.ColumnModel-method-isFixed" name=".isFixed"></a>
2143 <div class="fixedFont">
2144 <span class="attributes"></span><b class="itemname">isFixed</b>
2153 <div class="short">Returns true if the column width cannot be changed</div>
2159 Returns true if the column width cannot be changed
2180 <td class="msource">
2182 Roo.grid.ColumnModel
2188 <tr class="method-row config-row-alt1 expandable notInherited">
2189 <td class="micon"><a class="exi" href="#expand"> </a></td>
2193 <a id="Roo.grid.ColumnModel-method-isHidden" name=".isHidden"></a>
2194 <div class="fixedFont">
2195 <span class="attributes"></span><b class="itemname">isHidden</b>
2197 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>)
2203 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2212 <div class="short">Returns true if the column is hidden.</div>
2218 Returns true if the column is hidden.
2225 <dl class="detailList">
2226 <dt class="heading">Parameters:</dt>
2229 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
2232 <dd>The column index</dd>
2240 <dl class="detailList">
2241 <dt class="heading">Returns:</dt>
2243 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2257 <td class="msource">
2259 Roo.grid.ColumnModel
2265 <tr class="method-row config-row-alt0 expandable notInherited">
2266 <td class="micon"><a class="exi" href="#expand"> </a></td>
2270 <a id="Roo.grid.ColumnModel-method-isResizable" name=".isResizable"></a>
2271 <div class="fixedFont">
2272 <span class="attributes"></span><b class="itemname">isResizable</b>
2280 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2289 <div class="short">Returns true if the column can be resized</div>
2295 Returns true if the column can be resized
2306 <dl class="detailList">
2307 <dt class="heading">Returns:</dt>
2309 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2323 <td class="msource">
2325 Roo.grid.ColumnModel
2331 <tr class="method-row config-row-alt1 expandable notInherited">
2332 <td class="micon"><a class="exi" href="#expand"> </a></td>
2336 <a id="Roo.grid.ColumnModel-method-isSortable" name=".isSortable"></a>
2337 <div class="fixedFont">
2338 <span class="attributes"></span><b class="itemname">isSortable</b>
2340 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
2346 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2355 <div class="short">Returns true if the specified column is sortable.</div>
2361 Returns true if the specified column is sortable.
2368 <dl class="detailList">
2369 <dt class="heading">Parameters:</dt>
2372 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2375 <dd>The column index</dd>
2383 <dl class="detailList">
2384 <dt class="heading">Returns:</dt>
2386 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2400 <td class="msource">
2402 Roo.grid.ColumnModel
2408 <tr class="method-row config-row-alt0 expandable">
2409 <td class="micon"><a class="exi" href="#expand"> </a></td>
2413 <a id="Roo.util.Observable-method-on" name=".on"></a>
2414 <div class="fixedFont">
2415 <span class="attributes"></span><b class="itemname">on</b>
2417 (<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>)
2424 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2430 Appends an event handler to this element (shorthand for addListener)
2437 <dl class="detailList">
2438 <dt class="heading">Parameters:</dt>
2441 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2444 <dd>The type of event to listen for</dd>
2447 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2450 <dd>The method the event invokes</dd>
2453 <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>
2456 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2459 <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>
2480 <td class="msource">
2482 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2488 <tr class="method-row config-row-alt1 expandable">
2489 <td class="micon"><a class="exi" href="#expand"> </a></td>
2493 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2494 <div class="fixedFont">
2495 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2504 <div class="short">Removes all listeners for this object</div>
2510 Removes all listeners for this object
2531 <td class="msource">
2533 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2539 <tr class="method-row config-row-alt0 expandable">
2540 <td class="micon"><a class="exi" href="#expand"> </a></td>
2544 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2545 <div class="fixedFont">
2546 <span class="attributes"></span><b class="itemname">removeListener</b>
2548 (<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>)
2555 <div class="short">Removes a listener</div>
2568 <dl class="detailList">
2569 <dt class="heading">Parameters:</dt>
2572 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2575 <dd>The type of event to listen for</dd>
2578 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2581 <dd>The handler to remove</dd>
2584 <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>
2587 <dd>(optional) The scope (this object) for the handler</dd>
2605 <td class="msource">
2607 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2613 <tr class="method-row config-row-alt1 expandable notInherited">
2614 <td class="micon"><a class="exi" href="#expand"> </a></td>
2618 <a id="Roo.grid.ColumnModel-method-setColumnHeader" name=".setColumnHeader"></a>
2619 <div class="fixedFont">
2620 <span class="attributes"></span><b class="itemname">setColumnHeader</b>
2622 (<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>)
2629 <div class="short">Sets the header for a column.</div>
2635 Sets the header for a column.
2642 <dl class="detailList">
2643 <dt class="heading">Parameters:</dt>
2646 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2649 <dd>The column index</dd>
2652 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>header</b>
2655 <dd>The new header</dd>
2673 <td class="msource">
2675 Roo.grid.ColumnModel
2681 <tr class="method-row config-row-alt0 expandable notInherited">
2682 <td class="micon"><a class="exi" href="#expand"> </a></td>
2686 <a id="Roo.grid.ColumnModel-method-setColumnTooltip" name=".setColumnTooltip"></a>
2687 <div class="fixedFont">
2688 <span class="attributes"></span><b class="itemname">setColumnTooltip</b>
2690 (<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>)
2697 <div class="short">Sets the tooltip for a column.</div>
2703 Sets the tooltip for a column.
2710 <dl class="detailList">
2711 <dt class="heading">Parameters:</dt>
2714 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2717 <dd>The column index</dd>
2720 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>tooltip</b>
2723 <dd>The new tooltip</dd>
2741 <td class="msource">
2743 Roo.grid.ColumnModel
2749 <tr class="method-row config-row-alt1 expandable notInherited">
2750 <td class="micon"><a class="exi" href="#expand"> </a></td>
2754 <a id="Roo.grid.ColumnModel-method-setColumnWidth" name=".setColumnWidth"></a>
2755 <div class="fixedFont">
2756 <span class="attributes"></span><b class="itemname">setColumnWidth</b>
2758 (<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>)
2765 <div class="short">Sets the width for a column.</div>
2771 Sets the width for a column.
2778 <dl class="detailList">
2779 <dt class="heading">Parameters:</dt>
2782 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2785 <dd>The column index</dd>
2788 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2791 <dd>The new width</dd>
2809 <td class="msource">
2811 Roo.grid.ColumnModel
2817 <tr class="method-row config-row-alt0 expandable notInherited">
2818 <td class="micon"><a class="exi" href="#expand"> </a></td>
2822 <a id="Roo.grid.ColumnModel-method-setDataIndex" name=".setDataIndex"></a>
2823 <div class="fixedFont">
2824 <span class="attributes"></span><b class="itemname">setDataIndex</b>
2826 (<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>)
2833 <div class="short">Sets the dataIndex for a column.</div>
2839 Sets the dataIndex for a column.
2846 <dl class="detailList">
2847 <dt class="heading">Parameters:</dt>
2850 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2853 <dd>The column index</dd>
2856 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>dataIndex</b>
2859 <dd>The new dataIndex</dd>
2877 <td class="msource">
2879 Roo.grid.ColumnModel
2885 <tr class="method-row config-row-alt1 expandable notInherited">
2886 <td class="micon"><a class="exi" href="#expand"> </a></td>
2890 <a id="Roo.grid.ColumnModel-method-setEditable" name=".setEditable"></a>
2891 <div class="fixedFont">
2892 <span class="attributes"></span><b class="itemname">setEditable</b>
2894 (<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>)
2901 <div class="short">Sets if a column is editable.</div>
2907 Sets if a column is editable.
2914 <dl class="detailList">
2915 <dt class="heading">Parameters:</dt>
2918 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2921 <dd>The column index</dd>
2924 <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>
2927 <dd>True if the column is editable</dd>
2945 <td class="msource">
2947 Roo.grid.ColumnModel
2953 <tr class="method-row config-row-alt0 expandable notInherited">
2954 <td class="micon"><a class="exi" href="#expand"> </a></td>
2958 <a id="Roo.grid.ColumnModel-method-setEditor" name=".setEditor"></a>
2959 <div class="fixedFont">
2960 <span class="attributes"></span><b class="itemname">setEditor</b>
2962 (<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>)
2969 <div class="short">Sets the editor for a column.</div>
2975 Sets the editor for a column.
2982 <dl class="detailList">
2983 <dt class="heading">Parameters:</dt>
2986 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2989 <dd>The column index</dd>
2992 <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>
2995 <dd>The editor object</dd>
3013 <td class="msource">
3015 Roo.grid.ColumnModel
3021 <tr class="method-row config-row-alt1 expandable notInherited">
3022 <td class="micon"><a class="exi" href="#expand"> </a></td>
3026 <a id="Roo.grid.ColumnModel-method-setHidden" name=".setHidden"></a>
3027 <div class="fixedFont">
3028 <span class="attributes"></span><b class="itemname">setHidden</b>
3030 (<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>)
3037 <div class="short">Sets if a column is hidden.</div>
3043 Sets if a column is hidden.
3050 <dl class="detailList">
3051 <dt class="heading">Parameters:</dt>
3054 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
3057 <dd>The column index</dd>
3060 <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>
3063 <dd>True if the column is hidden</dd>
3081 <td class="msource">
3083 Roo.grid.ColumnModel
3089 <tr class="method-row config-row-alt0 expandable notInherited">
3090 <td class="micon"><a class="exi" href="#expand"> </a></td>
3094 <a id="Roo.grid.ColumnModel-method-setRenderer" name=".setRenderer"></a>
3095 <div class="fixedFont">
3096 <span class="attributes"></span><b class="itemname">setRenderer</b>
3098 (<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>)
3105 <div class="short">Sets the rendering (formatting) function for a column.</div>
3111 Sets the rendering (formatting) function for a column.
3118 <dl class="detailList">
3119 <dt class="heading">Parameters:</dt>
3122 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
3125 <dd>The column index</dd>
3128 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
3131 <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>
3149 <td class="msource">
3151 Roo.grid.ColumnModel
3157 <tr class="method-row config-row-alt1 expandable">
3158 <td class="micon"><a class="exi" href="#expand"> </a></td>
3162 <a id="Roo.util.Observable-method-un" name=".un"></a>
3163 <div class="fixedFont">
3164 <span class="attributes"></span><b class="itemname">un</b>
3166 (<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>)
3173 <div class="short">Removes a listener (shorthand for removeListener)</div>
3179 Removes a listener (shorthand for removeListener)
3186 <dl class="detailList">
3187 <dt class="heading">Parameters:</dt>
3190 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3193 <dd>The type of event to listen for</dd>
3196 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3199 <dd>The handler to remove</dd>
3202 <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>
3205 <dd>(optional) The scope (this object) for the handler</dd>
3223 <td class="msource">
3225 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3234 <!-- ============================== events summary / details ======================== -->
3237 <a id="Roo.grid.ColumnModel-events"></a>
3246 <table cellspacing="0" class="member-table">
3247 <caption>Events</caption>
3250 <th class="sig-header" colspan="2">Event</th>
3251 <th class="msource-header">Defined By</th>
3260 <tr class="method-row expandable config-row-alt0 notInherited">
3261 <td class="micon"><a class="exi" href="#expand"> </a></td>
3264 <a id="Roo.grid.ColumnModel-event-*columlockchange"></a>
3266 <div class="fixedFont">
3267 <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>)
3273 <div class="short">Fires when a column's locked state is changed
3279 Fires when a column's locked state is changed
3285 <dl class="detailList">
3286 <dt class="heading">Parameters:</dt>
3289 <span class="fixedFont">ColumnModel</span> <b>this</b>
3295 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
3301 <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>
3304 <dd>true if locked</dd>
3322 <td class="msource">
3323 Roo.grid.ColumnModel
3327 <tr class="method-row expandable config-row-alt1 notInherited">
3328 <td class="micon"><a class="exi" href="#expand"> </a></td>
3331 <a id="Roo.grid.ColumnModel-event-*columnmoved"></a>
3333 <div class="fixedFont">
3334 <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>)
3340 <div class="short">Fires when a column is moved.
3346 Fires when a column is moved.
3352 <dl class="detailList">
3353 <dt class="heading">Parameters:</dt>
3356 <span class="fixedFont">ColumnModel</span> <b>this</b>
3362 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>oldIndex</b>
3368 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newIndex</b>
3389 <td class="msource">
3390 Roo.grid.ColumnModel
3394 <tr class="method-row expandable config-row-alt0 notInherited">
3395 <td class="micon"><a class="exi" href="#expand"> </a></td>
3398 <a id="Roo.grid.ColumnModel-event-*headerchange"></a>
3400 <div class="fixedFont">
3401 <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>)
3407 <div class="short">Fires when the text of a header changes.
3413 Fires when the text of a header changes.
3419 <dl class="detailList">
3420 <dt class="heading">Parameters:</dt>
3423 <span class="fixedFont">ColumnModel</span> <b>this</b>
3429 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3432 <dd>The column index</dd>
3435 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newText</b>
3438 <dd>The new header text</dd>
3456 <td class="msource">
3457 Roo.grid.ColumnModel
3461 <tr class="method-row expandable config-row-alt1 notInherited">
3462 <td class="micon"><a class="exi" href="#expand"> </a></td>
3465 <a id="Roo.grid.ColumnModel-event-*hiddenchange"></a>
3467 <div class="fixedFont">
3468 <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>)
3474 <div class="short">Fires when a column is hidden or "unhidden".
3480 Fires when a column is hidden or "unhidden".
3486 <dl class="detailList">
3487 <dt class="heading">Parameters:</dt>
3490 <span class="fixedFont">ColumnModel</span> <b>this</b>
3496 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3499 <dd>The column index</dd>
3502 <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>
3505 <dd>true if hidden, false otherwise</dd>
3523 <td class="msource">
3524 Roo.grid.ColumnModel
3528 <tr class="method-row expandable config-row-alt0 notInherited">
3529 <td class="micon"><a class="exi" href="#expand"> </a></td>
3532 <a id="Roo.grid.ColumnModel-event-*widthchange"></a>
3534 <div class="fixedFont">
3535 <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>)
3541 <div class="short">Fires when the width of a column changes.
3547 Fires when the width of a column changes.
3553 <dl class="detailList">
3554 <dt class="heading">Parameters:</dt>
3557 <span class="fixedFont">ColumnModel</span> <b>this</b>
3563 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3566 <dd>The column index</dd>
3569 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newWidth</b>
3572 <dd>The new width</dd>
3590 <td class="msource">
3591 Roo.grid.ColumnModel
3602 <!-- ============================== footer ================================= -->
3603 <div class="fineprint" style="clear:both">
3605 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jun 05 2015 12:08:16 GMT+0800 (HKT)
3607 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>