- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.grid.PropertyColumnModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.grid.PropertyColumnModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.grid.PropertyColumnModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.grid.PropertyColumnModel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.grid.PropertyColumnModel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <div class="inheritance res-block">
-<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.grid.ColumnModel" ext:member="" href="output/Ext.grid.ColumnModel.html">ColumnModel</a>
- <img src="resources/elbow-end.gif"/>PropertyColumnModel</pre></div>
- <h1>Class Ext.grid.PropertyColumnModel</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/PropertyGrid.js" target="_blank">PropertyGrid.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">PropertyColumnModel</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.grid.ColumnModel" ext:member="" href="output/Ext.grid.ColumnModel.html">ColumnModel</a></td></tr>
- </table>
- <div class="description">
- A custom column model for the <a ext:cls="Ext.grid.PropertyGrid" href="output/Ext.grid.PropertyGrid.html">Ext.grid.PropertyGrid</a>. Generally it should not need to be used directly. </div>
-
- <div class="hr"></div>
- <a id="Ext.grid.PropertyColumnModel-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-align"></a>\r
- <b>align</b> : String <div class="mdesc">\r
- (optional) Set the CSS text-align property of the column. Defaults to undefined. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#align" href="output/Ext.grid.ColumnModel.html#align">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-css"></a>\r
- <b>css</b> : String <div class="mdesc">\r
- (optional) Set custom CSS for all table cells in the column (excluding headers). Defaults to undefined. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#css" href="output/Ext.grid.ColumnModel.html#css">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-dataIndex"></a>\r
- <b>dataIndex</b> : String <div class="mdesc">\r
- <div class="short">(optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the col...</div>\r
- <div class="long">\r
- (optional) The name of the field in the grid's <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a>'s <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> definition from which to draw the column's value. If not specified, the column's index is used as an index into the Record's data Array. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#dataIndex" href="output/Ext.grid.ColumnModel.html#dataIndex">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-editor"></a>\r
- <b>editor</b> : Ext.form.Field <div class="mdesc">\r
- (optional) The <a ext:cls="Ext.form.Field" href="output/Ext.form.Field.html">Ext.form.Field</a> to use when editing values in this column if editing is supported by the grid. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#editor" href="output/Ext.grid.ColumnModel.html#editor">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-fixed"></a>\r
- <b>fixed</b> : Boolean <div class="mdesc">\r
- (optional) True if the column width cannot be changed. Defaults to false. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#fixed" href="output/Ext.grid.ColumnModel.html#fixed">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-header"></a>\r
- <b>header</b> : String <div class="mdesc">\r
- The header text to display in the Grid view. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#header" href="output/Ext.grid.ColumnModel.html#header">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-hidden"></a>\r
- <b>hidden</b> : Boolean <div class="mdesc">\r
- (optional) True to hide the column. Defaults to false. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#hidden" href="output/Ext.grid.ColumnModel.html#hidden">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-hideable"></a>\r
- <b>hideable</b> : Boolean <div class="mdesc">\r
- <div class="short">(optional) Specify as false to prevent the user from hiding this column (defaults to true). To disallow column hiding...</div>\r
- <div class="long">\r
- (optional) Specify as <tt>false</tt> to prevent the user from hiding this column (defaults to true). To disallow column hiding globally for all columns in the grid, use <a ext:cls="Ext.grid.GridPanel" ext:member="enableColumnHide" href="output/Ext.grid.GridPanel.html#enableColumnHide">Ext.grid.GridPanel.enableColumnHide</a> instead. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#hideable" href="output/Ext.grid.ColumnModel.html#hideable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-id"></a>\r
- <b>id</b> : String <div class="mdesc">\r
- <div class="short">(optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to ...</div>\r
- <div class="long">\r
- (optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to create a CSS class name which is applied to all table cells (including headers) in that column. The class name takes the form of <pre>x-grid3-td-<b>id</b></pre> <br><br> Header cells will also recieve this class name, but will also have the class <pr>x-grid3-hd</pre>, so to target header cells, use CSS selectors such as:<pre>.x-grid3-hd.x-grid3-td-<b>id</b></pre> The <a ext:cls="Ext.grid.GridPanel" ext:member="autoExpandColumn" href="output/Ext.grid.GridPanel.html#autoExpandColumn">Ext.grid.GridPanel.autoExpandColumn</a> grid config option references the column via this identifier. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#id" href="output/Ext.grid.ColumnModel.html#id">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-listeners"></a>\r
- <b>listeners</b> : Object <div class="mdesc">\r
- <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
- <div class="long">\r
- (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-menuDisabled"></a>\r
- <b>menuDisabled</b> : Boolean <div class="mdesc">\r
- (optional) True to disable the column menu. Defaults to false. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#menuDisabled" href="output/Ext.grid.ColumnModel.html#menuDisabled">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-renderer"></a>\r
- <b>renderer</b> : Function <div class="mdesc">\r
- <div class="short">(optional) A function used to generate HTML markup for a cell given the cell's data value. See setRenderer. If not sp...</div>\r
- <div class="long">\r
- (optional) A function used to generate HTML markup for a cell given the cell's data value. See <a ext:cls="Ext.grid.ColumnModel" ext:member="setRenderer" href="output/Ext.grid.ColumnModel.html#setRenderer">setRenderer</a>. If not specified, the default renderer uses the raw data value. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#renderer" href="output/Ext.grid.ColumnModel.html#renderer">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-resizable"></a>\r
- <b>resizable</b> : Boolean <div class="mdesc">\r
- (optional) False to disable column resizing. Defaults to true. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#resizable" href="output/Ext.grid.ColumnModel.html#resizable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-sortable"></a>\r
- <b>sortable</b> : Boolean <div class="mdesc">\r
- <div class="short">(optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Wh...</div>\r
- <div class="long">\r
- (optional) True if sorting is to be allowed on this column. Defaults to the value of the <a ext:cls="Ext.grid.ColumnModel" ext:member="defaultSortable" href="output/Ext.grid.ColumnModel.html#defaultSortable">defaultSortable</a> property. Whether local/remote sorting is used is specified in <a ext:cls="Ext.data.Store" ext:member="remoteSort" href="output/Ext.data.Store.html#remoteSort">Ext.data.Store.remoteSort</a>. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#sortable" href="output/Ext.grid.ColumnModel.html#sortable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-tooltip"></a>\r
- <b>tooltip</b> : String <div class="mdesc">\r
- <div class="short">(optional) A text string to use as the column header's tooltip. If Quicktips are enabled, this value will be used as ...</div>\r
- <div class="long">\r
- (optional) A text string to use as the column header's tooltip. If Quicktips are enabled, this value will be used as the text of the quick tip, otherwise it will be set as the header's HTML title attribute. Defaults to ''. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#tooltip" href="output/Ext.grid.ColumnModel.html#tooltip">ColumnModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-width"></a>\r
- <b>width</b> : Number <div class="mdesc">\r
- <div class="short">(optional) The initial width in pixels of the column. This is ignored if the Grid's view is configured with forceFit ...</div>\r
- <div class="long">\r
- (optional) The initial width in pixels of the column. This is ignored if the Grid's <a ext:cls="Ext.grid.GridView" href="output/Ext.grid.GridView.html">view</a> is configured with <a ext:cls="Ext.grid.GridView" ext:member="forceFit" href="output/Ext.grid.GridView.html#forceFit">forceFit</a> true. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#width" href="output/Ext.grid.ColumnModel.html#width">ColumnModel</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.grid.PropertyColumnModel-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-defaultSortable"></a>\r
- <b>defaultSortable</b> : Boolean <div class="mdesc">\r
- Default sortable of columns which have no sortable specified (defaults to false) </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#defaultSortable" href="output/Ext.grid.ColumnModel.html#defaultSortable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-defaultWidth"></a>\r
- <b>defaultWidth</b> : Number <div class="mdesc">\r
- The width of columns which have no width specified (defaults to 100) </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#defaultWidth" href="output/Ext.grid.ColumnModel.html#defaultWidth">ColumnModel</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.grid.PropertyColumnModel-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-PropertyColumnModel"></a>\r
- <b>PropertyColumnModel</b>( <code>Ext.grid.Grid grid</code>, <code>Object source</code> ) <div class="mdesc">\r
- <div class="short"></div>\r
- <div class="long">\r
- <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>grid</code> : Ext.grid.Grid<div class="sub-desc">The grid this store will be bound to</div></li><li><code>source</code> : Object<div class="sub-desc">The source data config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">PropertyColumnModel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-addEvents"></a>\r
- <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">\r
- <div class="short">Used to define events on this Observable</div>\r
- <div class="long">\r
- Used to define events on this Observable <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-addListener"></a>\r
- <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this component</div>\r
- <div class="long">\r
- Appends an event handler to this component <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.grid.ColumnModel.html" ext:member="" ext:cls="Ext.grid.ColumnModel">ColumnModel</a> <img src="resources/elbow-end.gif">PropertyColumnModel</pre></div><h1>Class <a href="source/PropertyGrid.html#cls-Ext.grid.PropertyColumnModel">Ext.grid.PropertyColumnModel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">PropertyGrid.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/PropertyGrid.html#cls-Ext.grid.PropertyColumnModel">PropertyColumnModel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.ColumnModel.html" ext:cls="Ext.grid.ColumnModel" ext:member="">ColumnModel</a></td></tr></table><div class="description">A custom column model for the <a href="output/Ext.grid.PropertyGrid.html" ext:cls="Ext.grid.PropertyGrid">Ext.grid.PropertyGrid</a>. Generally it should not need to be used directly.</div><div class="hr"></div><a id="Ext.grid.PropertyColumnModel-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-columns"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-columns">columns</a></b> : Array<div class="mdesc"><div class="short">An Array of object literals. The config options defined by\r
+Ext.grid.Column are the options which may appear in the o...</div><div class="long">An Array of object literals. The config options defined by
+<b><a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a></b> are the options which may appear in the object literal for each
+individual column definition.</div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#columns" ext:member="#columns" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-defaultSortable"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-defaultSortable">defaultSortable</a></b> : Boolean<div class="mdesc"><div class="short">Default sortable of columns which have no\r
+sortable specified (defaults to false). This property shall preferably be ...</div><div class="long">Default sortable of columns which have no
+sortable specified (defaults to <tt>false</tt>). This property shall preferably be configured
+through the <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaults" ext:member="defaults" ext:cls="Ext.grid.ColumnModel">defaults</a></b></tt> config property.</div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#defaultSortable" ext:member="#defaultSortable" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-defaultWidth"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-defaultWidth">defaultWidth</a></b> : Number<div class="mdesc"><div class="short">The width of columns which have no width\r
+specified (defaults to 100). This property shall preferably be configured t...</div><div class="long">The width of columns which have no <tt><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-width" ext:member="width" ext:cls="Ext.grid.ColumnModel">width</a></tt>
+specified (defaults to <tt>100</tt>). This property shall preferably be configured through the
+<tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaults" ext:member="defaults" ext:cls="Ext.grid.ColumnModel">defaults</a></b></tt> config property.</div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#defaultWidth" ext:member="#defaultWidth" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-defaults"></a><b><a href="source/ColumnModel.html#cfg-Ext.grid.ColumnModel-defaults">defaults</a></b> : Object<div class="mdesc"><div class="short">Object literal which will be used to apply Ext.grid.Column\r
+configuration options to all columns. Configuration optio...</div><div class="long">Object literal which will be used to apply <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a>
+configuration options to all <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-columns" ext:member="columns" ext:cls="Ext.grid.ColumnModel">columns</a></b></tt>. Configuration options specified with
+individual <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">column</a> configs will supersede these <tt><b><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-defaults" ext:member="defaults" ext:cls="Ext.grid.ColumnModel">defaults</a></b></tt>.</div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#defaults" ext:member="#defaults" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this\r
+object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
+object during initialization. This should be a valid listeners config object as specified in the
+<a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
+<br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
+<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
+<b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
+has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
+<i>// The Component is appended to the argument list of all handler functions.</i>
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: <b>function</b>(config) {
+ this.listeners = config.listeners ? config.listeners : config;
+ },
+
+ <i>// Component passes itself into plugin's init method</i>
+ init: <b>function</b>(c) {
+ <b>var</b> p, l = this.listeners;
+ <b>for</b> (p <b>in</b> l) {
+ <b>if</b> (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } <b>else</b> {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
+
+ <i>// Add the listeners to the Element immediately following the render call</i>
+ c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
+ <b>var</b> e = c.getEl();
+ <b>if</b> (e) {
+ e.on(l);
+ }
+ });
+ },
+
+ createHandler: <b>function</b>(fn, c) {
+ <b>return</b> <b>function</b>(e) {
+ fn.call(this, e, c);
+ };
+ }
+});
+
+<b>var</b> combo = <b>new</b> Ext.form.ComboBox({
+
+ <i>// Collapse combo when its element is clicked on</i>
+ plugins: [ <b>new</b> Ext.DomObserver({
+ click: <b>function</b>(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: <em>'local'</em>,
+ triggerAction: <em>'all'</em>
+});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.grid.PropertyColumnModel-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-config"></a><b><a href="source/ColumnModel.html#prop-Ext.grid.ColumnModel-config">config</a></b> : Array<div class="mdesc"><div class="short">An Array of Column definition objects representing the configuration\r
+of this ColumnModel. See Ext.grid.Column for th...</div><div class="long">An Array of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Column definition</a> objects representing the configuration
+of this ColumnModel. See <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> for the configuration properties that may
+be specified.</div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#config" ext:member="#config" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr></tbody></table><a id="Ext.grid.PropertyColumnModel-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.PropertyColumnModel-PropertyColumnModel"></a><b><a href="source/PropertyGrid.html#cls-Ext.grid.PropertyColumnModel">PropertyColumnModel</a></b>( <code>Ext.grid.Grid grid</code>, <code>Object source</code> )\r
+ <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>grid</code> : Ext.grid.Grid<div class="sub-desc">The grid this store will be bound to</div></li><li><code>source</code> : Object<div class="sub-desc">The source data config object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">PropertyColumnModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object|String o</code>, <code>string Optional.</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
+or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
+Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
properties. This may contain any of the following properties:<ul>
-<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
-<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
-<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
-<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
+<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li>
+<li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
+<li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
+<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
by the specified number of milliseconds. If the event fires again within that time, the original
-handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
+handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
+<li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
+if the event was bubbled up from a child Observable.</div></li>
</ul><br>
<p>
<b>Combining Options</b><br>
Using the options argument, it is possible to combine different types of listeners:<br>
<br>
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
-<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
- single: true,
- delay: 100,
- forumId: 4
+A delayed, one-time listener.
+<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
+single: true,
+delay: 100
});</code></pre>
<p>
<b>Attaching multiple handlers in 1 call</b><br>
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
<p>
-<pre><code>foo.on({
- <em>'click'</em> : {
- fn: <b>this</b>.onClick,
- scope: <b>this</b>,
- delay: 100
- },
- <em>'mouseover'</em> : {
- fn: <b>this</b>.onMouseOver,
- scope: <b>this</b>
- },
- <em>'mouseout'</em> : {
- fn: <b>this</b>.onMouseOut,
- scope: <b>this</b>
- }
+<pre><code>myGridPanel.on({
+<em>'click'</em> : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+<em>'mouseover'</em> : {
+ fn: this.onMouseOver,
+ scope: this
+},
+<em>'mouseout'</em> : {
+ fn: this.onMouseOut,
+ scope: this
+}
});</code></pre>
<p>
Or a shorthand syntax:<br>
-<pre><code>foo.on({
- <em>'click'</em> : <b>this</b>.onClick,
- <em>'mouseover'</em> : <b>this</b>.onMouseOver,
- <em>'mouseout'</em> : <b>this</b>.onMouseOut,
- scope: <b>this</b>
-});</code></pre></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-findColumnIndex"></a>\r
- <b>findColumnIndex</b>( <code>String col</code> ) : Number <div class="mdesc">\r
- <div class="short">Finds the index of the first matching column for the given dataIndex.</div>\r
- <div class="long">\r
- Finds the index of the first matching column for the given dataIndex. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : String<div class="sub-desc">The dataIndex to find</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The column index, or -1 if no match was found</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#findColumnIndex" href="output/Ext.grid.ColumnModel.html#findColumnIndex">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-fireEvent"></a>\r
- <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
- <div class="long">\r
- Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getCellEditor"></a>\r
- <b>getCellEditor</b>( <code>Number colIndex</code>, <code>Number rowIndex</code> ) : Ext.Editor <div class="mdesc">\r
- <div class="short">Returns the editor defined for the cell/column.</div>\r
- <div class="long">\r
- Returns the editor defined for the cell/column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Editor</code><div class="sub-desc">The {@link Ext.Editor Editor} that was created to wrap the {@link Ext.form.Field Field} used to edit the cell.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getCellEditor" href="output/Ext.grid.ColumnModel.html#getCellEditor">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getColumnById"></a>\r
- <b>getColumnById</b>( <code>String id</code> ) : Object <div class="mdesc">\r
- <div class="short">Returns the column for a specified id.</div>\r
- <div class="long">\r
- Returns the column for a specified id. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">the column</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getColumnById" href="output/Ext.grid.ColumnModel.html#getColumnById">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getColumnCount"></a>\r
- <b>getColumnCount</b>( <code>Boolean visibleOnly</code> ) : Number <div class="mdesc">\r
- <div class="short">Returns the number of columns.</div>\r
- <div class="long">\r
- Returns the number of columns. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>visibleOnly</code> : Boolean<div class="sub-desc">Optional. Pass as true to only include visible columns.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getColumnCount" href="output/Ext.grid.ColumnModel.html#getColumnCount">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getColumnHeader"></a>\r
- <b>getColumnHeader</b>( <code>Number col</code> ) : String <div class="mdesc">\r
- <div class="short">Returns the header for the specified column.</div>\r
- <div class="long">\r
- Returns the header for the specified column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getColumnHeader" href="output/Ext.grid.ColumnModel.html#getColumnHeader">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getColumnId"></a>\r
- <b>getColumnId</b>( <code>Number index</code> ) : String <div class="mdesc">\r
- <div class="short">
-Returns the id of the column at the specified index.</div>\r
- <div class="long">\r
-
-Returns the id of the column at the specified index. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>index</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">the id</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getColumnId" href="output/Ext.grid.ColumnModel.html#getColumnId">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getColumnTooltip"></a>\r
- <b>getColumnTooltip</b>( <code>Number col</code> ) : String <div class="mdesc">\r
- <div class="short">Returns the tooltip for the specified column.</div>\r
- <div class="long">\r
- Returns the tooltip for the specified column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getColumnTooltip" href="output/Ext.grid.ColumnModel.html#getColumnTooltip">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getColumnWidth"></a>\r
- <b>getColumnWidth</b>( <code>Number col</code> ) : Number <div class="mdesc">\r
- <div class="short">Returns the width for the specified column.</div>\r
- <div class="long">\r
- Returns the width for the specified column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getColumnWidth" href="output/Ext.grid.ColumnModel.html#getColumnWidth">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getColumnsBy"></a>\r
- <b>getColumnsBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Returns the column configs that return true by the passed function that is called with (columnConfig, index)</div>\r
- <div class="long">\r
- Returns the column configs that return true by the passed function that is called with (columnConfig, index) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">result</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getColumnsBy" href="output/Ext.grid.ColumnModel.html#getColumnsBy">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getDataIndex"></a>\r
- <b>getDataIndex</b>( <code>Number col</code> ) : String <div class="mdesc">\r
- <div class="short">Returns the dataIndex for the specified column.</div>\r
- <div class="long">\r
- Returns the dataIndex for the specified column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The column's dataIndex</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getDataIndex" href="output/Ext.grid.ColumnModel.html#getDataIndex">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getIndexById"></a>\r
- <b>getIndexById</b>( <code>String id</code> ) : Number <div class="mdesc">\r
- <div class="short">Returns the index for a specified column id.</div>\r
- <div class="long">\r
- Returns the index for a specified column id. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">the index, or -1 if not found</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getIndexById" href="output/Ext.grid.ColumnModel.html#getIndexById">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getRenderer"></a>\r
- <b>getRenderer</b>( <code>Number col</code> ) : Function <div class="mdesc">\r
- <div class="short">Returns the rendering (formatting) function defined for the column.</div>\r
- <div class="long">\r
- Returns the rendering (formatting) function defined for the column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Function</code><div class="sub-desc">The function used to render the cell. See {@link #setRenderer}.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getRenderer" href="output/Ext.grid.ColumnModel.html#getRenderer">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-getTotalWidth"></a>\r
- <b>getTotalWidth</b>( <code>Boolean includeHidden</code> ) : Number <div class="mdesc">\r
- <div class="short">Returns the total width of all columns.</div>\r
- <div class="long">\r
- Returns the total width of all columns. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>includeHidden</code> : Boolean<div class="sub-desc">True to include hidden column widths</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#getTotalWidth" href="output/Ext.grid.ColumnModel.html#getTotalWidth">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-hasListener"></a>\r
- <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
- <div class="long">\r
- Checks to see if this object has any listeners for a specified event <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-isCellEditable"></a>\r
- <b>isCellEditable</b>( <code>Number colIndex</code>, <code>Number rowIndex</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the cell is editable.</div>\r
- <div class="long">\r
- Returns true if the cell is editable. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#isCellEditable" href="output/Ext.grid.ColumnModel.html#isCellEditable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-isFixed"></a>\r
- <b>isFixed</b>() : void <div class="mdesc">\r
- <div class="short">Returns true if the column width cannot be changed</div>\r
- <div class="long">\r
- Returns true if the column width cannot be changed <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#isFixed" href="output/Ext.grid.ColumnModel.html#isFixed">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-isHidden"></a>\r
- <b>isHidden</b>( <code>Number colIndex</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the column is hidden.</div>\r
- <div class="long">\r
- Returns true if the column is hidden. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#isHidden" href="output/Ext.grid.ColumnModel.html#isHidden">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-isMenuDisabled"></a>\r
- <b>isMenuDisabled</b>( <code>Number col</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the specified column menu is disabled.</div>\r
- <div class="long">\r
- Returns true if the specified column menu is disabled. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#isMenuDisabled" href="output/Ext.grid.ColumnModel.html#isMenuDisabled">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-isResizable"></a>\r
- <b>isResizable</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the column can be resized</div>\r
- <div class="long">\r
- Returns true if the column can be resized <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#isResizable" href="output/Ext.grid.ColumnModel.html#isResizable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-isSortable"></a>\r
- <b>isSortable</b>( <code>Number col</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the specified column is sortable.</div>\r
- <div class="long">\r
- Returns true if the specified column is sortable. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#isSortable" href="output/Ext.grid.ColumnModel.html#isSortable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-moveColumn"></a>\r
- <b>moveColumn</b>( <code>Number oldIndex</code>, <code>Number newIndex</code> ) : void <div class="mdesc">\r
- <div class="short">Moves a column from one position to another.</div>\r
- <div class="long">\r
- Moves a column from one position to another. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>oldIndex</code> : Number<div class="sub-desc">The index of the column to move.</div></li><li><code>newIndex</code> : Number<div class="sub-desc">The position at which to reinsert the coolumn.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#moveColumn" href="output/Ext.grid.ColumnModel.html#moveColumn">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-on"></a>\r
- <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
- <div class="long">\r
- Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-purgeListeners"></a>\r
- <b>purgeListeners</b>() : void <div class="mdesc">\r
- <div class="short">Removes all listeners for this object</div>\r
- <div class="long">\r
- Removes all listeners for this object <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-relayEvents"></a>\r
- <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">\r
- <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
- <div class="long">\r
- Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-removeListener"></a>\r
- <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener</div>\r
- <div class="long">\r
- Removes a listener <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-resumeEvents"></a>\r
- <b>resumeEvents</b>() : void <div class="mdesc">\r
- <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
- <div class="long">\r
- Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setColumnHeader"></a>\r
- <b>setColumnHeader</b>( <code>Number col</code>, <code>String header</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the header for a column.</div>\r
- <div class="long">\r
- Sets the header for a column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>header</code> : String<div class="sub-desc">The new header</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setColumnHeader" href="output/Ext.grid.ColumnModel.html#setColumnHeader">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setColumnTooltip"></a>\r
- <b>setColumnTooltip</b>( <code>Number col</code>, <code>String tooltip</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the tooltip for a column.</div>\r
- <div class="long">\r
- Sets the tooltip for a column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>tooltip</code> : String<div class="sub-desc">The new tooltip</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setColumnTooltip" href="output/Ext.grid.ColumnModel.html#setColumnTooltip">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setColumnWidth"></a>\r
- <b>setColumnWidth</b>( <code>Number col</code>, <code>Number width</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the width for a column.</div>\r
- <div class="long">\r
- Sets the width for a column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>width</code> : Number<div class="sub-desc">The new width</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setColumnWidth" href="output/Ext.grid.ColumnModel.html#setColumnWidth">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setConfig"></a>\r
- <b>setConfig</b>( <code>Array config</code> ) : void <div class="mdesc">\r
- <div class="short">Reconfigures this column model according to the passed Array of column definition objects. For a description of
-the i...</div>\r
- <div class="long">\r
- <p>Reconfigures this column model according to the passed Array of column definition objects. For a description of
-the individual properties of a column definition object, see the <a href="#Ext.grid.ColumnModel-configs">Config Options</a>.</p>
-<p>Causes the <a ext:cls="Ext.grid.ColumnModel" ext:member="configchange" href="output/Ext.grid.ColumnModel.html#configchange">configchange</a> event to be fired. A <a ext:cls="Ext.grid.GridPanel" href="output/Ext.grid.GridPanel.html">GridPanel</a> using
-this ColumnModel will listen for this event and refresh its UI automatically.</p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : Array<div class="sub-desc">Array of Column definition objects.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setConfig" href="output/Ext.grid.ColumnModel.html#setConfig">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setDataIndex"></a>\r
- <b>setDataIndex</b>( <code>Number col</code>, <code>String dataIndex</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the dataIndex for a column.</div>\r
- <div class="long">\r
- Sets the dataIndex for a column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>dataIndex</code> : String<div class="sub-desc">The new dataIndex</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setDataIndex" href="output/Ext.grid.ColumnModel.html#setDataIndex">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setEditable"></a>\r
- <b>setEditable</b>( <code>Number col</code>, <code>Boolean editable</code> ) : void <div class="mdesc">\r
- <div class="short">Sets if a column is editable.</div>\r
- <div class="long">\r
- Sets if a column is editable. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>editable</code> : Boolean<div class="sub-desc">True if the column is editable</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setEditable" href="output/Ext.grid.ColumnModel.html#setEditable">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setEditor"></a>\r
- <b>setEditor</b>( <code>Number col</code>, <code>Object editor</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the editor for a column.</div>\r
- <div class="long">\r
- Sets the editor for a column. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>editor</code> : Object<div class="sub-desc">The editor object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setEditor" href="output/Ext.grid.ColumnModel.html#setEditor">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setHidden"></a>\r
- <b>setHidden</b>( <code>Number colIndex</code>, <code>Boolean hidden</code> ) : void <div class="mdesc">\r
- <div class="short">Sets if a column is hidden.</div>\r
- <div class="long">\r
- Sets if a column is hidden. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>hidden</code> : Boolean<div class="sub-desc">True if the column is hidden</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setHidden" href="output/Ext.grid.ColumnModel.html#setHidden">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-setRenderer"></a>\r
- <b>setRenderer</b>( <code>Number col</code>, <code>Function fn</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the rendering (formatting) function for a column. See <a ext:cls="Ext.util.Format" href="output/Ext.util.Format.html">Ext.util.Format</a> for some
-default formatting functions.</div>\r
- <div class="long">\r
- Sets the rendering (formatting) function for a column. See <a ext:cls="Ext.util.Format" href="output/Ext.util.Format.html">Ext.util.Format</a> for some
-default formatting functions. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>fn</code> : Function<div class="sub-desc">The function to use to process the cell's raw data
+<pre><code>myGridPanel.on({
+<em>'click'</em> : this.onClick,
+<em>'mouseover'</em> : this.onMouseOver,
+<em>'mouseout'</em> : this.onMouseOut,
+ scope: this
+});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-destroy"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-destroy">destroy</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Destroys this column model by purging any event listeners, and removing any editors.</div><div class="long">Destroys this column model by purging any event listeners, and removing any editors.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#destroy" ext:member="#destroy" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>String/Array events</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling \r
+this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
+<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
+<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
+access the required target more quickly.</p>\r
+<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
+ <i>// Add functionality to Field's initComponent to enable the change event to bubble\r</i>
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
+ this.enableBubble(<em>'change'</em>);\r
+ }),\r
+\r
+ <i>// We know that we want Field's events to bubble directly to the FormPanel.\r</i>
+ getBubbleTarget : <b>function</b>() {\r
+ <b>if</b> (!this.formPanel) {\r
+ this.formPanel = this.findParentByType(<em>'form'</em>);\r
+ }\r
+ <b>return</b> this.formPanel;\r
+ }\r
+});\r
+\r
+<b>var</b> myForm = <b>new</b> Ext.formPanel({\r
+ title: <em>'User Details'</em>,\r
+ items: [{\r
+ ...\r
+ }],\r
+ listeners: {\r
+ change: <b>function</b>() {\r
+ <i>// Title goes red <b>if</b> form has been modified.\r</i>
+ myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
+ }\r
+ }\r
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-findColumnIndex"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-findColumnIndex">findColumnIndex</a></b>( <code>String col</code> )\r
+ :\r
+ Number<div class="mdesc"><div class="short">Finds the index of the first matching column for the given dataIndex.</div><div class="long">Finds the index of the first matching column for the given dataIndex.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : String<div class="sub-desc">The dataIndex to find</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The column index, or -1 if no match was found</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#findColumnIndex" ext:member="#findColumnIndex" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).\r
+An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
+<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
+by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getCellEditor"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getCellEditor">getCellEditor</a></b>( <code>Number colIndex</code>, <code>Number rowIndex</code> )\r
+ :\r
+ Ext.Editor<div class="mdesc"><div class="short">Returns the editor defined for the cell/column.</div><div class="long">Returns the editor defined for the cell/column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Editor</code><div class="sub-desc">The {@link Ext.Editor Editor} that was created to wrap\r
+the {@link Ext.form.Field Field} used to edit the cell.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getCellEditor" ext:member="#getCellEditor" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnById"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnById">getColumnById</a></b>( <code>String id</code> )\r
+ :\r
+ Object<div class="mdesc"><div class="short">Returns the column for a specified id.</div><div class="long">Returns the column for a specified id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">the column</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getColumnById" ext:member="#getColumnById" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnCount"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnCount">getColumnCount</a></b>( <code>Boolean visibleOnly</code> )\r
+ :\r
+ Number<div class="mdesc"><div class="short">Returns the number of columns.</div><div class="long">Returns the number of columns.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>visibleOnly</code> : Boolean<div class="sub-desc">Optional. Pass as true to only include visible columns.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getColumnCount" ext:member="#getColumnCount" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnHeader"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnHeader">getColumnHeader</a></b>( <code>Number col</code> )\r
+ :\r
+ String<div class="mdesc"><div class="short">Returns the header for the specified column.</div><div class="long">Returns the header for the specified column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getColumnHeader" ext:member="#getColumnHeader" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnId"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnId">getColumnId</a></b>( <code>Number index</code> )\r
+ :\r
+ String<div class="mdesc"><div class="short">Returns the id of the column at the specified index.</div><div class="long">Returns the id of the column at the specified index.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">the id</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getColumnId" ext:member="#getColumnId" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnTooltip"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnTooltip">getColumnTooltip</a></b>( <code>Number col</code> )\r
+ :\r
+ String<div class="mdesc"><div class="short">Returns the tooltip for the specified column.</div><div class="long">Returns the tooltip for the specified column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getColumnTooltip" ext:member="#getColumnTooltip" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnWidth"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnWidth">getColumnWidth</a></b>( <code>Number col</code> )\r
+ :\r
+ Number<div class="mdesc"><div class="short">Returns the width for the specified column.</div><div class="long">Returns the width for the specified column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getColumnWidth" ext:member="#getColumnWidth" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getColumnsBy"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getColumnsBy">getColumnsBy</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ Array<div class="mdesc"><div class="short">Returns the column configs that return true by the passed function that is called\r
+with (columnConfig, index)\r
+// retur...</div><div class="long">Returns the column configs that return true by the passed function that is called
+with (columnConfig, index)
+<pre><code><i>// returns an array of column config objects <b>for</b> all hidden columns</i>
+<b>var</b> columns = grid.getColumnModel().getColumnsBy(<b>function</b>(c){
+ <b>return</b> c.hidden;
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">A function which, when passed a <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Column</a> object, must
+return <code>true</code> if the column is to be included in the returned Array.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code>this</code> reference) in which the function
+is executed. Defaults to this ColumnModel.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">result</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getColumnsBy" ext:member="#getColumnsBy" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getDataIndex"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getDataIndex">getDataIndex</a></b>( <code>Number col</code> )\r
+ :\r
+ String<div class="mdesc"><div class="short">Returns the dataIndex for the specified column.\r
+// Get field name for the column\r
+var fieldName = grid.getColumnModel(...</div><div class="long">Returns the dataIndex for the specified column.
+<pre><code><i>// Get field name <b>for</b> the column</i>
+<b>var</b> fieldName = grid.getColumnModel().getDataIndex(columnIndex);</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The column's dataIndex</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getDataIndex" ext:member="#getDataIndex" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getIndexById"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getIndexById">getIndexById</a></b>( <code>String id</code> )\r
+ :\r
+ Number<div class="mdesc"><div class="short">Returns the index for a specified column id.</div><div class="long">Returns the index for a specified column id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The column id</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">the index, or -1 if not found</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getIndexById" ext:member="#getIndexById" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getRenderer"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getRenderer">getRenderer</a></b>( <code>Number col</code> )\r
+ :\r
+ Function<div class="mdesc"><div class="short">Returns the rendering (formatting) function defined for the column.</div><div class="long">Returns the rendering (formatting) function defined for the column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index.</div></li></ul><strong>Returns:</strong><ul><li><code>Function</code><div class="sub-desc">The function used to render the cell. See {@link #setRenderer}.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getRenderer" ext:member="#getRenderer" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-getTotalWidth"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-getTotalWidth">getTotalWidth</a></b>( <code>Boolean includeHidden</code> )\r
+ :\r
+ Number<div class="mdesc"><div class="short">Returns the total width of all columns.</div><div class="long">Returns the total width of all columns.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>includeHidden</code> : Boolean<div class="sub-desc">True to include hidden column widths</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#getTotalWidth" ext:member="#getTotalWidth" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isCellEditable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isCellEditable">isCellEditable</a></b>( <code>Number colIndex</code>, <code>Number rowIndex</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the cell is editable.\r
+var store = new Ext.data.Store({...});\r
+var colModel = new Ext.grid.ColumnModel(...</div><div class="long">Returns true if the cell is editable.
+<pre><code><b>var</b> store = <b>new</b> Ext.data.Store({...});
+<b>var</b> colModel = <b>new</b> Ext.grid.ColumnModel({
+ columns: [...],
+ isCellEditable: <b>function</b>(col, row) {
+ <b>var</b> record = store.getAt(row);
+ <b>if</b> (record.get(<em>'readonly'</em>)) { <i>// replace <b>with</b> your condition</i>
+ <b>return</b> false;
+ }
+ <b>return</b> Ext.grid.ColumnModel.prototype.isCellEditable.call(this, col, row);
+ }
+});
+<b>var</b> grid = <b>new</b> Ext.grid.GridPanel({
+ store: store,
+ colModel: colModel,
+ ...
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#isCellEditable" ext:member="#isCellEditable" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isFixed"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isFixed">isFixed</a></b>( <code>Number colIndex</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the column is fixed,\r
+false otherwise.</div><div class="long">Returns <tt>true</tt> if the column is <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-fixed" ext:member="fixed" ext:cls="Ext.grid.Column">fixed</a></code>,
+<tt>false</tt> otherwise.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#isFixed" ext:member="#isFixed" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isHidden"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isHidden">isHidden</a></b>( <code>Number colIndex</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the column is hidden,\r
+false otherwise.</div><div class="long">Returns <tt>true</tt> if the column is <code><a href="output/Ext.grid.Column.html#Ext.grid.Column-hidden" ext:member="hidden" ext:cls="Ext.grid.Column">hidden</a></code>,
+<tt>false</tt> otherwise.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#isHidden" ext:member="#isHidden" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isMenuDisabled"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isMenuDisabled">isMenuDisabled</a></b>( <code>Number col</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the specified column menu is disabled.</div><div class="long">Returns true if the specified column menu is disabled.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#isMenuDisabled" ext:member="#isMenuDisabled" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isResizable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isResizable">isResizable</a></b>()\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the column can be resized</div><div class="long">Returns true if the column can be resized<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#isResizable" ext:member="#isResizable" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-isSortable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-isSortable">isSortable</a></b>( <code>Number col</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the specified column is sortable.</div><div class="long">Returns true if the specified column is sortable.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#isSortable" ext:member="#isSortable" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-moveColumn"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-moveColumn">moveColumn</a></b>( <code>Number oldIndex</code>, <code>Number newIndex</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Moves a column from one position to another.</div><div class="long">Moves a column from one position to another.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>oldIndex</code> : Number<div class="sub-desc">The index of the column to move.</div></li><li><code>newIndex</code> : Number<div class="sub-desc">The position at which to reinsert the coolumn.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#moveColumn" ext:member="#moveColumn" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>( <code>Object o</code>, <code>Array events</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)\r
+If events were suspended using the queueSuspended parameter, then all\r
+event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
+If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
+events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setColumnHeader"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setColumnHeader">setColumnHeader</a></b>( <code>Number col</code>, <code>String header</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets the header for a column.</div><div class="long">Sets the header for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>header</code> : String<div class="sub-desc">The new header</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setColumnHeader" ext:member="#setColumnHeader" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setColumnTooltip"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setColumnTooltip">setColumnTooltip</a></b>( <code>Number col</code>, <code>String tooltip</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets the tooltip for a column.</div><div class="long">Sets the tooltip for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>tooltip</code> : String<div class="sub-desc">The new tooltip</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setColumnTooltip" ext:member="#setColumnTooltip" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setColumnWidth"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setColumnWidth">setColumnWidth</a></b>( <code>Number col</code>, <code>Number width</code>, <code>Boolean suppressEvent</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets the width for a column.</div><div class="long">Sets the width for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>suppressEvent</code> : Boolean<div class="sub-desc">True to suppress firing the <code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-widthchange" ext:member="widthchange" ext:cls="Ext.grid.ColumnModel">widthchange</a></code>
+event. Defaults to false.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setColumnWidth" ext:member="#setColumnWidth" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setConfig"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setConfig">setConfig</a></b>( <code>Array config</code>, <code>Boolean initial</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Reconfigures this column model according to the passed Array of column definition objects.\r
+For a description of the i...</div><div class="long"><p>Reconfigures this column model according to the passed Array of column definition objects.
+For a description of the individual properties of a column definition object, see the
+<a href="#Ext.grid.ColumnModel-configs">Config Options</a>.</p>
+<p>Causes the <a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-configchange" ext:member="configchange" ext:cls="Ext.grid.ColumnModel">configchange</a> event to be fired. A <a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">GridPanel</a>
+using this ColumnModel will listen for this event and refresh its UI automatically.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Array<div class="sub-desc">Array of Column definition objects.</div></li><li><code>initial</code> : Boolean<div class="sub-desc">Specify <tt>true</tt> to bypass cleanup which deletes the <tt>totalWidth</tt>
+and destroys existing editors.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setConfig" ext:member="#setConfig" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setDataIndex"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setDataIndex">setDataIndex</a></b>( <code>Number col</code>, <code>String dataIndex</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets the dataIndex for a column.</div><div class="long">Sets the dataIndex for a column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>dataIndex</code> : String<div class="sub-desc">The new dataIndex</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setDataIndex" ext:member="#setDataIndex" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setEditable"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setEditable">setEditable</a></b>( <code>Number col</code>, <code>Boolean editable</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets if a column is editable.</div><div class="long">Sets if a column is editable.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>editable</code> : Boolean<div class="sub-desc">True if the column is editable</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setEditable" ext:member="#setEditable" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setEditor"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setEditor">setEditor</a></b>( <code>Number col</code>, <code>Object editor</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets the editor for a column and destroys the prior editor.</div><div class="long">Sets the editor for a column and destroys the prior editor.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>editor</code> : Object<div class="sub-desc">The editor object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setEditor" ext:member="#setEditor" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setHidden"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setHidden">setHidden</a></b>( <code>Number colIndex</code>, <code>Boolean hidden</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets if a column is hidden.\r
+myGrid.getColumnModel().setHidden(0, true); // hide column 0 (0 = the first column).</div><div class="long">Sets if a column is hidden.
+<pre><code>myGrid.getColumnModel().setHidden(0, true); <i>// hide column 0 (0 = the first column).</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>colIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>hidden</code> : Boolean<div class="sub-desc">True if the column is hidden</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setHidden" ext:member="#setHidden" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-setRenderer"></a><b><a href="source/ColumnModel.html#method-Ext.grid.ColumnModel-setRenderer">setRenderer</a></b>( <code>Number col</code>, <code>Function fn</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Sets the rendering (formatting) function for a column. See Ext.util.Format for some\r
+default formatting functions.</div><div class="long">Sets the rendering (formatting) function for a column. See <a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">Ext.util.Format</a> for some
+default formatting functions.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>col</code> : Number<div class="sub-desc">The column index</div></li><li><code>fn</code> : Function<div class="sub-desc">The function to use to process the cell's raw data
to return HTML markup for the grid view. The render function is called with
the following parameters:<ul>
<li><b>value</b> : Object<p class="sub-desc">The data value for the cell.</p></li>
<li><b>css</b> : String<p class="sub-desc">A CSS class name to add to the cell's TD element.</p></li>
<li><b>attr</b> : String<p class="sub-desc">An HTML attribute definition string to apply to the data container element <i>within</i> the table cell
(e.g. 'style="color:red;"').</p></li></ul></p></li>
-<li><b>record</b> : Ext.data.record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> from which the data was extracted.</p></li>
+<li><b>record</b> : Ext.data.record<p class="sub-desc">The <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> from which the data was extracted.</p></li>
<li><b>rowIndex</b> : Number<p class="sub-desc">Row index</p></li>
<li><b>colIndex</b> : Number<p class="sub-desc">Column index</p></li>
-<li><b>store</b> : Ext.data.Store<p class="sub-desc">The <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> object from which the Record was extracted.</p></li></ul></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#setRenderer" href="output/Ext.grid.ColumnModel.html#setRenderer">ColumnModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-suspendEvents"></a>\r
- <b>suspendEvents</b>() : void <div class="mdesc">\r
- <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
- <div class="long">\r
- Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-un"></a>\r
- <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener (shorthand for removeListener)</div>\r
- <div class="long">\r
- Removes a listener (shorthand for removeListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.grid.PropertyColumnModel-events"></a>
- <h2>Public Events</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-columnmoved"></a>\r
- <b>columnmoved</b> : ( <code>ColumnModel this</code>, <code>Number oldIndex</code>, <code>Number newIndex</code> ) <div class="mdesc">\r
- <div class="short">Fires when a column is moved.</div>\r
- <div class="long">\r
- Fires when a column is moved. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>oldIndex</code> : Number<div class="sub-desc"></div></li><li><code>newIndex</code> : Number<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#event-columnmoved" href="output/Ext.grid.ColumnModel.html#event-columnmoved">ColumnModel</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-configchange"></a>\r
- <b>configchange</b> : ( <code>ColumnModel this</code> ) <div class="mdesc">\r
- <div class="short">Fires when the configuration is changed</div>\r
- <div class="long">\r
- Fires when the configuration is changed <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#event-configchange" href="output/Ext.grid.ColumnModel.html#event-configchange">ColumnModel</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-headerchange"></a>\r
- <b>headerchange</b> : ( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>String newText</code> ) <div class="mdesc">\r
- <div class="short">Fires when the text of a header changes.</div>\r
- <div class="long">\r
- Fires when the text of a header changes. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>newText</code> : String<div class="sub-desc">The new header text</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#event-headerchange" href="output/Ext.grid.ColumnModel.html#event-headerchange">ColumnModel</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-hiddenchange"></a>\r
- <b>hiddenchange</b> : ( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Boolean hidden</code> ) <div class="mdesc">\r
- <div class="short">Fires when a column is hidden or "unhidden".</div>\r
- <div class="long">\r
- Fires when a column is hidden or "unhidden". <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>hidden</code> : Boolean<div class="sub-desc">true if hidden, false otherwise</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#event-hiddenchange" href="output/Ext.grid.ColumnModel.html#event-hiddenchange">ColumnModel</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.PropertyColumnModel-widthchange"></a>\r
- <b>widthchange</b> : ( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Number newWidth</code> ) <div class="mdesc">\r
- <div class="short">Fires when the width of a column changes.</div>\r
- <div class="long">\r
- Fires when the width of a column changes. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>newWidth</code> : Number<div class="sub-desc">The new width</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.ColumnModel" ext:member="#event-widthchange" href="output/Ext.grid.ColumnModel.html#event-widthchange">ColumnModel</a></td>\r
- </tr>\r
- </table>
-
- </div>
\ No newline at end of file
+<li><b>store</b> : Ext.data.Store<p class="sub-desc">The <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a> object from which the Record was extracted.</p></li></ul></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#setRenderer" ext:member="#setRenderer" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>( <code>Boolean queueSuspended</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
+after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.grid.PropertyColumnModel-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-columnmoved"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-columnmoved">columnmoved</a></b> :\r
+ ( <code>ColumnModel this</code>, <code>Number oldIndex</code>, <code>Number newIndex</code> )\r
+ <div class="mdesc"><div class="short">Fires when a column is moved.</div><div class="long">Fires when a column is moved.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>oldIndex</code> : Number<div class="sub-desc"></div></li><li><code>newIndex</code> : Number<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#columnmoved" ext:member="#columnmoved" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-configchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-configchange">configchange</a></b> :\r
+ ( <code>ColumnModel this</code> )\r
+ <div class="mdesc"><div class="short">Fires when the configuration is changed</div><div class="long">Fires when the configuration is changed<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#configchange" ext:member="#configchange" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-headerchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-headerchange">headerchange</a></b> :\r
+ ( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>String newText</code> )\r
+ <div class="mdesc"><div class="short">Fires when the text of a header changes.</div><div class="long">Fires when the text of a header changes.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>newText</code> : String<div class="sub-desc">The new header text</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#headerchange" ext:member="#headerchange" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-hiddenchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-hiddenchange">hiddenchange</a></b> :\r
+ ( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Boolean hidden</code> )\r
+ <div class="mdesc"><div class="short">Fires when a column is hidden or "unhidden".</div><div class="long">Fires when a column is hidden or "unhidden".<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>hidden</code> : Boolean<div class="sub-desc">true if hidden, false otherwise</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#hiddenchange" ext:member="#hiddenchange" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.ColumnModel-widthchange"></a><b><a href="source/ColumnModel.html#event-Ext.grid.ColumnModel-widthchange">widthchange</a></b> :\r
+ ( <code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Number newWidth</code> )\r
+ <div class="mdesc"><div class="short">Fires when the width of a column is programmaticially changed using\r
+setColumnWidth.\r
+Note internal resizing suppresses...</div><div class="long">Fires when the width of a column is programmaticially changed using
+<code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-setColumnWidth" ext:member="setColumnWidth" ext:cls="Ext.grid.ColumnModel">setColumnWidth</a></code>.
+Note internal resizing suppresses the event from firing. See also
+<a href="output/Ext.grid.GridPanel.html" ext:cls="Ext.grid.GridPanel">Ext.grid.GridPanel</a>.<code><a href="output/Ext.grid.ColumnModel.html#Ext.grid.ColumnModel-columnresize" ext:member="columnresize" ext:cls="Ext.grid.ColumnModel">columnresize</a></code>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc">The column index</div></li><li><code>newWidth</code> : Number<div class="sub-desc">The new width</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.ColumnModel.html#widthchange" ext:member="#widthchange" ext:cls="Ext.grid.ColumnModel">ColumnModel</a></td></tr></tbody></table></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff