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 notInherited">
359 <td class="micon"><a class="exi" href="#expand"> </a></td>
362 <a id="Roo.grid.ColumnModel-cfg-lg" name=".lg"></a>
363 <div class="fixedFont">
364 <b class="itemname">lg</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
370 <div class="short">(Optional)</div>
391 <tr class="config-row expandable config-row-alt0">
392 <td class="micon"><a class="exi" href="#expand"> </a></td>
395 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
396 <div class="fixedFont">
397 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
403 <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>
408 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>
418 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
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-locked" name=".locked"></a>
429 <div class="fixedFont">
430 <b class="itemname">locked</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
436 <div class="short">(Optional) True to lock the column in place while scrolling the Grid.</div>
441 (Optional) True to lock the column in place while scrolling the Grid. Defaults to false.
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-md" name=".md"></a>
462 <div class="fixedFont">
463 <b class="itemname">md</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
469 <div class="short">(Optional)</div>
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-renderer" name=".renderer"></a>
495 <div class="fixedFont">
496 <b class="itemname">renderer</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
502 <div class="short">(Optional) A function used to generate HTML markup for a cell<br/>given the cell's data value.</div>
507 (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
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-resizable" name=".resizable"></a>
528 <div class="fixedFont">
529 <b class="itemname">resizable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
535 <div class="short">(Optional) False to disable column resizing.</div>
540 (Optional) False to disable column resizing. Defaults to true.
556 <tr class="config-row expandable config-row-alt1 notInherited">
557 <td class="micon"><a class="exi" href="#expand"> </a></td>
560 <a id="Roo.grid.ColumnModel-cfg-sm" name=".sm"></a>
561 <div class="fixedFont">
562 <b class="itemname">sm</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
568 <div class="short">(Optional)</div>
589 <tr class="config-row expandable config-row-alt0 notInherited">
590 <td class="micon"><a class="exi" href="#expand"> </a></td>
593 <a id="Roo.grid.ColumnModel-cfg-sortable" name=".sortable"></a>
594 <div class="fixedFont">
595 <b class="itemname">sortable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
601 <div class="short">(Optional) True if sorting is to be allowed on this column.</div>
606 (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>}.
622 <tr class="config-row expandable config-row-alt1 notInherited">
623 <td class="micon"><a class="exi" href="#expand"> </a></td>
626 <a id="Roo.grid.ColumnModel-cfg-tooltip" name=".tooltip"></a>
627 <div class="fixedFont">
628 <b class="itemname">tooltip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
634 <div class="short">(Optional)</div>
655 <tr class="config-row expandable config-row-alt0 notInherited">
656 <td class="micon"><a class="exi" href="#expand"> </a></td>
659 <a id="Roo.grid.ColumnModel-cfg-width" name=".width"></a>
660 <div class="fixedFont">
661 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
667 <div class="short">(Optional) The initial width in pixels of the column.</div>
672 (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.
688 <tr class="config-row expandable config-row-alt1 notInherited">
689 <td class="micon"><a class="exi" href="#expand"> </a></td>
692 <a id="Roo.grid.ColumnModel-cfg-xs" name=".xs"></a>
693 <div class="fixedFont">
694 <b class="itemname">xs</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
700 <div class="short">(Optional)</div>
731 <!-- ============================== public properties ==================== -->
735 <a id="Roo.grid.ColumnModel-props"></a>
741 <table cellspacing="0" class="member-table">
742 <caption class="Empty">Public Properties - Has None</caption>
748 <!-- ============================== methods summary / details ======================== -->
751 <a id="Roo.grid.ColumnModel-methods"></a>
752 <!-- constructor?? -->
759 <!-- then dynamics first -->
766 <table cellspacing="0" class="member-table">
767 <caption>Public Methods</caption>
769 <th class="sig-header" colspan="2">Method</th>
770 <th class="msource-header">Defined By</th>
780 <tr class="method-row config-row-alt0 expandable notInherited">
781 <td class="micon"><a class="exi" href="#expand"> </a></td>
785 <a id="Roo.grid-method-ColumnModel" name=".ColumnModel"></a>
786 <div class="fixedFont">
787 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">ColumnModel</b>
789 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
797 <div class="short">Create a new Roo.grid.ColumnModel</div>
804 Create a new Roo.grid.ColumnModel
807 <dl class="detailList">
808 <dt class="heading">Parameters:</dt>
811 <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>
814 <dd>An Array of column config objects. See this class's<br/>config objects for details.</dd>
838 <tr class="method-row config-row-alt1 expandable">
839 <td class="micon"><a class="exi" href="#expand"> </a></td>
843 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
844 <div class="fixedFont">
845 <span class="attributes"></span><b class="itemname">addEvents</b>
847 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
854 <div class="short">Used to define events on this Observable</div>
860 Used to define events on this Observable
867 <dl class="detailList">
868 <dt class="heading">Parameters:</dt>
871 <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>
874 <dd>The object with the events defined</dd>
894 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
900 <tr class="method-row config-row-alt0 expandable">
901 <td class="micon"><a class="exi" href="#expand"> </a></td>
905 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
906 <div class="fixedFont">
907 <span class="attributes"></span><b class="itemname">addListener</b>
909 (<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>)
916 <div class="short">Appends an event handler to this component</div>
922 Appends an event handler to this component
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>
936 <dd>The type of event to listen for</dd>
939 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
942 <dd>The method the event invokes</dd>
945 <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>
948 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
951 <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>
954 <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>
974 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
980 <tr class="method-row config-row-alt1 expandable notInherited">
981 <td class="micon"><a class="exi" href="#expand"> </a></td>
985 <a id="Roo.grid.ColumnModel-method-findColumnIndex" name=".findColumnIndex"></a>
986 <div class="fixedFont">
987 <span class="attributes"></span><b class="itemname">findColumnIndex</b>
989 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>)
995 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1004 <div class="short">Returns the index for a specified column dataIndex.</div>
1010 Returns the index for a specified column dataIndex.
1017 <dl class="detailList">
1018 <dt class="heading">Parameters:</dt>
1021 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
1024 <dd>The column dataIndex</dd>
1032 <dl class="detailList">
1033 <dt class="heading">Returns:</dt>
1035 <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>
1049 <td class="msource">
1051 Roo.grid.ColumnModel
1057 <tr class="method-row config-row-alt0 expandable">
1058 <td class="micon"><a class="exi" href="#expand"> </a></td>
1062 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1063 <div class="fixedFont">
1064 <span class="attributes"></span><b class="itemname">fireEvent</b>
1066 (<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>)
1072 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1081 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1087 Fires the specified event with the passed parameters (minus the event name).
1094 <dl class="detailList">
1095 <dt class="heading">Parameters:</dt>
1098 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1104 <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>
1107 <dd>Variable number of parameters are passed to handlers</dd>
1115 <dl class="detailList">
1116 <dt class="heading">Returns:</dt>
1118 <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>
1132 <td class="msource">
1134 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1140 <tr class="method-row config-row-alt1 expandable notInherited">
1141 <td class="micon"><a class="exi" href="#expand"> </a></td>
1145 <a id="Roo.grid.ColumnModel-method-getCellEditor" name=".getCellEditor"></a>
1146 <div class="fixedFont">
1147 <span class="attributes"></span><b class="itemname">getCellEditor</b>
1149 (<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>)
1155 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1164 <div class="short">Returns the editor defined for the cell/column.</div>
1170 Returns the editor defined for the cell/column.<br/>return false or null to disable editing.
1177 <dl class="detailList">
1178 <dt class="heading">Parameters:</dt>
1181 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
1184 <dd>The column index</dd>
1187 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
1190 <dd>The row index</dd>
1198 <dl class="detailList">
1199 <dt class="heading">Returns:</dt>
1201 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1215 <td class="msource">
1217 Roo.grid.ColumnModel
1223 <tr class="method-row config-row-alt0 expandable notInherited">
1224 <td class="micon"><a class="exi" href="#expand"> </a></td>
1228 <a id="Roo.grid.ColumnModel-method-getColumnByDataIndex" name=".getColumnByDataIndex"></a>
1229 <div class="fixedFont">
1230 <span class="attributes"></span><b class="itemname">getColumnByDataIndex</b>
1232 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>)
1238 <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>
1247 <div class="short">Returns the column for a specified dataIndex.</div>
1253 Returns the column for a specified dataIndex.
1260 <dl class="detailList">
1261 <dt class="heading">Parameters:</dt>
1264 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>dataIndex</b>
1267 <dd>The column dataIndex</dd>
1275 <dl class="detailList">
1276 <dt class="heading">Returns:</dt>
1278 <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>
1292 <td class="msource">
1294 Roo.grid.ColumnModel
1300 <tr class="method-row config-row-alt1 expandable notInherited">
1301 <td class="micon"><a class="exi" href="#expand"> </a></td>
1305 <a id="Roo.grid.ColumnModel-method-getColumnById" name=".getColumnById"></a>
1306 <div class="fixedFont">
1307 <span class="attributes"></span><b class="itemname">getColumnById</b>
1309 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1315 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1324 <div class="short">Returns the column for a specified id.</div>
1330 Returns the column for a specified id.
1337 <dl class="detailList">
1338 <dt class="heading">Parameters:</dt>
1341 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1344 <dd>The column id</dd>
1352 <dl class="detailList">
1353 <dt class="heading">Returns:</dt>
1355 <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>
1369 <td class="msource">
1371 Roo.grid.ColumnModel
1377 <tr class="method-row config-row-alt0 expandable notInherited">
1378 <td class="micon"><a class="exi" href="#expand"> </a></td>
1382 <a id="Roo.grid.ColumnModel-method-getColumnCount" name=".getColumnCount"></a>
1383 <div class="fixedFont">
1384 <span class="attributes"></span><b class="itemname">getColumnCount</b>
1392 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1401 <div class="short">Returns the number of columns.</div>
1407 Returns the number of columns.
1418 <dl class="detailList">
1419 <dt class="heading">Returns:</dt>
1421 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1435 <td class="msource">
1437 Roo.grid.ColumnModel
1443 <tr class="method-row config-row-alt1 expandable notInherited">
1444 <td class="micon"><a class="exi" href="#expand"> </a></td>
1448 <a id="Roo.grid.ColumnModel-method-getColumnHeader" name=".getColumnHeader"></a>
1449 <div class="fixedFont">
1450 <span class="attributes"></span><b class="itemname">getColumnHeader</b>
1452 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1458 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1467 <div class="short">Returns the header for the specified column.</div>
1473 Returns the header for the specified column.
1480 <dl class="detailList">
1481 <dt class="heading">Parameters:</dt>
1484 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1487 <dd>The column index</dd>
1495 <dl class="detailList">
1496 <dt class="heading">Returns:</dt>
1498 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1512 <td class="msource">
1514 Roo.grid.ColumnModel
1520 <tr class="method-row config-row-alt0 expandable notInherited">
1521 <td class="micon"><a class="exi" href="#expand"> </a></td>
1525 <a id="Roo.grid.ColumnModel-method-getColumnId" name=".getColumnId"></a>
1526 <div class="fixedFont">
1527 <span class="attributes"></span><b class="itemname">getColumnId</b>
1529 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1535 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1544 <div class="short">Returns the id of the column at the specified index.</div>
1550 Returns the id of the column at the specified index.
1557 <dl class="detailList">
1558 <dt class="heading">Parameters:</dt>
1561 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1564 <dd>The column index</dd>
1572 <dl class="detailList">
1573 <dt class="heading">Returns:</dt>
1575 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> the id</dd>
1589 <td class="msource">
1591 Roo.grid.ColumnModel
1597 <tr class="method-row config-row-alt1 expandable notInherited">
1598 <td class="micon"><a class="exi" href="#expand"> </a></td>
1602 <a id="Roo.grid.ColumnModel-method-getColumnTooltip" name=".getColumnTooltip"></a>
1603 <div class="fixedFont">
1604 <span class="attributes"></span><b class="itemname">getColumnTooltip</b>
1606 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1612 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1621 <div class="short">Returns the tooltip for the specified column.</div>
1627 Returns the tooltip for the specified column.
1634 <dl class="detailList">
1635 <dt class="heading">Parameters:</dt>
1638 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1641 <dd>The column index</dd>
1649 <dl class="detailList">
1650 <dt class="heading">Returns:</dt>
1652 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1666 <td class="msource">
1668 Roo.grid.ColumnModel
1674 <tr class="method-row config-row-alt0 expandable notInherited">
1675 <td class="micon"><a class="exi" href="#expand"> </a></td>
1679 <a id="Roo.grid.ColumnModel-method-getColumnWidth" name=".getColumnWidth"></a>
1680 <div class="fixedFont">
1681 <span class="attributes"></span><b class="itemname">getColumnWidth</b>
1683 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1689 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1698 <div class="short">Returns the width for the specified column.</div>
1704 Returns the width for the specified column.
1711 <dl class="detailList">
1712 <dt class="heading">Parameters:</dt>
1715 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1718 <dd>The column index</dd>
1726 <dl class="detailList">
1727 <dt class="heading">Returns:</dt>
1729 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1743 <td class="msource">
1745 Roo.grid.ColumnModel
1751 <tr class="method-row config-row-alt1 expandable notInherited">
1752 <td class="micon"><a class="exi" href="#expand"> </a></td>
1756 <a id="Roo.grid.ColumnModel-method-getColumnsBy" name=".getColumnsBy"></a>
1757 <div class="fixedFont">
1758 <span class="attributes"></span><b class="itemname">getColumnsBy</b>
1760 (<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>)
1766 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1775 <div class="short">Returns the column configs that return true by the passed function that is called with (columnConfig, index)</div>
1781 Returns the column configs that return true by the passed function that is called with (columnConfig, index)
1788 <dl class="detailList">
1789 <dt class="heading">Parameters:</dt>
1792 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
1798 <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>
1809 <dl class="detailList">
1810 <dt class="heading">Returns:</dt>
1812 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> result</dd>
1826 <td class="msource">
1828 Roo.grid.ColumnModel
1834 <tr class="method-row config-row-alt0 expandable notInherited">
1835 <td class="micon"><a class="exi" href="#expand"> </a></td>
1839 <a id="Roo.grid.ColumnModel-method-getDataIndex" name=".getDataIndex"></a>
1840 <div class="fixedFont">
1841 <span class="attributes"></span><b class="itemname">getDataIndex</b>
1843 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
1849 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1858 <div class="short">Returns the dataIndex for the specified column.</div>
1864 Returns the dataIndex for the specified column.
1871 <dl class="detailList">
1872 <dt class="heading">Parameters:</dt>
1875 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
1878 <dd>The column index</dd>
1886 <dl class="detailList">
1887 <dt class="heading">Returns:</dt>
1889 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1903 <td class="msource">
1905 Roo.grid.ColumnModel
1911 <tr class="method-row config-row-alt1 expandable notInherited">
1912 <td class="micon"><a class="exi" href="#expand"> </a></td>
1916 <a id="Roo.grid.ColumnModel-method-getIndexById" name=".getIndexById"></a>
1917 <div class="fixedFont">
1918 <span class="attributes"></span><b class="itemname">getIndexById</b>
1920 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1926 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1935 <div class="short">Returns the index for a specified column id.</div>
1941 Returns the index for a specified column id.
1948 <dl class="detailList">
1949 <dt class="heading">Parameters:</dt>
1952 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1955 <dd>The column id</dd>
1963 <dl class="detailList">
1964 <dt class="heading">Returns:</dt>
1966 <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>
1980 <td class="msource">
1982 Roo.grid.ColumnModel
1988 <tr class="method-row config-row-alt0 expandable notInherited">
1989 <td class="micon"><a class="exi" href="#expand"> </a></td>
1993 <a id="Roo.grid.ColumnModel-method-getRenderer" name=".getRenderer"></a>
1994 <div class="fixedFont">
1995 <span class="attributes"></span><b class="itemname">getRenderer</b>
1997 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
2003 <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
2012 <div class="short">Returns the rendering (formatting) function defined for the column.</div>
2018 Returns the rendering (formatting) function defined for the column.
2025 <dl class="detailList">
2026 <dt class="heading">Parameters:</dt>
2029 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2032 <dd>The column index.</dd>
2040 <dl class="detailList">
2041 <dt class="heading">Returns:</dt>
2043 <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>
2057 <td class="msource">
2059 Roo.grid.ColumnModel
2065 <tr class="method-row config-row-alt1 expandable notInherited">
2066 <td class="micon"><a class="exi" href="#expand"> </a></td>
2070 <a id="Roo.grid.ColumnModel-method-getTotalWidth" name=".getTotalWidth"></a>
2071 <div class="fixedFont">
2072 <span class="attributes"></span><b class="itemname">getTotalWidth</b>
2074 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>includeHidden</i></B>)
2080 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
2089 <div class="short">Returns the total width of all columns.</div>
2095 Returns the total width of all columns.
2102 <dl class="detailList">
2103 <dt class="heading">Parameters:</dt>
2106 <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>
2109 <dd>True to include hidden column widths</dd>
2117 <dl class="detailList">
2118 <dt class="heading">Returns:</dt>
2120 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
2134 <td class="msource">
2136 Roo.grid.ColumnModel
2142 <tr class="method-row config-row-alt0 expandable">
2143 <td class="micon"><a class="exi" href="#expand"> </a></td>
2147 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
2148 <div class="fixedFont">
2149 <span class="attributes"></span><b class="itemname">hasListener</b>
2151 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2157 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2166 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2172 Checks to see if this object has any listeners for a specified event
2179 <dl class="detailList">
2180 <dt class="heading">Parameters:</dt>
2183 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2186 <dd>The name of the event to check for</dd>
2194 <dl class="detailList">
2195 <dt class="heading">Returns:</dt>
2197 <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>
2211 <td class="msource">
2213 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2219 <tr class="method-row config-row-alt1 expandable notInherited">
2220 <td class="micon"><a class="exi" href="#expand"> </a></td>
2224 <a id="Roo.grid.ColumnModel-method-isCellEditable" name=".isCellEditable"></a>
2225 <div class="fixedFont">
2226 <span class="attributes"></span><b class="itemname">isCellEditable</b>
2228 (<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>)
2234 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2243 <div class="short">Returns true if the cell is editable.</div>
2249 Returns true if the cell is editable.
2256 <dl class="detailList">
2257 <dt class="heading">Parameters:</dt>
2260 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
2263 <dd>The column index</dd>
2266 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2269 <dd>The row index</dd>
2277 <dl class="detailList">
2278 <dt class="heading">Returns:</dt>
2280 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2294 <td class="msource">
2296 Roo.grid.ColumnModel
2302 <tr class="method-row config-row-alt0 expandable notInherited">
2303 <td class="micon"><a class="exi" href="#expand"> </a></td>
2307 <a id="Roo.grid.ColumnModel-method-isFixed" name=".isFixed"></a>
2308 <div class="fixedFont">
2309 <span class="attributes"></span><b class="itemname">isFixed</b>
2318 <div class="short">Returns true if the column width cannot be changed</div>
2324 Returns true if the column width cannot be changed
2345 <td class="msource">
2347 Roo.grid.ColumnModel
2353 <tr class="method-row config-row-alt1 expandable notInherited">
2354 <td class="micon"><a class="exi" href="#expand"> </a></td>
2358 <a id="Roo.grid.ColumnModel-method-isHidden" name=".isHidden"></a>
2359 <div class="fixedFont">
2360 <span class="attributes"></span><b class="itemname">isHidden</b>
2362 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>)
2368 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2377 <div class="short">Returns true if the column is hidden.</div>
2383 Returns true if the column is hidden.
2390 <dl class="detailList">
2391 <dt class="heading">Parameters:</dt>
2394 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
2397 <dd>The column index</dd>
2405 <dl class="detailList">
2406 <dt class="heading">Returns:</dt>
2408 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2422 <td class="msource">
2424 Roo.grid.ColumnModel
2430 <tr class="method-row config-row-alt0 expandable notInherited">
2431 <td class="micon"><a class="exi" href="#expand"> </a></td>
2435 <a id="Roo.grid.ColumnModel-method-isResizable" name=".isResizable"></a>
2436 <div class="fixedFont">
2437 <span class="attributes"></span><b class="itemname">isResizable</b>
2445 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2454 <div class="short">Returns true if the column can be resized</div>
2460 Returns true if the column can be resized
2471 <dl class="detailList">
2472 <dt class="heading">Returns:</dt>
2474 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2488 <td class="msource">
2490 Roo.grid.ColumnModel
2496 <tr class="method-row config-row-alt1 expandable notInherited">
2497 <td class="micon"><a class="exi" href="#expand"> </a></td>
2501 <a id="Roo.grid.ColumnModel-method-isSortable" name=".isSortable"></a>
2502 <div class="fixedFont">
2503 <span class="attributes"></span><b class="itemname">isSortable</b>
2505 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>)
2511 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2520 <div class="short">Returns true if the specified column is sortable.</div>
2526 Returns true if the specified column is sortable.
2533 <dl class="detailList">
2534 <dt class="heading">Parameters:</dt>
2537 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2540 <dd>The column index</dd>
2548 <dl class="detailList">
2549 <dt class="heading">Returns:</dt>
2551 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2565 <td class="msource">
2567 Roo.grid.ColumnModel
2573 <tr class="method-row config-row-alt0 expandable">
2574 <td class="micon"><a class="exi" href="#expand"> </a></td>
2578 <a id="Roo.util.Observable-method-on" name=".on"></a>
2579 <div class="fixedFont">
2580 <span class="attributes"></span><b class="itemname">on</b>
2582 (<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>)
2589 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2595 Appends an event handler to this element (shorthand for addListener)
2602 <dl class="detailList">
2603 <dt class="heading">Parameters:</dt>
2606 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2609 <dd>The type of event to listen for</dd>
2612 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2615 <dd>The method the event invokes</dd>
2618 <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>
2621 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2624 <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>
2645 <td class="msource">
2647 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2653 <tr class="method-row config-row-alt1 expandable">
2654 <td class="micon"><a class="exi" href="#expand"> </a></td>
2658 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2659 <div class="fixedFont">
2660 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2669 <div class="short">Removes all listeners for this object</div>
2675 Removes all listeners for this object
2696 <td class="msource">
2698 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2704 <tr class="method-row config-row-alt0 expandable">
2705 <td class="micon"><a class="exi" href="#expand"> </a></td>
2709 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2710 <div class="fixedFont">
2711 <span class="attributes"></span><b class="itemname">removeListener</b>
2713 (<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>)
2720 <div class="short">Removes a listener</div>
2733 <dl class="detailList">
2734 <dt class="heading">Parameters:</dt>
2737 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2740 <dd>The type of event to listen for</dd>
2743 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2746 <dd>The handler to remove</dd>
2749 <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>
2752 <dd>(optional) The scope (this object) for the handler</dd>
2770 <td class="msource">
2772 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2778 <tr class="method-row config-row-alt1 expandable notInherited">
2779 <td class="micon"><a class="exi" href="#expand"> </a></td>
2783 <a id="Roo.grid.ColumnModel-method-setColumnHeader" name=".setColumnHeader"></a>
2784 <div class="fixedFont">
2785 <span class="attributes"></span><b class="itemname">setColumnHeader</b>
2787 (<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>)
2794 <div class="short">Sets the header for a column.</div>
2800 Sets the header for a column.
2807 <dl class="detailList">
2808 <dt class="heading">Parameters:</dt>
2811 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2814 <dd>The column index</dd>
2817 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>header</b>
2820 <dd>The new header</dd>
2838 <td class="msource">
2840 Roo.grid.ColumnModel
2846 <tr class="method-row config-row-alt0 expandable notInherited">
2847 <td class="micon"><a class="exi" href="#expand"> </a></td>
2851 <a id="Roo.grid.ColumnModel-method-setColumnTooltip" name=".setColumnTooltip"></a>
2852 <div class="fixedFont">
2853 <span class="attributes"></span><b class="itemname">setColumnTooltip</b>
2855 (<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>)
2862 <div class="short">Sets the tooltip for a column.</div>
2868 Sets the tooltip for a column.
2875 <dl class="detailList">
2876 <dt class="heading">Parameters:</dt>
2879 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2882 <dd>The column index</dd>
2885 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>tooltip</b>
2888 <dd>The new tooltip</dd>
2906 <td class="msource">
2908 Roo.grid.ColumnModel
2914 <tr class="method-row config-row-alt1 expandable notInherited">
2915 <td class="micon"><a class="exi" href="#expand"> </a></td>
2919 <a id="Roo.grid.ColumnModel-method-setColumnWidth" name=".setColumnWidth"></a>
2920 <div class="fixedFont">
2921 <span class="attributes"></span><b class="itemname">setColumnWidth</b>
2923 (<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>)
2930 <div class="short">Sets the width for a column.</div>
2936 Sets the width for a column.
2943 <dl class="detailList">
2944 <dt class="heading">Parameters:</dt>
2947 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
2950 <dd>The column index</dd>
2953 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2956 <dd>The new width</dd>
2974 <td class="msource">
2976 Roo.grid.ColumnModel
2982 <tr class="method-row config-row-alt0 expandable notInherited">
2983 <td class="micon"><a class="exi" href="#expand"> </a></td>
2987 <a id="Roo.grid.ColumnModel-method-setDataIndex" name=".setDataIndex"></a>
2988 <div class="fixedFont">
2989 <span class="attributes"></span><b class="itemname">setDataIndex</b>
2991 (<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>)
2998 <div class="short">Sets the dataIndex for a column.</div>
3004 Sets the dataIndex for a column.
3011 <dl class="detailList">
3012 <dt class="heading">Parameters:</dt>
3015 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
3018 <dd>The column index</dd>
3021 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>dataIndex</b>
3024 <dd>The new dataIndex</dd>
3042 <td class="msource">
3044 Roo.grid.ColumnModel
3050 <tr class="method-row config-row-alt1 expandable notInherited">
3051 <td class="micon"><a class="exi" href="#expand"> </a></td>
3055 <a id="Roo.grid.ColumnModel-method-setEditable" name=".setEditable"></a>
3056 <div class="fixedFont">
3057 <span class="attributes"></span><b class="itemname">setEditable</b>
3059 (<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>)
3066 <div class="short">Sets if a column is editable.</div>
3072 Sets if a column is editable.
3079 <dl class="detailList">
3080 <dt class="heading">Parameters:</dt>
3083 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
3086 <dd>The column index</dd>
3089 <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>
3092 <dd>True if the column is editable</dd>
3110 <td class="msource">
3112 Roo.grid.ColumnModel
3118 <tr class="method-row config-row-alt0 expandable notInherited">
3119 <td class="micon"><a class="exi" href="#expand"> </a></td>
3123 <a id="Roo.grid.ColumnModel-method-setEditor" name=".setEditor"></a>
3124 <div class="fixedFont">
3125 <span class="attributes"></span><b class="itemname">setEditor</b>
3127 (<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>)
3134 <div class="short">Sets the editor for a column.</div>
3140 Sets the editor for a column.
3147 <dl class="detailList">
3148 <dt class="heading">Parameters:</dt>
3151 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
3154 <dd>The column index</dd>
3157 <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>
3160 <dd>The editor object</dd>
3178 <td class="msource">
3180 Roo.grid.ColumnModel
3186 <tr class="method-row config-row-alt1 expandable notInherited">
3187 <td class="micon"><a class="exi" href="#expand"> </a></td>
3191 <a id="Roo.grid.ColumnModel-method-setHidden" name=".setHidden"></a>
3192 <div class="fixedFont">
3193 <span class="attributes"></span><b class="itemname">setHidden</b>
3195 (<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>)
3202 <div class="short">Sets if a column is hidden.</div>
3208 Sets if a column is hidden.
3215 <dl class="detailList">
3216 <dt class="heading">Parameters:</dt>
3219 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
3222 <dd>The column index</dd>
3225 <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>
3228 <dd>True if the column is hidden</dd>
3246 <td class="msource">
3248 Roo.grid.ColumnModel
3254 <tr class="method-row config-row-alt0 expandable notInherited">
3255 <td class="micon"><a class="exi" href="#expand"> </a></td>
3259 <a id="Roo.grid.ColumnModel-method-setRenderer" name=".setRenderer"></a>
3260 <div class="fixedFont">
3261 <span class="attributes"></span><b class="itemname">setRenderer</b>
3263 (<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>)
3270 <div class="short">Sets the rendering (formatting) function for a column.</div>
3276 Sets the rendering (formatting) function for a column.
3283 <dl class="detailList">
3284 <dt class="heading">Parameters:</dt>
3287 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
3290 <dd>The column index</dd>
3293 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
3296 <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>
3314 <td class="msource">
3316 Roo.grid.ColumnModel
3322 <tr class="method-row config-row-alt1 expandable">
3323 <td class="micon"><a class="exi" href="#expand"> </a></td>
3327 <a id="Roo.util.Observable-method-un" name=".un"></a>
3328 <div class="fixedFont">
3329 <span class="attributes"></span><b class="itemname">un</b>
3331 (<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>)
3338 <div class="short">Removes a listener (shorthand for removeListener)</div>
3344 Removes a listener (shorthand for removeListener)
3351 <dl class="detailList">
3352 <dt class="heading">Parameters:</dt>
3355 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3358 <dd>The type of event to listen for</dd>
3361 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3364 <dd>The handler to remove</dd>
3367 <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>
3370 <dd>(optional) The scope (this object) for the handler</dd>
3388 <td class="msource">
3390 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3399 <!-- ============================== events summary / details ======================== -->
3402 <a id="Roo.grid.ColumnModel-events"></a>
3411 <table cellspacing="0" class="member-table">
3412 <caption>Events</caption>
3415 <th class="sig-header" colspan="2">Event</th>
3416 <th class="msource-header">Defined By</th>
3425 <tr class="method-row expandable config-row-alt0 notInherited">
3426 <td class="micon"><a class="exi" href="#expand"> </a></td>
3429 <a id="Roo.grid.ColumnModel-event-*columlockchange"></a>
3431 <div class="fixedFont">
3432 <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>)
3438 <div class="short">Fires when a column's locked state is changed
3444 Fires when a column's locked state is changed
3450 <dl class="detailList">
3451 <dt class="heading">Parameters:</dt>
3454 <span class="fixedFont">ColumnModel</span> <b>this</b>
3460 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
3466 <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>
3469 <dd>true if locked</dd>
3487 <td class="msource">
3488 Roo.grid.ColumnModel
3492 <tr class="method-row expandable config-row-alt1 notInherited">
3493 <td class="micon"><a class="exi" href="#expand"> </a></td>
3496 <a id="Roo.grid.ColumnModel-event-*columnmoved"></a>
3498 <div class="fixedFont">
3499 <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>)
3505 <div class="short">Fires when a column is moved.
3511 Fires when a column is moved.
3517 <dl class="detailList">
3518 <dt class="heading">Parameters:</dt>
3521 <span class="fixedFont">ColumnModel</span> <b>this</b>
3527 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>oldIndex</b>
3533 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newIndex</b>
3554 <td class="msource">
3555 Roo.grid.ColumnModel
3559 <tr class="method-row expandable config-row-alt0 notInherited">
3560 <td class="micon"><a class="exi" href="#expand"> </a></td>
3563 <a id="Roo.grid.ColumnModel-event-*headerchange"></a>
3565 <div class="fixedFont">
3566 <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>)
3572 <div class="short">Fires when the text of a header changes.
3578 Fires when the text of a header changes.
3584 <dl class="detailList">
3585 <dt class="heading">Parameters:</dt>
3588 <span class="fixedFont">ColumnModel</span> <b>this</b>
3594 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3597 <dd>The column index</dd>
3600 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newText</b>
3603 <dd>The new header text</dd>
3621 <td class="msource">
3622 Roo.grid.ColumnModel
3626 <tr class="method-row expandable config-row-alt1 notInherited">
3627 <td class="micon"><a class="exi" href="#expand"> </a></td>
3630 <a id="Roo.grid.ColumnModel-event-*hiddenchange"></a>
3632 <div class="fixedFont">
3633 <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>)
3639 <div class="short">Fires when a column is hidden or "unhidden".
3645 Fires when a column is hidden or "unhidden".
3651 <dl class="detailList">
3652 <dt class="heading">Parameters:</dt>
3655 <span class="fixedFont">ColumnModel</span> <b>this</b>
3661 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3664 <dd>The column index</dd>
3667 <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>
3670 <dd>true if hidden, false otherwise</dd>
3688 <td class="msource">
3689 Roo.grid.ColumnModel
3693 <tr class="method-row expandable config-row-alt0 notInherited">
3694 <td class="micon"><a class="exi" href="#expand"> </a></td>
3697 <a id="Roo.grid.ColumnModel-event-*widthchange"></a>
3699 <div class="fixedFont">
3700 <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>)
3706 <div class="short">Fires when the width of a column changes.
3712 Fires when the width of a column changes.
3718 <dl class="detailList">
3719 <dt class="heading">Parameters:</dt>
3722 <span class="fixedFont">ColumnModel</span> <b>this</b>
3728 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3731 <dd>The column index</dd>
3734 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newWidth</b>
3737 <dd>The new width</dd>
3755 <td class="msource">
3756 Roo.grid.ColumnModel
3767 <!-- ============================== footer ================================= -->
3768 <div class="fineprint" style="clear:both">
3770 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Apr 25 2016 14:57:01 GMT+0800 (HKT)
3772 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>