webgui/www/extras/yui-ext/docs/overview-summary-AbstractDataModel.js.html
JT Smith 4f68a0933c added YUI and YUI-ext
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

225 lines
10 KiB
HTML

<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<html>
<head>
<title>
Overview
</title>
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script>
function asd() {
parent.document.title="AbstractDataModel.js Overview";
}
</script>
</head>
<body bgcolor="white" onload="asd();" style="margin:15px;">
<center>
<h2>AbstractDataModel.js</h2>
</center>
<h4>Summary</h4>
<p>
</p>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan="2" class="title-cell">
<b>Class Summary</b>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td width="15%"><b><a href="YAHOO.ext.grid.AbstractDataModel.html">YAHOO.ext.grid.AbstractDataModel</a></b></td>
<td>This abstract class provides default implementations of the events required by the Grid.</td>
</tr>
</table>
<hr/>
<!-- ========== METHOD SUMMARY =========== -->
<!-- ========== END METHOD SUMMARY =========== -->
<pre class="sourceview"><span class="comment">/**
* <span class="attrib">@class</span>
* 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. &lt;br&gt;&lt;br&gt;
* <span class="attrib">@constructor</span>
*/</span>
YAHOO.ext.grid.AbstractDataModel = <span class="reserved">function</span>(){
<span class="comment">/** Fires when a cell is updated - fireDirect sig: (this, rowIndex, columnIndex)
* <span class="attrib">@type</span> YAHOO.util.CustomEvent
* <span class="attrib">@deprecated</span> Use addListener instead of accessing directly
*/</span>
<span class="reserved">this</span>.onCellUpdated = new YAHOO.util.CustomEvent(<span class="literal">'onCellUpdated'</span>);
<span class="comment">/** Fires when all data needs to be revalidated - fireDirect sig: (thisd)
* <span class="attrib">@type</span> YAHOO.util.CustomEvent
* <span class="attrib">@deprecated</span> Use addListener instead of accessing directly
*/</span>
<span class="reserved">this</span>.onTableDataChanged = new YAHOO.util.CustomEvent(<span class="literal">'onTableDataChanged'</span>);
<span class="comment">/** Fires when rows are deleted - fireDirect sig: (this, firstRowIndex, lastRowIndex)
* <span class="attrib">@type</span> YAHOO.util.CustomEvent
* <span class="attrib">@deprecated</span> Use addListener instead of accessing directly
*/</span>
<span class="reserved">this</span>.onRowsDeleted = new YAHOO.util.CustomEvent(<span class="literal">'onRowsDeleted'</span>);
<span class="comment">/** Fires when a rows are inserted - fireDirect sig: (this, firstRowIndex, lastRowIndex)
* <span class="attrib">@type</span> YAHOO.util.CustomEvent
* <span class="attrib">@deprecated</span> Use addListener instead of accessing directly
*/</span>
<span class="reserved">this</span>.onRowsInserted = new YAHOO.util.CustomEvent(<span class="literal">'onRowsInserted'</span>);
<span class="comment">/** Fires when a rows are updated - fireDirect sig: (this, firstRowIndex, lastRowIndex)
* <span class="attrib">@type</span> YAHOO.util.CustomEvent
* <span class="attrib">@deprecated</span> Use addListener instead of accessing directly
*/</span>
<span class="reserved">this</span>.onRowsUpdated = new YAHOO.util.CustomEvent(<span class="literal">'onRowsUpdated'</span>);
<span class="comment">/** Fires when a sort has reordered the rows - fireDirect sig: (this, sortColumnIndex,
* sortDirection = 'ASC' or 'DESC')
* <span class="attrib">@type</span> YAHOO.util.CustomEvent
* <span class="attrib">@deprecated</span> Use addListener instead of accessing directly
*/</span>
<span class="reserved">this</span>.onRowsSorted = new YAHOO.util.CustomEvent(<span class="literal">'onRowsSorted'</span>);
<span class="reserved">this</span>.events = {
<span class="literal">'cellupdated'</span> : <span class="reserved">this</span>.onCellUpdated,
<span class="literal">'datachanged'</span> : <span class="reserved">this</span>.onTableDataChanged,
<span class="literal">'rowsdeleted'</span> : <span class="reserved">this</span>.onRowsDeleted,
<span class="literal">'rowsinserted'</span> : <span class="reserved">this</span>.onRowsInserted,
<span class="literal">'rowsupdated'</span> : <span class="reserved">this</span>.onRowsUpdated,
<span class="literal">'rowssorted'</span> : <span class="reserved">this</span>.onRowsSorted
};
};
YAHOO.ext.grid.AbstractDataModel.<span class="reserved">prototype</span> = {
addListener : YAHOO.ext.grid.Grid.<span class="reserved">prototype</span>.addListener,
removeListener : YAHOO.ext.grid.Grid.<span class="reserved">prototype</span>.removeListener,
fireEvent : YAHOO.ext.grid.Grid.<span class="reserved">prototype</span>.fireEvent,
<span class="comment">/**
* Notifies listeners that the value of the cell at [row, col] has been updated
*/</span>
fireCellUpdated : <span class="reserved">function</span>(row, col){
<span class="reserved">this</span>.onCellUpdated.fireDirect(<span class="reserved">this</span>, row, col);
},
<span class="comment">/**
* Notifies listeners that all data for the grid may have changed - use as a last resort. This
* also wipes out all selections a user might have made.
*/</span>
fireTableDataChanged : <span class="reserved">function</span>(){
<span class="reserved">this</span>.onTableDataChanged.fireDirect(<span class="reserved">this</span>);
},
<span class="comment">/**
* Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been deleted
*/</span>
fireRowsDeleted : <span class="reserved">function</span>(firstRow, lastRow){
<span class="reserved">this</span>.onRowsDeleted.fireDirect(<span class="reserved">this</span>, firstRow, lastRow);
},
<span class="comment">/**
* Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been inserted
*/</span>
fireRowsInserted : <span class="reserved">function</span>(firstRow, lastRow){
<span class="reserved">this</span>.onRowsInserted.fireDirect(<span class="reserved">this</span>, firstRow, lastRow);
},
<span class="comment">/**
* Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been updated
*/</span>
fireRowsUpdated : <span class="reserved">function</span>(firstRow, lastRow){
<span class="reserved">this</span>.onRowsUpdated.fireDirect(<span class="reserved">this</span>, firstRow, lastRow);
},
<span class="comment">/**
* Notifies listeners that rows have been sorted and any indexes may be invalid
*/</span>
fireRowsSorted : <span class="reserved">function</span>(sortColumnIndex, sortDir, noRefresh){
<span class="reserved">this</span>.onRowsSorted.fireDirect(<span class="reserved">this</span>, sortColumnIndex, sortDir, noRefresh);
},
<span class="comment">/**
* Empty interface method - Classes which extend AbstractDataModel should implement this method.
* See {<span class="attrib">@link</span> YAHOO.ext.DefaultDataModel} for an example implementation.
*/</span>
sort : <span class="reserved">function</span>(columnModel, columnIndex, direction, suppressEvent){
},
<span class="comment">/**
* Interface method to supply the view with info regarding the Grid's current sort state - if overridden,
* this should return an object like this {column: this.sortColumn, direction: this.sortDir}.
* <span class="attrib">@return</span> {Object}
*/</span>
getSortState : <span class="reserved">function</span>(){
<span class="reserved">return</span> {column: <span class="reserved">this</span>.sortColumn, direction: <span class="reserved">this</span>.sortDir};
},
<span class="comment">/**
* Empty interface method - Classes which extend AbstractDataModel should implement this method.
* See {<span class="attrib">@link</span> YAHOO.ext.DefaultDataModel} for an example implementation.
*/</span>
getRowCount : <span class="reserved">function</span>(){
},
<span class="comment">/**
* Empty interface method - Classes which extend AbstractDataModel should implement this method to support virtual row counts.
*/</span>
getTotalRowCount : <span class="reserved">function</span>(){
<span class="reserved">return</span> <span class="reserved">this</span>.getRowCount();
},
<span class="comment">/**
* Empty interface method - Classes which extend AbstractDataModel should implement this method.
* See {<span class="attrib">@link</span> YAHOO.ext.DefaultDataModel} for an example implementation.
*/</span>
getRowId : <span class="reserved">function</span>(rowIndex){
},
<span class="comment">/**
* Empty interface method - Classes which extend AbstractDataModel should implement this method.
* See {<span class="attrib">@link</span> YAHOO.ext.DefaultDataModel} for an example implementation.
*/</span>
getValueAt : <span class="reserved">function</span>(rowIndex, colIndex){
},
<span class="comment">/**
* Empty interface method - Classes which extend AbstractDataModel should implement this method.
* See {<span class="attrib">@link</span> YAHOO.ext.DefaultDataModel} for an example implementation.
*/</span>
setValueAt : <span class="reserved">function</span>(value, rowIndex, colIndex){
},
isPaged : <span class="reserved">function</span>(){
<span class="reserved">return</span> false;
}
};</pre>
<hr>
<hr>
<font size="-1">
</font>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sat Oct 14 06:07:10 2006</div>
</body>
</html>