1013 lines
No EOL
56 KiB
HTML
1013 lines
No EOL
56 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Ext.grid.ColumnModel</title>
|
|
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
|
<!-- GC -->
|
|
</head>
|
|
<body>
|
|
<div class="body-wrap">
|
|
<div class="top-tools">
|
|
<img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="Ext.grid.ColumnModel.html" target="_blank">Print Friendly</a><br/>
|
|
|
|
</div>
|
|
<h1>Class Ext.grid.ColumnModel</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>Ext.grid</td></tr>
|
|
<tr><td class="label">Class:</td><td>ColumnModel</td></tr>
|
|
<tr><td class="label">Extends:</td><td><a href="Ext.util.Observable.html">Observable</a></td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="ColumnModel.jss.html">ColumnModel.js</a></td></tr>
|
|
</table>
|
|
<div class="description">
|
|
This is the default implementation of a ColumnModel used by the Grid. It defines
|
|
the columns in the grid.
|
|
<br>Usage:<br>
|
|
<pre class="highlighted"><code>var colModel = <b>new</b> Ext.grid.ColumnModel([
|
|
{header: "Ticker", width: 60, sortable: true, locked: true},
|
|
{header: "Company Name", width: 150, sortable: true},
|
|
{header: "Market Cap.", width: 100, sortable: true},
|
|
{header: "$ Sales", width: 100, sortable: true, renderer: money},
|
|
{header: "Employees", width: 100, sortable: true, resizable: false}
|
|
]);</code></pre>
|
|
<p>
|
|
The config options listed for this class, are options which may appear in each
|
|
individual column definition. </div>
|
|
<br />
|
|
<a href="#properties">Properties</a>
|
|
- <a href="#methods">Methods</a>
|
|
- <a href="#events">Events</a>
|
|
<hr />
|
|
<a name="properties"></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>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config">config</a> : Object</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The config passed into the constructor</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#defaultSortable">defaultSortable</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Default sortable of columns which have no sortable specified (defaults to false)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#defaultWidth">defaultWidth</a> : Number</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The width of columns which have no width specified (defaults to 100)</td>
|
|
</tr>
|
|
</table>
|
|
<a name="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>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#ColumnModel">ColumnModel</a>(<code>Object config</code>)</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc"></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addEvents">addEvents</a>(<code>Object object</code>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#addEvents">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Copies any events from the passed object onto this object if they do not already exist. The passed object
|
|
must also ...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addListener">addListener</a>(<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</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#addListener">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends an event handler to this component</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#fireEvent">fireEvent</a>(<code>String eventName</code>, <code>Object... args</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires the specified event with the passed parameters (minus the event name).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getCellEditor">getCellEditor</a>(<code>Number colIndex</code>, <code>Number rowIndex</code>) : Object</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the editor defined for the cell/column.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getColumnCount">getColumnCount</a>() : Number</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the number of columns.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getColumnHeader">getColumnHeader</a>(<code>Number col</code>) : String</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the header for the specified column.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getColumnId">getColumnId</a>(<code>Number index</code>) : String</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">*
|
|
Returns the id of the column at the specified index</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getColumnTooltip">getColumnTooltip</a>(<code>Number col</code>) : String</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the tooltip for the specified column.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getColumnWidth">getColumnWidth</a>(<code>Number col</code>) : Number</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the width for the specified column.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getDataIndex">getDataIndex</a>(<code>Number col</code>) : Number</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the dataIndex for the specified column.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getRenderer">getRenderer</a>(<code>Number col</code>) : Function</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the rendering (formatting) function defined for the column.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getTotalWidth">getTotalWidth</a>(<code>Boolean includeHidden</code>) : Number</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the total width of all columns.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hasListener">hasListener</a>(<code>String eventName</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#hasListener">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Checks to see if this object is currently listening for a specified event</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isCellEditable">isCellEditable</a>(<code>Number colIndex</code>, <code>Number rowIndex</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if the cell is editable.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isFixed">isFixed</a>() : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if the column width cannot be changed</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isHidden">isHidden</a>(<code>Number colIndex</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if the column is hidden.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isResizable">isResizable</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if the column cannot be resized</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isSortable">isSortable</a>(<code>Number col</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if the specified column is sortable.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#on">on</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#on">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Appends an event handler to this element (shorthand for addListener)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#purgeListeners">purgeListeners</a>() : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes all listeners for this object</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeListener">removeListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#removeListener">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes a listener</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setColumnHeader">setColumnHeader</a>(<code>Number col</code>, <code>String header</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the header for a column.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setColumnTooltip">setColumnTooltip</a>(<code>Number col</code>, <code>String tooltip</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the tooltip for a column.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setColumnWidth">setColumnWidth</a>(<code>Number col</code>, <code>Number width</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the width for a column.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setDataIndex">setDataIndex</a>(<code>Number col</code>, <code>Number dataIndex</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the dataIndex for a column.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setEditable">setEditable</a>(<code>Number col</code>, <code>Boolean editable</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets if a column is editable.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setEditor">setEditor</a>(<code>Number col</code>, <code>Object editor</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the editor for a column.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setHidden">setHidden</a>(<code>Number colIndex</code>, <code>Boolean hidden</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets if a column is hidden.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setRenderer">setRenderer</a>(<code>Number col</code>, <code>Function fn</code>) : void</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the rendering (formatting) function for a column.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#un">un</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#un">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes a listener (shorthand for removeListener)</td>
|
|
</tr>
|
|
</table>
|
|
<a name="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>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-columlockchange">columlockchange</a> : (<code>ColumnModel this</code>, <code>Number colIndex</code>, <code>Boolean locked</code>)</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when a column's locked state is changed</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-columnmoved">columnmoved</a> : (<code>ColumnModel this</code>, <code>Number oldIndex</code>, <code>Number newIndex</code>)</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires when a column is moved</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-headerchange">headerchange</a> : (<code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Number newText</code>)</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when the text of a header changes</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-hiddenchange">hiddenchange</a> : (<code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Number hidden</code>)</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires when a column is hidden or "unhidden"</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-widthchange">widthchange</a> : (<code>ColumnModel this</code>, <code>Number columnIndex</code>, <code>Number newWidth</code>)</td>
|
|
<td class="msource" rowspan="2">ColumnModel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when the width of a column changes</td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="mdetail-head">Property Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="config"></a>
|
|
<div class="mdetail">
|
|
<h3>config</i></h3>
|
|
<code>public Object config</code>
|
|
<div class="mdetail-desc">
|
|
The config passed into the constructor </div>
|
|
<div class="mdetail-def">This property is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="defaultSortable"></a>
|
|
<div class="mdetail alt">
|
|
<h3>defaultSortable</i></h3>
|
|
<code>public Boolean defaultSortable</code>
|
|
<div class="mdetail-desc">
|
|
Default sortable of columns which have no sortable specified (defaults to false) </div>
|
|
<div class="mdetail-def">This property is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="defaultWidth"></a>
|
|
<div class="mdetail">
|
|
<h3>defaultWidth</i></h3>
|
|
<code>public Number defaultWidth</code>
|
|
<div class="mdetail-desc">
|
|
The width of columns which have no width specified (defaults to 100) </div>
|
|
<div class="mdetail-def">This property is defined by ColumnModel.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="ColumnModel"></a>
|
|
<h2 class="mdetail-head">Constructor Details</h2>
|
|
<div class="detail-wrap">
|
|
<div class="mdetail">
|
|
<h3>ColumnModel</i></h3>
|
|
<code>public function ColumnModel(<code>Object config</code>)</code>
|
|
<div class="mdetail-desc">
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>config</code> : Object<div class="sub-desc">An Array of column config objects. See this class's config objects for details.</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="addEvents"></a>
|
|
<div class="mdetail">
|
|
<h3>addEvents</i></h3>
|
|
<code>public function addEvents(<code>Object object</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Copies any events from the passed object onto this object if they do not already exist. The passed object
|
|
must also inherit from Observable for this method to have any effect.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>object</code> : Object<div class="sub-desc">The object from which to copy events</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#addEvents">Observable</a>.</div>
|
|
</div>
|
|
<a name="addListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addListener</i></h3>
|
|
<code>public function addListener(<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>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this component
|
|
<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 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 properties. This may contain any of the following properties:<ul> <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li> <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li> <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li> <li>preventDefault {Boolean} True to prevent the default action</li> <li>stopPropagation {Boolean} True to prevent event propagation</li> <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Ext.EventObject</li> <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li> <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li> <li>buffer {Number} Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html">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.</li> </ul> <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)<div style="margin: 5px 20px 20px;"> Code: <pre><code>el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });</pre> <p> The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. <p> <b>Attaching multiple handlers in 1 call</b><br> Code: <pre><code>el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });</pre> <p> Or a shorthand syntax:<br> Code: <pre><code>el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });</pre></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#addListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="fireEvent"></a>
|
|
<div class="mdetail">
|
|
<h3>fireEvent</i></h3>
|
|
<code>public function fireEvent(<code>String eventName</code>, <code>Object... args</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Fires the specified event with the passed parameters (minus the event name).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<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 class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#fireEvent">Observable</a>.</div>
|
|
</div>
|
|
<a name="getCellEditor"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getCellEditor</i></h3>
|
|
<code>public function getCellEditor(<code>Number colIndex</code>, <code>Number rowIndex</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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>Object</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getColumnCount"></a>
|
|
<div class="mdetail">
|
|
<h3>getColumnCount</i></h3>
|
|
<code>public function getColumnCount()</code>
|
|
<div class="mdetail-desc">
|
|
Returns the number of columns.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getColumnHeader"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getColumnHeader</i></h3>
|
|
<code>public function getColumnHeader(<code>Number col</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getColumnId"></a>
|
|
<div class="mdetail">
|
|
<h3>getColumnId</i></h3>
|
|
<code>public function getColumnId(<code>Number index</code>)</code>
|
|
<div class="mdetail-desc">
|
|
*
|
|
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"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>String</code><div class="sub-desc">the id</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getColumnTooltip"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getColumnTooltip</i></h3>
|
|
<code>public function getColumnTooltip(<code>Number col</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getColumnWidth"></a>
|
|
<div class="mdetail">
|
|
<h3>getColumnWidth</i></h3>
|
|
<code>public function getColumnWidth(<code>Number col</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getDataIndex"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getDataIndex</i></h3>
|
|
<code>public function getDataIndex(<code>Number col</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the dataIndex 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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getRenderer"></a>
|
|
<div class="mdetail">
|
|
<h3>getRenderer</i></h3>
|
|
<code>public function getRenderer(<code>Number col</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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 class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="getTotalWidth"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getTotalWidth</i></h3>
|
|
<code>public function getTotalWidth(<code>Boolean includeHidden</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="hasListener"></a>
|
|
<div class="mdetail">
|
|
<h3>hasListener</i></h3>
|
|
<code>public function hasListener(<code>String eventName</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Checks to see if this object is currently listening 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 class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#hasListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="isCellEditable"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isCellEditable</i></h3>
|
|
<code>public function isCellEditable(<code>Number colIndex</code>, <code>Number rowIndex</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if the cell is editable.
|
|
<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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="isFixed"></a>
|
|
<div class="mdetail">
|
|
<h3>isFixed</i></h3>
|
|
<code>public function isFixed()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if the column width cannot be changed
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="isHidden"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isHidden</i></h3>
|
|
<code>public function isHidden(<code>Number colIndex</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if the column is hidden.
|
|
<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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="isResizable"></a>
|
|
<div class="mdetail">
|
|
<h3>isResizable</i></h3>
|
|
<code>public function isResizable()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if the column cannot be resized
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="isSortable"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isSortable</i></h3>
|
|
<code>public function isSortable(<code>Number col</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="on"></a>
|
|
<div class="mdetail">
|
|
<h3>on</i></h3>
|
|
<code>public function on(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element (shorthand for addListener)
|
|
<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>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#on">Observable</a>.</div>
|
|
</div>
|
|
<a name="purgeListeners"></a>
|
|
<div class="mdetail alt">
|
|
<h3>purgeListeners</i></h3>
|
|
<code>public function purgeListeners()</code>
|
|
<div class="mdetail-desc">
|
|
Removes all listeners for this object
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#purgeListeners">Observable</a>.</div>
|
|
</div>
|
|
<a name="removeListener"></a>
|
|
<div class="mdetail">
|
|
<h3>removeListener</i></h3>
|
|
<code>public function removeListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a listener
|
|
<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 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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#removeListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="setColumnHeader"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setColumnHeader</i></h3>
|
|
<code>public function setColumnHeader(<code>Number col</code>, <code>String header</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="setColumnTooltip"></a>
|
|
<div class="mdetail">
|
|
<h3>setColumnTooltip</i></h3>
|
|
<code>public function setColumnTooltip(<code>Number col</code>, <code>String tooltip</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="setColumnWidth"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setColumnWidth</i></h3>
|
|
<code>public function setColumnWidth(<code>Number col</code>, <code>Number width</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="setDataIndex"></a>
|
|
<div class="mdetail">
|
|
<h3>setDataIndex</i></h3>
|
|
<code>public function setDataIndex(<code>Number col</code>, <code>Number dataIndex</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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> : Number<div class="sub-desc">The new dataIndex</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="setEditable"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setEditable</i></h3>
|
|
<code>public function setEditable(<code>Number col</code>, <code>Boolean editable</code>)</code>
|
|
<div class="mdetail-desc">
|
|
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><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="setEditor"></a>
|
|
<div class="mdetail">
|
|
<h3>setEditor</i></h3>
|
|
<code>public function setEditor(<code>Number col</code>, <code>Object editor</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the editor 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>editor</code> : Object<div class="sub-desc">The editor object</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="setHidden"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setHidden</i></h3>
|
|
<code>public function setHidden(<code>Number colIndex</code>, <code>Boolean hidden</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets if a column is hidden.
|
|
<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><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="setRenderer"></a>
|
|
<div class="mdetail">
|
|
<h3>setRenderer</i></h3>
|
|
<code>public function setRenderer(<code>Number col</code>, <code>Function fn</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the rendering (formatting) function 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>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>Data value.</li> <li>Cell metadata. An object in which you may set the following attributes:<ul> <li>css A CSS style string to apply to the table cell.</li> <li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul> <li>The <a href="Ext.data.Record.html">Ext.data.Record</a> from which the data was extracted.</li> <li>Row index</li> <li>Column index</li> <li>The <a href="Ext.data.Store.html">Ext.data.Store</a> object from which the Record was extracted</li></ul></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="un"></a>
|
|
<div class="mdetail alt">
|
|
<h3>un</i></h3>
|
|
<code>public function un(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a listener (shorthand for removeListener)
|
|
<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 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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#un">Observable</a>.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Event Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="event-columlockchange"></a>
|
|
<div class="mdetail">
|
|
<h3>columlockchange</i></h3>
|
|
<code>public event columlockchange</code>
|
|
<div class="mdetail-desc">
|
|
Fires when a column's locked state is changed
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : ColumnModel<div class="sub-desc"></div></li><li><code>colIndex</code> : Number<div class="sub-desc"></div></li><li><code>locked</code> : Boolean<div class="sub-desc">true if locked</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="event-columnmoved"></a>
|
|
<div class="mdetail alt">
|
|
<h3>columnmoved</i></h3>
|
|
<code>public event columnmoved</code>
|
|
<div class="mdetail-desc">
|
|
Fires when a column is moved
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</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 class="mdetail-def">This event is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="event-headerchange"></a>
|
|
<div class="mdetail">
|
|
<h3>headerchange</i></h3>
|
|
<code>public event headerchange</code>
|
|
<div class="mdetail-desc">
|
|
Fires when the text of a header changes
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</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> : Number<div class="sub-desc">The new header text</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="event-hiddenchange"></a>
|
|
<div class="mdetail alt">
|
|
<h3>hiddenchange</i></h3>
|
|
<code>public event hiddenchange</code>
|
|
<div class="mdetail-desc">
|
|
Fires when a column is hidden or "unhidden"
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</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> : Number<div class="sub-desc">true if hidden, false otherwise</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by ColumnModel.</div>
|
|
</div>
|
|
<a name="event-widthchange"></a>
|
|
<div class="mdetail">
|
|
<h3>widthchange</i></h3>
|
|
<code>public event widthchange</code>
|
|
<div class="mdetail-desc">
|
|
Fires when the width of a column changes
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</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 class="mdetail-def">This event is defined by ColumnModel.</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr>
|
|
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright © 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
|
|
|
|
</body>
|
|
</html> |