upgraded to yui 0.12.0
upgraded to yui-ext 0.33 rc2
This commit is contained in:
JT Smith
parent
62b3d90db7
commit
cfd09a5cb6
1271 changed files with 539033 additions and 0 deletions
|
|
@ -0,0 +1,330 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>YAHOO.ext.grid.AbstractDataModel</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">
|
||||
</head>
|
||||
<body>
|
||||
<div class="body-wrap">
|
||||
<div class="top-tools"><img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="YAHOO.ext.grid.AbstractDataModel.html" target="_blank">Print Friendly</a></div>
|
||||
<h1>Class YAHOO.ext.grid.AbstractDataModel</h1>
|
||||
<table cellspacing="0">
|
||||
<tr><td class="label">Package:</td><td>YAHOO.ext.grid</td></tr>
|
||||
<tr><td class="label">Class:</td><td>AbstractDataModel</td></tr>
|
||||
<tr><td class="label">Extends:</td><td><a href="YAHOO.ext.util.Observable.html">Observable</a></td></tr>
|
||||
<tr><td class="label">Subclasses:</td><td><a href="YAHOO.ext.grid.DefaultDataModel.html">DefaultDataModel</a></td></tr>
|
||||
<tr><td class="label">Defined In:</td><td><a href="AbstractDataModel.js.html">AbstractDataModel.js</a></td></tr>
|
||||
</table>
|
||||
<div class="description">
|
||||
This abstract class provides default implementations of the events required by the Grid.
|
||||
It takes care of the creating the CustomEvents and provides some convenient methods for firing the events. <br><br> </div>
|
||||
<hr />
|
||||
<a name="properties"></a>
|
||||
<h2>Public Properties</h2>
|
||||
<div class="no-members">This class has no public properties.</div> <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="#AbstractDataModel">AbstractDataModel</a>()</td>
|
||||
<td class="msource" rowspan="2">AbstractDataModel</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="#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>boolean override</code>]</span>) : void</td>
|
||||
<td class="msource" rowspan="2"><a href="YAHOO.ext.util.Observable.html#addListener">Observable</a></td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="mdesc">Appends an event handler to this element</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#delayedListener">delayedListener</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>Number delay</code>]</span>) : Function</td>
|
||||
<td class="msource" rowspan="2"><a href="YAHOO.ext.util.Observable.html#delayedListener">Observable</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc">Appends an event handler to this element that is delayed the specified number of milliseconds.</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="YAHOO.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 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="YAHOO.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="YAHOO.ext.util.Observable.html#removeListener">Observable</a></td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="mdesc">Removes a listener</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-cellupdated">cellupdated</a> : (<code>DataModel this</code>, <code>Number rowIndex</code>, <code>Number columnIndex</code>)</td>
|
||||
<td class="msource" rowspan="2">AbstractDataModel</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc">Fires when a cell is updated</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#event-datachanged">datachanged</a> : (<code>DataModel this</code>)</td>
|
||||
<td class="msource" rowspan="2">AbstractDataModel</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="mdesc">Fires when the entire data structure has changed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#event-rowsdeleted">rowsdeleted</a> : (<code>DataModel this</code>, <code>Number firstRowIndex</code>, <code>Number lastRowIndex</code>)</td>
|
||||
<td class="msource" rowspan="2">AbstractDataModel</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc">Fires when a range of rows have been deleted</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#event-rowsinserted">rowsinserted</a> : (<code>DataModel this</code>, <code>Number firstRowIndex</code>, <code>Number lastRowIndex</code>)</td>
|
||||
<td class="msource" rowspan="2">AbstractDataModel</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="mdesc">Fires when a range of rows have been inserted</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#event-rowssorted">rowssorted</a> : (<code>DataModel this</code>)</td>
|
||||
<td class="msource" rowspan="2">AbstractDataModel</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="mdesc">Fires when the data has been sorted</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="micon" rowspan="2"> </td>
|
||||
<td class="sig"><a class="mlink" href="#event-rowsupdated">rowsupdated</a> : (<code>DataModel this</code>, <code>Number firstRowIndex</code>, <code>Number lastRowIndex</code>)</td>
|
||||
<td class="msource" rowspan="2">AbstractDataModel</td>
|
||||
</tr>
|
||||
<tr class="alt">
|
||||
<td class="mdesc">Fires when a range of rows have been updated</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<a name="AbstractDataModel"></a>
|
||||
<h2 class="mdetail-head">Constructor Details</h2>
|
||||
<div class="detail-wrap">
|
||||
<div class="mdetail">
|
||||
<h3>AbstractDataModel</i></h3>
|
||||
<code>public function AbstractDataModel()</code>
|
||||
<div class="mdetail-desc">
|
||||
<div class="mdetail-params">
|
||||
<strong>Parameters:</strong>
|
||||
<ul><li>None.</li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="mdetail-head">Method Details</h2>
|
||||
<div class="detail-wrap">
|
||||
<a name="addListener"></a>
|
||||
<div class="mdetail">
|
||||
<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>boolean override</code>]</span>)</code>
|
||||
<div class="mdetail-desc">
|
||||
Appends an event handler to this element
|
||||
<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 (this object) for the handler</div></li><li><code>override</code> : boolean<div class="sub-desc">(optional) If true, scope becomes the scope</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="YAHOO.ext.util.Observable.html#addListener">Observable</a>.</div>
|
||||
</div>
|
||||
<a name="delayedListener"></a>
|
||||
<div class="mdetail alt">
|
||||
<h3>delayedListener</i></h3>
|
||||
<code>public function delayedListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Number delay</code>]</span>)</code>
|
||||
<div class="mdetail-desc">
|
||||
Appends an event handler to this element that is delayed the specified number of milliseconds.
|
||||
<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 (this object) for the handler</div></li><li><code>delay</code> : Number<div class="sub-desc">(optional) The number of milliseconds to delay</div></li> </ul>
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li><code>Function</code><div class="sub-desc">The wrapped function that was created (can be used to remove the listener)</div></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.util.Observable.html#delayedListener">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="YAHOO.ext.util.Observable.html#fireEvent">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="YAHOO.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="YAHOO.ext.util.Observable.html#removeListener">Observable</a>.</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="mdetail-head">Event Details</h2>
|
||||
<div class="detail-wrap">
|
||||
<a name="event-cellupdated"></a>
|
||||
<div class="mdetail">
|
||||
<h3>cellupdated</i></h3>
|
||||
<code>public event cellupdated</code>
|
||||
<div class="mdetail-desc">
|
||||
Fires when a cell is updated
|
||||
<div class="mdetail-params">
|
||||
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
||||
<ul><li><code>this</code> : DataModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>columnIndex</code> : Number<div class="sub-desc"></div></li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This event is defined by AbstractDataModel.</div>
|
||||
</div>
|
||||
<a name="event-datachanged"></a>
|
||||
<div class="mdetail alt">
|
||||
<h3>datachanged</i></h3>
|
||||
<code>public event datachanged</code>
|
||||
<div class="mdetail-desc">
|
||||
Fires when the entire data structure has changed
|
||||
<div class="mdetail-params">
|
||||
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
||||
<ul><li><code>this</code> : DataModel<div class="sub-desc"></div></li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This event is defined by AbstractDataModel.</div>
|
||||
</div>
|
||||
<a name="event-rowsdeleted"></a>
|
||||
<div class="mdetail">
|
||||
<h3>rowsdeleted</i></h3>
|
||||
<code>public event rowsdeleted</code>
|
||||
<div class="mdetail-desc">
|
||||
Fires when a range of rows have been deleted
|
||||
<div class="mdetail-params">
|
||||
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
||||
<ul><li><code>this</code> : DataModel<div class="sub-desc"></div></li><li><code>firstRowIndex</code> : Number<div class="sub-desc"></div></li><li><code>lastRowIndex</code> : Number<div class="sub-desc"></div></li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This event is defined by AbstractDataModel.</div>
|
||||
</div>
|
||||
<a name="event-rowsinserted"></a>
|
||||
<div class="mdetail alt">
|
||||
<h3>rowsinserted</i></h3>
|
||||
<code>public event rowsinserted</code>
|
||||
<div class="mdetail-desc">
|
||||
Fires when a range of rows have been inserted
|
||||
<div class="mdetail-params">
|
||||
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
||||
<ul><li><code>this</code> : DataModel<div class="sub-desc"></div></li><li><code>firstRowIndex</code> : Number<div class="sub-desc"></div></li><li><code>lastRowIndex</code> : Number<div class="sub-desc"></div></li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This event is defined by AbstractDataModel.</div>
|
||||
</div>
|
||||
<a name="event-rowssorted"></a>
|
||||
<div class="mdetail">
|
||||
<h3>rowssorted</i></h3>
|
||||
<code>public event rowssorted</code>
|
||||
<div class="mdetail-desc">
|
||||
Fires when the data has been sorted
|
||||
<div class="mdetail-params">
|
||||
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
||||
<ul><li><code>this</code> : DataModel<div class="sub-desc"></div></li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This event is defined by AbstractDataModel.</div>
|
||||
</div>
|
||||
<a name="event-rowsupdated"></a>
|
||||
<div class="mdetail alt">
|
||||
<h3>rowsupdated</i></h3>
|
||||
<code>public event rowsupdated</code>
|
||||
<div class="mdetail-desc">
|
||||
Fires when a range of rows have been updated
|
||||
<div class="mdetail-params">
|
||||
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
||||
<ul><li><code>this</code> : DataModel<div class="sub-desc"></div></li><li><code>firstRowIndex</code> : Number<div class="sub-desc"></div></li><li><code>lastRowIndex</code> : Number<div class="sub-desc"></div></li> </ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="mdetail-def">This event is defined by AbstractDataModel.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
Copyright © 2006 Jack Slocum. All rights reserved.
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue